Skip to content

Orbiter-Sdk is a secure and fast Layer2 cross-platform transfer library

License

Notifications You must be signed in to change notification settings

cryptobank04/orbiter-sdk

 
 

Repository files navigation

Orbiter-Sdk

styled with prettier Greenkeeper badge Coveralls

Orbiter-Sdk is a secure and fast Layer2 cross-platform transfer library

Usage

# Use yarn
yarn add orbiter-sdk

# Or use npm
npm install orbiter-sdk --save

Examples

Frontend

example-frontend.png

Front-end example project based on vue3+vite. dir

Types

BridgeToken

Field type default desc
chainId number - Orbiter's chainId
name string - Token name. ex: ETH, USDC
address string - Token contract address
precision number - Token decimals
makerAddress string - Orbiter's maker ethereum address
icon string - Token icon(TODO)

BridgeChain

Field type default desc
id number - Orbiter's chainId
name string - Chain name
networkId number | string - Chain nerworkId
icon string - Chain icon(TODO)

BridgeNetwork

value: 'Mainnet' | 'Testnet'

Classes

Bridge

// constructor
const bridge = new Bridge('Mainnet' or 'Testnet')

bridge.getNetwork

Params: -

Return: 'Mainnet' | 'Testnet'

bridge.supports