https://github.com/numotrade/numo-ts

A typescript SDK for Numo markets.
https://github.com/numotrade/numo-ts

Last synced: 4 days ago
JSON representation

A typescript SDK for Numo markets.

• Host: GitHub
• URL: https://github.com/numotrade/numo-ts
• Owner: numotrade
• Created: 2023-09-15T13:59:57.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-02T17:38:15.000Z (13 days ago)
• Last Synced: 2024-11-02T18:27:21.375Z (13 days ago)
• Language: TypeScript
• Homepage:
• Size: 30.5 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Numo.ts

Numo.ts is a TypeScript sdk for building web apps on Numo markets. Allowing you to efficiently buy or sell [european-style](https://en.wikipedia.org/wiki/European_option) call options on any `ERC-20` token.

It uses `reverse-mirage` to generate the TypeScript bindings from the Numo smart contracts.

## Installation

```bash

npm install --save @numotrade/numo-ts

```

## Getting Started

Instantiate your of Numo using your ethers provider:

### Examples

#### Through a RPC Provider (i.e. QuickNode) 

```typescript

import { Numo } from "@numotrade/numo-ts";

import { ethers } from "ethers";

const provider = new ethers.JsonRpcProvider(process.env.RPC_URL);

const numo = new Numo(provider);

```

#### Exercising a ERC-20 call option