orbiter sdk
1.0.0
Orbiter-Sdk — это безопасная и быстрая кроссплатформенная библиотека передачи Layer2.
# Use yarn
yarn add orbiter-sdk
# Or use npm
npm install orbiter-sdk --save
Пример проекта внешнего интерфейса на основе vue3+vite. реж.
| Поле | тип | по умолчанию | описание |
|---|---|---|---|
| идентификатор цепи | число | - | Идентификатор цепи орбитального аппарата |
| имя | нить | - | Имя токена. пример: ETH, USDC |
| адрес | нить | - | Адрес контракта токена |
| точность | число | - | Десятичные знаки токена |
| адрес производителя | нить | - | Адрес Эфириума создателя Орбитера |
| икона | нить | - | Значок токена (TODO) |
| Поле | тип | по умолчанию | описание |
|---|---|---|---|
| идентификатор | число | - | Идентификатор цепи орбитального аппарата |
| имя | нить | - | Название сети |
| идентификатор сети | номер | нить | - | Цепочка nerworkId |
| икона | нить | - | Значок цепочки (TODO) |
значение: 'Mainnet' | 'Testnet'
// constructor
const bridge = new Bridge ( 'Mainnet' or 'Testnet' ) Параметры: -
Возврат: 'Mainnet' | 'Testnet'
Пример использования: около 118 строки файла.
Параметры:
| Поле | тип | по умолчанию | описание |
|---|---|---|---|
| fromChain | МостЦепь | неопределенный | Выбрано из цепочки |
| toChain | МостЦепь | неопределенный | Выбрано для цепочки |
Возвращаться:
| Поле | тип | по умолчанию | описание |
|---|---|---|---|
| жетоны | БриджТокен[] | - | Токены поддержки |
| fromChains | Бриджчейн[] | - | Поддержка от Chains |
| toChains | Бриджчейн[] | - | Поддержка цепочек |
Пример использования: около 151 строки файла.
Параметры:
| Поле | тип | по умолчанию | описание |
|---|---|---|---|
| жетон | BridgeToken | - | Выбранный токен |
| fromChain | МостЦепь | - | Выбрано из цепочки |
| toChain | МостЦепь | - | Выбрано из цепочки |
| суммаХм | строка | число | неопределенный | Человекочитаемая сумма. пример: 0,01 |
Возвращаться:
| Поле | тип | по умолчанию | описание |
|---|---|---|---|
| payText | нить | - | Идентификационный код орбитального аппарата |
| сумма оплаты | эфиры.BigNumber | - | Большая сумма оплаты |
| оплатаСуммаХм | нить | - | Человекочитаемая сумма оплаты |
| получить суммуHm | нить | - | Человекочитаемая сумма получения |
Пример использования: около 167 строки файла.
Параметры:
| Поле | тип | по умолчанию | описание |
|---|---|---|---|
| подписавший | эфиры.подписчик | - | Подписант Ethereum. пример: новые поставщики.Web3Provider(window.ethereum).getSigner() |
| жетон | BridgeToken | - | Выбранный токен |
| fromChain | МостЦепь | - | Выбрано из цепочки |
| toChain | МостЦепь | - | Выбрано из цепочки |
| суммаХм | строка | число | неопределенный | Человекочитаемая сумма. пример: 0,01 |
Возврат: текущая структура данных, возвращаемая различными цепочками, единой структуры данных пока нет.
