Update ts-sdk-intro.md

[nhenin]

No description provided.

[joseph-fajen]

Nicolas, I had lots of suggested edits and I recommend replacing the whole page with the content below. I had trouble following the links for Vesting flow and Module vesting. I checked the URLs and made changes that made sense to me, but please review the descriptions for those two items. I think part of those two descriptions and sets of links got intertwined a little bit in your draft.

---

title: Marlowe TypeScript SDK
sidebar_position: 2

Introduction

The Marlowe TypeScript SDK (TS-SDK) consists of JavaScript and TypeScript libraries, available as npm packages. 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:
   • @marlowe.io/language-core-v1
   • @marlowe.io/wallet
   • @marlowe.io/marlowe-object.
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 (CIP-30, Lucid adapters), the TS-SDK promotes smooth interactions with various wallet extensions, such as Lace, Nami, and Eternl. This ensures easy access to wallet data and the efficient integration of Marlowe contracts with a variety of wallet interfaces. (See @marlowe.io/wallet).
4. Integration with the Runtime: We aim to provide a Runtime Rest Client which has one-to-one feature parity with marlowe-runtime-web, so you can benefit from all the Runtime features in a JavaScript and TypeScript Environment. (See @marlowe.io/runtime-rest-client).
5. Coordination between wallets and Runtime: We provide abstractions over the Runtime Rest Client and the wallets that remove the 'plumbing' logic and allows you to focus on your core business logic. (See @marlowe.io/runtime-lifecycle).
6. Prototype DApp examples: Embark on your DApp journey using the TS-SDK's distilled prototype examples. These prototypes serve as launching pads for your customized applications.

Getting started

Please look at the Readme.md of the GitHub repository. Examples, detailed documentation, and small tools are available, providing a quick overview of the Marlowe TS-SDK and its capabilities.

Your feedback and participation

This Marlowe TypeScript SDK (TS-SDK) is released under an open source license. You can read, use, deploy, customize, improve, and fork it at will. Look at different parts of our GitHub repository and especially the discussions section. We encourage your feedback and participation in its development as that will impact the project's development.

Marlowe contract examples

These contract examples are released under an open source license within our npm package @marlowe.io/language-examples. You can read, customize, improve, and fork them at will. We encourage your feedback and participation.

• Vesting flow
• Module vesting: A vesting contract implementation is available in the TS-SDK. It supports the Token Plans Prototype and gives you a full implementation of the Marlowe contract used in a TypeScript Web-based DApp environment.
• Atomic swap using open roles feature (coming soon): This Marlowe contract allows two participants (a seller and a buyer) to atomically exchange some token A against some token B without knowing the buyer in advance.

Open source prototypes using the TS-SDK

These prototypes are released under an open source license. You can read, deploy, customize, improve, and fork them at will. We encourage your feedback and participation.

• Payouts DApp: This prototype is an example of a decentralized application (DApp) designed to help users discover, track, and withdraw tokens from Marlowe smart contracts that use role tokens. It enables holders of role tokens in Marlowe smart contracts to withdraw the received funds, simplifying the process of tracking and withdrawing their payouts.
• Token Plans DApp GitHub Repository: This prototype is a demonstration of how to build DApps powered by Marlowe with well-known mainstream web technologies such as TypeScript and React Framework. It is a use case of a vesting contract developed and available in the Marlowe TS-SDK. It allows you to create ₳ Token Plans over Cardano. ₳ Token Plans can be created by a 'Token Provider.' The Token Provider will deposit a given ₳ amount with a time-based scheme defining how to release these ₳ to a 'Claimer' participant.
• Order Book Swap Prototype: (Coming soon) This prototype will demonstrate our new Marlowe Open Roles feature by using a new Atomic Swap Contract.

[sfoo-iohk]

spelling: participate

[sfoo-iohk]

spelling: Contract... Environment

Malformed markdown link - the example contract should be elsewhere