orbiter sdk

オービター SDK

Orbiter-Sdk は安全で高速な Layer2 クロスプラットフォーム転送ライブラリです

使用法

 # Use yarn
yarn add orbiter-sdk

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

例

フロントエンド

vue3+vite に基づくフロントエンドのサンプル プロジェクト。ディレクトリ

種類

ブリッジトークン

分野	タイプ	デフォルト	説明
チェーンID	番号	-	オービターのチェーンID
名前	弦	-	トークン名。例: ETH、USDC
住所	弦	-	トークンコントラクトアドレス
精度	番号	-	トークン小数点
メーカー住所	弦	-	オービターのメーカーのイーサリアムアドレス
アイコン	弦	-	トークンアイコン(TODO)

ブリッジチェーン

分野	タイプ	デフォルト	説明
ID	番号	-	オービターのチェーンID
名前	弦	-	チェーン名
ネットワークID	番号 |弦	-	チェーンネットワークID
アイコン	弦	-	チェーンアイコン(TODO)

ブリッジネットワーク

値: 'Mainnet' | 'Testnet'

クラス

橋

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

ブリッジ.getネットワーク

パラメータ: -

戻り値: 'Mainnet' | 'Testnet'

ブリッジサポート

使用例：ファイル118行目あたり

パラメータ:

分野	タイプ	デフォルト	説明
fromチェーン	ブリッジチェーン	未定義	チェーンから選択
toChain	ブリッジチェーン	未定義	チェーンするために選択されました

戻る：

分野	タイプ	デフォルト	説明
トークン	ブリッジトークン[]	-	サポートトークン
fromチェーン	ブリッジチェーン[]	-	チェーンからのサポート
toChains	ブリッジチェーン[]	-	チェーンのサポート

ブリッジ.getAmounts

使用例：ファイル151行目あたり

パラメータ:

分野	タイプ	デフォルト	説明
トークン	ブリッジトークン	-	選択されたトークン
fromチェーン	ブリッジチェーン	-	チェーンから選択
toChain	ブリッジチェーン	-	チェーンから選択
量うーん	文字列 |番号	未定義	人間が判読できる量。例: 0.01

戻る：

分野	タイプ	デフォルト	説明
ペイテキスト	弦	-	オービター識別コード
支払い金額	ethers.BigNumber	-	ビッグナンバーの支払い額
支払い金額Hm	弦	-	人間が判読できる給与額
受け取り金額Hm	弦	-	人間が判読できる受信金額

ブリッジ.トランスファー

使用例：ファイル167行目あたり

パラメータ:

分野	タイプ	デフォルト	説明
署名者	エーテル署名者	-	イーサリアム署名者。例: 新しいプロバイダー.Web3Provider(window.ethereum).getSigner()
トークン	ブリッジトークン	-	選択されたトークン
fromチェーン	ブリッジチェーン	-	チェーンから選択
toChain	ブリッジチェーン	-	チェーンから選択
量うーん	文字列 |番号	未定義	人間が判読できる量。例: 0.01

戻り値: チェーンとは異なる現在のデータ構造が返されました。まだ統一されたデータ構造はありません。

特徴

• ブリッジサポート
• Bridge.transfer は統合データ構造を返します
• Bridge.getSave のサポート。 (オービターを使用すると節約回数を節約できます)
• Bridge.transferListen のサポート。 (ユーザーアドレスへのリッスン転送)