Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PLT-9080 - Cite compatible Runtime version(s) in ts-sdk #160

Merged
merged 2 commits into from
Jan 9, 2024
+18 −3
Merged

PLT-9080 - Cite compatible Runtime version(s) in ts-sdk #160

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c7a34d
Cite compatible Runtime version(s) in ts-sdk
nhenin Jan 9, 2024
64a6ac3
Change docs
hrajchert Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions Readme.md
View file
Open in desktop
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