From dd920e0c4b66a7748e5c53506efe37520211ef50 Mon Sep 17 00:00:00 2001 From: Joseph Fajen Date: Wed, 18 Oct 2023 12:11:51 -0700 Subject: [PATCH 1/3] first draft TS-SDK general introduction for docs site --- docs/developer-tools/ts-sdk-intro.md | 35 ++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/developer-tools/ts-sdk-intro.md diff --git a/docs/developer-tools/ts-sdk-intro.md b/docs/developer-tools/ts-sdk-intro.md new file mode 100644 index 0000000..57b0ada --- /dev/null +++ b/docs/developer-tools/ts-sdk-intro.md @@ -0,0 +1,35 @@ +--- +title: Marlowe TypeScript SDK +sidebar_position: 2 +--- + +## Introduction +The **[Marlowe TypeScript SDK (TS-SDK)](https://github.com/input-output-hk/marlowe-ts-sdk/)** consists of JavaScript and TypeScript libraries. It's engineered to support DApp developers with the tools they need to build and integrate with the Marlowe smart contract ecosystem on the Cardano blockchain. + +## Features at a glance + +1. **Smart contract toolkit**: Craft, deploy, and manage Marlowe smart contracts on the Cardano blockchain with the tools and libraries in the TS-SDK. +2. **Integration with Marlowe Playground**: The TS-SDK works well with the Marlowe Playground, an online interface dedicated to designing, simulating, and scrutinizing Marlowe contracts. +3. **Wallet connectivity**: With built-in modules, the SDK promotes smooth interactions with various wallet extensions. This ensures easy access to wallet data and the efficient integration of Marlowe contracts with a variety of wallet interfaces. +4. **Proof-of-Concept (PoC) templates**: Embark on your DApp journey using the TS-SDK's distilled example templates. These PoC templates serve as invaluable launching pads for your customized applications. + +## Getting started +To use the capabilities of the Marlowe TS-SDK, have an active link to a Marlowe Runtime instance and a browser-installed wallet extension that's compatible. + +## PoC templates + +- **[Marlowe Payouts](https://github.com/input-output-hk/marlowe-payouts)** +Engineered with the Marlowe TS-SDK, this DApp offers a streamlined approach to discerning and extracting payouts from Marlowe contracts on the Cardano blockchain. With a commitment to user experience, it ensures intuitive interactions and unhindered connectivity to the Cardano network. +- **[Vesting Prototype](https://github.com/input-output-hk/marlowe-ts-sdk/blob/main/pocs/contract-example/vesting-flow.html)** +Dive into the [Vesting](https://github.com/input-output-hk/marlowe-vesting) DApp, tailored for: + - Tokenomics orchestration. + - Timed fund safeguards. + - Pre-planned fund distributions to diverse stakeholders. +This DApp manages the phased allocation of shares over a designated time frame. Users can easily retrieve shares upon vesting. + +### User narratives +- As a company, I want to design a fresh vesting schedule for a team member. +- As a user, I aim to check my vested share tally by syncing my wallet. +- As a user, I seek to claim any vested shares. +- As a company, I require the latitude to revoke share options and dissolve vesting schedules before they mature. + From 549e005391d6e3f146a0b9865e60a89bf7781695 Mon Sep 17 00:00:00 2001 From: Joseph Fajen Date: Wed, 18 Oct 2023 12:23:10 -0700 Subject: [PATCH 2/3] tiny edit to make link more visible --- docs/developer-tools/ts-sdk-intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer-tools/ts-sdk-intro.md b/docs/developer-tools/ts-sdk-intro.md index 57b0ada..8b38e61 100644 --- a/docs/developer-tools/ts-sdk-intro.md +++ b/docs/developer-tools/ts-sdk-intro.md @@ -21,7 +21,7 @@ To use the capabilities of the Marlowe TS-SDK, have an active link to a Marlowe - **[Marlowe Payouts](https://github.com/input-output-hk/marlowe-payouts)** Engineered with the Marlowe TS-SDK, this DApp offers a streamlined approach to discerning and extracting payouts from Marlowe contracts on the Cardano blockchain. With a commitment to user experience, it ensures intuitive interactions and unhindered connectivity to the Cardano network. - **[Vesting Prototype](https://github.com/input-output-hk/marlowe-ts-sdk/blob/main/pocs/contract-example/vesting-flow.html)** -Dive into the [Vesting](https://github.com/input-output-hk/marlowe-vesting) DApp, tailored for: +Dive into the **[Vesting DApp](https://github.com/input-output-hk/marlowe-vesting)**, tailored for: - Tokenomics orchestration. - Timed fund safeguards. - Pre-planned fund distributions to diverse stakeholders. From 6c9900a3271c0cb7cffa3c90afcdd8fa08b4c129 Mon Sep 17 00:00:00 2001 From: Joseph Fajen Date: Thu, 19 Oct 2023 13:32:02 -0700 Subject: [PATCH 3/3] Addressed comments from first draft --- docs/developer-tools/ts-sdk-intro.md | 28 ++++++++++------------------ 1 file changed, 10 insertions(+), 18 deletions(-) diff --git a/docs/developer-tools/ts-sdk-intro.md b/docs/developer-tools/ts-sdk-intro.md index 8b38e61..b45c563 100644 --- a/docs/developer-tools/ts-sdk-intro.md +++ b/docs/developer-tools/ts-sdk-intro.md @@ -10,26 +10,18 @@ The **[Marlowe TypeScript SDK (TS-SDK)](https://github.com/input-output-hk/marlo 1. **Smart contract toolkit**: Craft, deploy, and manage Marlowe smart contracts on the Cardano blockchain with the tools and libraries in the TS-SDK. 2. **Integration with Marlowe Playground**: The TS-SDK works well with the Marlowe Playground, an online interface dedicated to designing, simulating, and scrutinizing Marlowe contracts. -3. **Wallet connectivity**: With built-in modules, the SDK promotes smooth interactions with various wallet extensions. This ensures easy access to wallet data and the efficient integration of Marlowe contracts with a variety of wallet interfaces. -4. **Proof-of-Concept (PoC) templates**: Embark on your DApp journey using the TS-SDK's distilled example templates. These PoC templates serve as invaluable launching pads for your customized applications. +3. **Wallet connectivity**: With built-in modules, the TS-SDK promotes smooth interactions with various wallet extensions. This ensures easy access to wallet data and the efficient integration of Marlowe contracts with a variety of wallet interfaces. +4. **Proof-of-concept (PoC) templates**: Embark on your DApp journey using the TS-SDK's distilled example templates. These PoC templates serve as launching pads for your customized applications. ## Getting started -To use the capabilities of the Marlowe TS-SDK, have an active link to a Marlowe Runtime instance and a browser-installed wallet extension that's compatible. +To use the capabilities of the Marlowe TS-SDK, you will need to have a URL to a running instance of the Marlowe Runtime and a compatible wallet extension installed in your browser. Please refer to the **[Marlowe starter kit](https://github.com/input-output-hk/marlowe-starter-kit)** for guidance about accessing a running instance of the Runtime. ## PoC templates -- **[Marlowe Payouts](https://github.com/input-output-hk/marlowe-payouts)** -Engineered with the Marlowe TS-SDK, this DApp offers a streamlined approach to discerning and extracting payouts from Marlowe contracts on the Cardano blockchain. With a commitment to user experience, it ensures intuitive interactions and unhindered connectivity to the Cardano network. -- **[Vesting Prototype](https://github.com/input-output-hk/marlowe-ts-sdk/blob/main/pocs/contract-example/vesting-flow.html)** -Dive into the **[Vesting DApp](https://github.com/input-output-hk/marlowe-vesting)**, tailored for: - - Tokenomics orchestration. - - Timed fund safeguards. - - Pre-planned fund distributions to diverse stakeholders. -This DApp manages the phased allocation of shares over a designated time frame. Users can easily retrieve shares upon vesting. - -### User narratives -- As a company, I want to design a fresh vesting schedule for a team member. -- As a user, I aim to check my vested share tally by syncing my wallet. -- As a user, I seek to claim any vested shares. -- As a company, I require the latitude to revoke share options and dissolve vesting schedules before they mature. - +- **[Marlowe payouts DApp](https://github.com/input-output-hk/marlowe-payouts)**: Engineered with the Marlowe TS-SDK, this DApp offers a streamlined approach to discerning and extracting payouts from Marlowe contracts on the Cardano blockchain. With a commitment to user experience, it ensures intuitive interactions and unhindered connectivity to the Cardano network. +- **[Vesting prototype repo](https://github.com/input-output-hk/marlowe-vesting)**: Manages the phased allocation of shares over a designated time frame. Users can easily retrieve shares upon vesting. Tailored for projects that require the following sorts of capabilities: + - Tokenomics orchestration + - Timed fund safeguards + - Pre-planned fund distributions to diverse stakeholders. + +- **[Vesting prototype example](https://github.com/input-output-hk/marlowe-ts-sdk/blob/main/pocs/contract-example/vesting-flow.html)**: Shows you a concrete instance of how to use the vesting prototype repo and the kinds of use cases it enables.