orbiter sdk
1.0.0
Orbiter-Sdk é uma biblioteca de transferência multiplataforma Layer2 segura e rápida
# Use yarn
yarn add orbiter-sdk
# Or use npm
npm install orbiter-sdk --save
Projeto de exemplo de front-end baseado em vue3+vite. diretório
Campo | tipo | padrão | desc |
---|---|---|---|
ID da cadeia | número | - | ChainId do orbitador |
nome | corda | - | Nome do token. ex: ETH, USDC |
endereço | corda | - | Endereço do contrato de token |
precisão | número | - | Decimais simbólicos |
endereço do fabricante | corda | - | Endereço Ethereum do fabricante do Orbiter |
ícone | corda | - | Ícone de token (TODO) |
Campo | tipo | padrão | desc |
---|---|---|---|
eu ia | número | - | ChainId do orbitador |
nome | corda | - | Nome da cadeia |
ID da rede | número | corda | - | Cadeia de redeId |
ícone | corda | - | Ícone de corrente (TODO) |
valor: 'Mainnet' | 'Testnet'
// constructor
const bridge = new Bridge ( 'Mainnet' or 'Testnet' )
Parâmetros: -
Retorno: 'Mainnet' | 'Testnet'
Exemplo de uso: próximo à linha 118 do arquivo
Parâmetros:
Campo | tipo | padrão | desc |
---|---|---|---|
daChain | BridgeChain | indefinido | Selecionado da cadeia |
para cadeia | BridgeChain | indefinido | Selecionado para encadear |
Retornar:
Campo | tipo | padrão | desc |
---|---|---|---|
fichas | BridgeToken[] | - | Tokens de suporte |
deChains | Cadeia de ponte[] | - | Suporte deChains |
paraChains | Cadeia de ponte[] | - | Suporte para Chains |
Exemplo de uso: próximo à linha 151 do arquivo
Parâmetros:
Campo | tipo | padrão | desc |
---|---|---|---|
ficha | BridgeToken | - | Token selecionado |
daChain | BridgeChain | - | Selecionado da cadeia |
para cadeia | BridgeChain | - | Selecionado da cadeia |
quantidadeHm | corda | número | indefinido | Quantidade legível por humanos. ex: 0,01 |
Retornar:
Campo | tipo | padrão | desc |
---|---|---|---|
texto de pagamento | corda | - | Código de identificação do orbitador |
valor do pagamento | éteres.BigNumber | - | Valor do pagamento do Bignumbber |
pagarValorHm | corda | - | Valor de pagamento legível por humanos |
receberValorHm | corda | - | Quantidade de recebimento legível por humanos |
Exemplo de uso: próximo à linha 167 do arquivo
Parâmetros:
Campo | tipo | padrão | desc |
---|---|---|---|
signatário | éteres.Signer | - | Signatário Ethereum. ex: novos provedores.Web3Provider(window.ethereum).getSigner() |
ficha | BridgeToken | - | Token selecionado |
daChain | BridgeChain | - | Selecionado da cadeia |
para cadeia | BridgeChain | - | Selecionado da cadeia |
quantidadeHm | corda | número | indefinido | Quantidade legível por humanos. ex: 0,01 |
Retorno: A estrutura de dados atual retornada por cadeias diferentes, nenhuma estrutura de dados unificada ainda