orbiter sdk
1.0.0
Orbiter-Sdk ist eine sichere und schnelle plattformübergreifende Layer2-Übertragungsbibliothek
# Use yarn
yarn add orbiter-sdk
# Or use npm
npm install orbiter-sdk --save
Frontend-Beispielprojekt basierend auf vue3+vite. dir
Feld | Typ | Standard | absteigend |
---|---|---|---|
Ketten-ID | Nummer | - | ChainId des Orbiters |
Name | Zeichenfolge | - | Tokenname. Beispiel: ETH, USDC |
Adresse | Zeichenfolge | - | Token-Vertragsadresse |
Präzision | Nummer | - | Token-Dezimalstellen |
Herstelleradresse | Zeichenfolge | - | Adresse des Herstellers von Orbiter, Ethereum |
Symbol | Zeichenfolge | - | Token-Symbol (TODO) |
Feld | Typ | Standard | absteigend |
---|---|---|---|
Ausweis | Nummer | - | ChainId des Orbiters |
Name | Zeichenfolge | - | Kettenname |
Netzwerk-ID | Zahl | Zeichenfolge | - | Chain nerworkId |
Symbol | Zeichenfolge | - | Kettensymbol (TODO) |
Wert: 'Mainnet' | 'Testnet'
// constructor
const bridge = new Bridge ( 'Mainnet' or 'Testnet' )
Parameter: -
Rückgabe: 'Mainnet' | 'Testnet'
Anwendungsbeispiel: etwa Zeile 118 in der Datei
Parameter:
Feld | Typ | Standard | absteigend |
---|---|---|---|
vonChain | BridgeChain | undefiniert | Aus der Kette ausgewählt |
toChain | BridgeChain | undefiniert | Zum Verketten ausgewählt |
Zurückkehren:
Feld | Typ | Standard | absteigend |
---|---|---|---|
Token | BridgeToken[] | - | Support-Token |
vonChains | BridgeChain[] | - | Unterstützung von Chains |
zuKetten | BridgeChain[] | - | Unterstützung für Chains |
Anwendungsbeispiel: etwa Zeile 151 in der Datei
Parameter:
Feld | Typ | Standard | absteigend |
---|---|---|---|
Token | BridgeToken | - | Ausgewählter Token |
vonChain | BridgeChain | - | Aus der Kette ausgewählt |
toChain | BridgeChain | - | Aus der Kette ausgewählt |
MengeHm | Zeichenfolge | Nummer | undefiniert | Vom Menschen lesbarer Betrag. Beispiel: 0,01 |
Zurückkehren:
Feld | Typ | Standard | absteigend |
---|---|---|---|
payText | Zeichenfolge | - | Identifikationscode des Orbiters |
payAmount | ethers.BigNumber | - | Bignumbber-Gehaltsbetrag |
payAmountHm | Zeichenfolge | - | Für Menschen lesbarer Lohnbetrag |
empfangenAmountHm | Zeichenfolge | - | Für Menschen lesbarer Empfangsbetrag |
Anwendungsbeispiel: etwa Zeile 167 in der Datei
Parameter:
Feld | Typ | Standard | absteigend |
---|---|---|---|
Unterzeichner | ethers.Signer | - | Unterzeichner von Ethereum. Beispiel: neue Anbieter.Web3Provider(window.ethereum).getSigner() |
Token | BridgeToken | - | Ausgewählter Token |
vonChain | BridgeChain | - | Aus der Kette ausgewählt |
toChain | BridgeChain | - | Aus der Kette ausgewählt |
MengeHm | Zeichenfolge | Nummer | undefiniert | Vom Menschen lesbarer Betrag. Beispiel: 0,01 |
Rückgabe: Die aktuelle Datenstruktur, die von anderen als den Ketten zurückgegeben wird, noch keine einheitliche Datenstruktur