marlowe-ts-sdk
v0.2.0-alpha-21
Published
Marlowe Runtime SDK for building and managing Marlowe Contracts
Downloads
1
Readme
The Marlowe TS-SDK is a suite of TypeScript/JavaScript libraries for developing Web-Dapp in the Cardano Blockchain using Marlowe Technologies.
It is composed of several npm packages documented in the API reference page.
Prerequisites
In order to start working with the Marlowe SDK you need to have a URL to a running instance of the Marlowe Runtime and one of the supported wallet extensions installed in your browser.
To get a running instance of the Runtime, it is recommended to check out the instructions on the Marlowe Starter Kit
Wallet Extensions
| Wallets | Compatible | Not Compatible | Not Tested | | ------- | :--------: | :------------: | :--------: | | Nami | ✓ | | | | Eternl | ✓ | | | | Lace | ✓ | | | | Yoroi | | | ? | | Typhon | | | ? |
Examples & Contract Use Cases
Inside the examples folder you can find a set of minimal examples on how to use different packages of the SDK.
Prototypes have been also built on top of this sdk:
- Payouts
- Token Plans
- Github Repository
- Vesting Contract
- Deployed DApp
Community & Support
- Website : marlowe.iohk.io
- Documentation : docs.marlowe.iohk.io
- Playground : play.marlowe.iohk.io
- Blog : marlowe.iohk.io/blog
- Support : iohk.zendesk.com
Contributing
To report a bug or request a new feature, please look through existing Github Issues before opening a new one.
To help in the development of this SDK, please refer to this document.