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:当前各链返回的数据结构不同,目前还没有统一的数据结构