Skip to content

Commit

Permalink
Merge pull request #160 from input-output-hk/runtime-version
Browse files Browse the repository at this point in the history
PLT-9080 - Cite compatible Runtime version(s) in ts-sdk
  • Loading branch information
hrajchert authored Jan 9, 2024
2 parents 277eab0 + 64a6ac3 commit 65d2181
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,24 @@ The **Marlowe TS-SDK** is a suite of _TypeScript/JavaScript_ libraries for devel

It is composed of several npm packages documented in the [API reference](https://input-output-hk.github.io/marlowe-ts-sdk/) page.

## Prerequisites
## 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 | runtimev 0.0.6 |
| ------- | :--------: | :------------: |
| [SDK 0.2.0-beta](https://github.com/input-output-hk/marlowe-ts-sdk/releases/tag/0.2.0-beta) || x |

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](https://github.com/input-output-hk/marlowe-starter-kit)

## Wallet Extensions
## Wallets

### CIP-30 and Browser

The **TS-SDK** has a [CIP-30](https://github.com/cardano-foundation/CIPs/blob/master/CIP-0030/README.md) abstraction that works with
the following wallets:

| Wallets | Compatible | Not Compatible | Not Tested |
| ------- | :--------: | :------------: | :--------: |
Expand All @@ -36,6 +47,10 @@ To get a running instance of the Runtime, it is recommended to check out the ins
| Yoroi | | | ? |
| Typhon | | | ? |

### Lucid and NodeJS

The **SDK** also provides a wrapper around the [Lucid](https://github.com/spacebudz/lucid) Library. This allows you to use the SDK in a NodeJS environment.

## Examples & Contract Use Cases

Inside the [examples folder](./examples/Readme.md) you can find a set of minimal examples on how to use different packages of the SDK.
Expand Down

0 comments on commit 65d2181

Please sign in to comment.