orbiter sdk
1.0.0
Orbiter-Sdk是一個安全、快速的Layer2跨平台傳輸庫
# Use yarn
yarn add orbiter-sdk
# Or use npm
npm install orbiter-sdk --save
基於vue3+vite的前端範例專案。目錄
場地 | 類型 | 預設 | 描述 |
---|---|---|---|
鏈號 | 數位 | - | Orbiter 的 chainId |
姓名 | 細繩 | - | 代幣名稱。例如:ETH、USDC |
地址 | 細繩 | - | 代幣合約地址 |
精確 | 數位 | - | 令牌小數 |
製造商地址 | 細繩 | - | Orbiter 的創始者以太坊地址 |
圖示 | 細繩 | - | 代幣圖示(TODO) |
場地 | 類型 | 預設 | 描述 |
---|---|---|---|
ID | 數位 | - | Orbiter 的 chainId |
姓名 | 細繩 | - | 連鎖名稱 |
網路ID | 數量 |細繩 | - | 鍊網絡ID |
圖示 | 細繩 | - | 鏈結圖示(TODO) |
值: 'Mainnet' | 'Testnet'
// constructor
const bridge = new Bridge ( 'Mainnet' or 'Testnet' )
參數:-
返回: 'Mainnet' | 'Testnet'
用法範例:文件中第 118 行左右
參數:
場地 | 類型 | 預設 | 描述 |
---|---|---|---|
來自鏈 | 橋鏈 | 不明確的 | 從鏈中選擇 |
到鏈 | 橋鏈 | 不明確的 | 選擇連結 |
返回:
場地 | 類型 | 預設 | 描述 |
---|---|---|---|
代幣 | 橋接令牌[] | - | 支持代幣 |
來自鏈 | 橋鏈[] | - | 來自Chains的支持 |
至鏈 | 橋鏈[] | - | 支援鏈 |
用法範例:文件中第 151 行左右
參數:
場地 | 類型 | 預設 | 描述 |
---|---|---|---|
代幣 | 橋接代幣 | - | 選定的代幣 |
來自鏈 | 橋鏈 | - | 從鏈中選擇 |
到鏈 | 橋鏈 | - | 從鏈中選擇 |
量Hm | 字串|數位 | 不明確的 | 人類可讀的數量。例如:0.01 |
返回:
場地 | 類型 | 預設 | 描述 |
---|---|---|---|
支付文字 | 細繩 | - | 軌道器識別碼 |
支付金額 | 以太.BigNumber | - | 大數字支付金額 |
支付金額Hm | 細繩 | - | 人類可讀的支付金額 |
接收金額Hm | 細繩 | - | 人類可讀的接收金額 |
用法範例:文件中第 167 行左右
參數:
場地 | 類型 | 預設 | 描述 |
---|---|---|---|
簽名人 | 以太坊簽署者 | - | 以太坊簽名者。例如:新的providers.Web3Provider(window.ethereum).getSigner() |
代幣 | 橋接代幣 | - | 選定的代幣 |
來自鏈 | 橋鏈 | - | 從鏈中選擇 |
到鏈 | 橋鏈 | - | 從鏈中選擇 |
量Hm | 字串|數位 | 不明確的 | 人類可讀的數量。例如:0.01 |
Return:目前各鏈回傳的資料結構不同,目前還沒有統一的資料結構