README.md

Order Book Swap Prototype

Overview

The Order Book Token Swap Prototype aims to create a decentralized platform where users can list tokens for swap, specifying the desired amount and type of other tokens in return. Interested parties from around the globe can accept these offers, leading to a finalized token swap.

This Order Book Token Swap was built using mainstream Web Technologies & Frameworks (Typescript & React) on top of the Marlowe Web DApp Stack:

• Marlowe TypeScript SDK (TS-SDK): a suite of TypeScript/JavaScript libraries for developing Web-DApp in the Cardano Blockchain using Marlowe Technologies.

Deployed Instance

We invite you to test a deployed instance of the Order Book Token Swap Prototype for yourself.

Requirements

It is recommended to use Node v18.0.0 or higher.

How To Run Locally

To get the DApp up and running on your local machine, follow these steps:

1. Clone the Repository

   git clone https://github.com/input-output-hk/marlowe-order-book-swap
   cd marlowe-order-book-swap

2. Install Dependencies

   npm install

3. Configure variables in .env.example

   To ensure that the dApp works correctly, you need to set the appropriate URLs in the .env file.

   Steps

   1. Open the .env.example File: Navigate to the root directory of your project and open the .env.example file in your preferred text editor.

   2. Set the Marlowe runtime URL Your Marlowe Runtime instance must be v0.0.6 or higher. Locate the line NEXT_PUBLIC_RUNTIME_URL="<Your-Runtime-URL>". Replace <Your-Runtime-URL> with your Marlowe runtime URL.

   3. Set your dApp ID Locate the line NEXT_PUBLIC_DAPP_ID="<Your-DAPP-ID>". Choose an ID for your swap project (check if someone are using your ID first). Then replace <Your-DAPP-ID> with your selected ID.

4. Rename the .env.example file

   Since the .env file is gitignored, you need to rename the name of the file to .env.

5. Run the DApp

   npm run dev

Enjoy and stay tuned for our next releases!