marlowe-ts-sdk
marlowe-ts-sdk copied to clipboard
input-output-hk
Marlowe TypeScript SDK
Lightweight and typesafe SDK for writing Marlowe Contracts
[!IMPORTANT] This Marlowe repository will soon be moved to https://github.com/marlowe-lang. The new repositories will be administered by an independent vehicle, a not-for-profit organization currently being set up by the transition team.
This will allow us to ensure community representation and stewardship. Future developments and support for Marlowe are transitioning to a community-driven model initially led by Simon Thompson, Nicolas Henin and Tomasz Rybarczyk.
See here for details.
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.
Runtime
In order to interact with Marlowe contracts, the TS-SDK needs a Runtime instance. The following table shows the compatibility between the SDK and the Runtime versions:
| runtime v0.0.5 | runtime v0.0.6 | runtime v1.0.0 | |
|---|---|---|---|
| SDK 0.2.0-beta | ✓ | x | x |
| SDK 0.3.0-beta | ✓ | ✓ | x |
| SDK 0.4.0-beta | ✓ | ✓ | ✓ |
To get a running instance of the Runtime, it is recommended to check out the instructions on the Marlowe Starter Kit
Wallets
CIP-30 and Browser
The TS-SDK has a CIP-30 abstraction that works with the following wallets:
| Wallets | Compatible | Not Compatible | Not Tested |
|---|---|---|---|
| Nami | ✓ | ||
| Eternl | ✓ | ||
| Lace | ✓ | ||
| Yoroi | ? | ||
| Typhon | ? |
Lucid and NodeJS
The SDK also provides a wrapper around the Lucid Library. This allows you to use the SDK in a NodeJS environment.
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.
input-output-hk