npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

odiinnn-orbiter-sdk

v0.1.11

Published

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![Greenkeeper badge](https://badges.greenkeeper.io/alexjoverm/typescript-library-starter.svg)](https://greenkeeper.io/) [![Cover

Downloads

1

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

odiinnnodiinnn

Keywords

Readme

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 odiinnn-orbiter-sdk

# Or use npm
npm install odiinnn-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

Usage example: around line 118 in the file

Params: | Field | type | default | desc | | :-------- | :---------: | :-------: | :-----------------: | | fromChain | BridgeChain | undefined | Selected from chain | | toChain | BridgeChain | undefined | Selected to chain |

Return: | Field | type | default | desc | | :-------- | :---------: | :-------: | :-----------------: | | tokens | BridgeToken[] | - | Support tokens | | fromChains | BridgeChain[] | - | Support fromChains | | toChains | BridgeChain[] | - | Support toChains |

bridge.getAmounts

Usage example: around line 151 in the file

Params: | Field | type | default | desc | | :-------- | :---------: | :-------: | :-----------------: | | token | BridgeToken | - | Selected token | | fromChain | BridgeChain | - | Selected from chain | | toChain | BridgeChain | - | Selected from chain | | amountHm | string | number | undefined | Human readable amount. ex: 0.01 |

Return: | Field | type | default | desc | | :-------- | :---------: | :-------: | :-----------------: | | payText | string | - | Orbiter identification code | | payAmount | ethers.BigNumber | - | Bignumbber pay amount | | payAmountHm | string | - | Human readable pay amount | | receiveAmountHm | string | - | Human readable receive amount |

bridge.transfer

Usage example: around line 167 in the file

Params: | Field | type | default | desc | | :-------- | :---------: | :-------: | :-----------------: | | signer | ethers.Signer | - | Ethereum signer. ex: new providers.Web3Provider(window.ethereum).getSigner() | | token | BridgeToken | - | Selected token | | fromChain | BridgeChain | - | Selected from chain | | toChain | BridgeChain | - | Selected from chain | | amountHm | string | number | undefined | Human readable amount. ex: 0.01 |

Return: The current data structure returned by different from chains, no unified data structure yet

Features

  • [x] Bridge support
  • [ ] Bridge.transfer return unified data structure
  • [ ] Bridge.getSave support. (Get save times an fee using orbiter)
  • [ ] Bridge.transferListen support. (Listen transfer into user address)