Website • Documentation • SDK TS doc
Provides an easy integration with the Allbridge Core ChainBridgeService for DApps in the browser or Node.js
$ npm install @allbridge/bridge-core-sdkimport { AllbridgeCoreSdk, nodeRpcUrlsDefault } from "@allbridge/bridge-core-sdk";
// Connections to blockchains will be made through your rpc-urls passed during initialization
const sdk = new AllbridgeCoreSdk({
...nodeRpcUrlsDefault,
TRX: "your trx-rpc-url",
ETH: "your eth-rpc-url"
});
// The Provider parameter may not be passed in methods where it is present, for example:
const rawTx = await sdk.bridge.rawTxBuilder.send(sendParams);import { AllbridgeCoreSdk, nodeRpcUrlsDefault } from "@allbridge/bridge-core-sdk";
const sdk = new AllbridgeCoreSdk(nodeRpcUrlsDefault);
// The Provider parameter must be passed in order for it to be used to connect to the blockchain, for example:
const rawTx = await sdk.bridge.rawTxBuilder.send(sendParams, provider);TIP: Use 1.1 in case your provider differs from required by the SDK (Web3:v1.9.0, tronweb:v4.4.0)
const supportedChains = await sdk.chainDetailsMap();
// extract information about ETH chain
const {bridgeAddress, tokens, chainId, name} = supportedChains[ChainSymbol.ETH];
// Choose one of the tokens supported on ETH
const usdtOnEthToken = tokens.find(token => token.symbol === 'USDT');Before sending tokens, the bridge has to be authorized to use the tokens of the owner.
This is done by calling the approve method on SDK instance.
If the current allowance is not 0, this function will perform an additional transaction to set allowance to 0 before setting the new allowance value.
const response = await sdk.bridge.approve(provider, {
token: sourceToken,
owner: accountAddress
});Initiate the transfer of tokens with send method on SDK instance.
sdk.bridge.send(provider, {
amount: "1.01",
fromAccountAddress: fromAddress,
toAccountAddress: toAddress,
sourceToken: sourceToken,
destinationToken: destinationToken,
messenger: Messenger.ALLBRIDGE,
});Swap BUSD on BSC chain to USDT on TRX chain
import {
AllbridgeCoreSdk,
ChainSymbol,
Messenger,
} from "@allbridge/bridge-core-sdk";
import Web3 from "web3";
import * as dotenv from "dotenv";
dotenv.config({ path: ".env" });
async function runExample() {
// sender address
const fromAddress = '0x01234567890abcdef01234567890abcdef012345';
// recipient address
const toAddress = 'AbcDefGHIJklmNoPQRStuvwXyz1aBcDefG';
// configure web3
const web3 = new Web3('https://bsc-dataseed1.binance.org:443');
const account = web3.eth.accounts.privateKeyToAccount(process.env.PRIVATE_KEY);
web3.eth.accounts.wallet.add(account);
const sdk = new AllbridgeCoreSdk({
solanaRpcUrl: "your solana-rpc-url",
tronRpcUrl: "your tron-rpc-url",
});
// fetch information about supported chains
const chains = await sdk.chainDetailsMap();
const bscChain = chains[ChainSymbol.BSC];
const busdToken = bscChain.tokens.find(token => token.symbol === 'BUSD');
const trxChain = chains[ChainSymbol.TRX];
const usdtToken = trxChain.tokens.find(token => token.symbol === 'USDT');
// authorize a transfer of tokens from sender's address
await sdk.bridge.approve(web3, {
token: busdToken,
owner: fromAddress
});
// initiate transfer
const response = await sdk.bridge.send(web3, {
amount: "1.01",
fromAccountAddress: fromAddress,
toAccountAddress: toAddress,
sourceToken: busdToken,
destinationToken: usdtToken,
messenger: Messenger.ALLBRIDGE,
});
console.log("Tokens sent:", response.txId);
}
runExample();TIP: For more details, see Examples
SDK supports operation with Liquidity Pools
For more details, see Examples
SDK method bridge.rawTxBuilder.approve can be used to create approve Transaction.
const rawTransactionApprove = await sdk.bridge.rawTxBuilder.approve(provider, approveParams);SDK method bridge.rawTxBuilder.send can be used to create send Transaction.
const rawTransactionSend = await sdk.bridge.rawTxBuilder.send(sendParams, provider);TIP: To interact with the Solana blockchain: do not pass provider param
const transaction = await sdk.bridge.rawTxBuilder.send(sendParams);TIP: For more details, see Example
SDK method getTransferStatus can be used to get information about tokens transfer.
const transferStatus = await sdk.getTransferStatus(chainSymbol, txId);SDK method getAmountToBeReceived can be used to calculate the amount of tokens the receiving party will get after
applying the bridging fee.
const amountToBeReceived = await sdk.getAmountToBeReceived(
amountToSend,
sourceToken,
destinationToken
);SDK method getAmountToSend can be used to calculate the amount of tokens to send based on the required amount of
tokens the receiving party should get.
const amountToSend = await sdk.getAmountToSend(
amountToBeReceived,
sourceToken,
destinationToken
);The SDK method getGasFeeOptions allows to retrieve information about the available methods to pay the gas fee,
as well as the amount of gas fee needed to complete a transfer on the destination chain.
Gas fee is paid during the send operation
and can be paid either in the source chain's currency or in source tokens.
The method returns an object with two properties:
- native: The amount of gas fee, denominated in unit of the source chain currency (e.g. wei for Ethereum).
- stablecoin: (optional) The amount of gas fee, denominated in unit of the source token. If this property is not present, it indicates that the stablecoin payment method is not available.
const { native, stablecoin } = await sdk.getGasFeeOptions(
usdtOnEthToken, // from ETH
usdtOnTrxToken, // to TRX
Messenger.ALLBRIDGE
);
console.log(native);
// Output:
// {
// int: "10000000000000000",
// float: "0.01" // (0.01 ETH)
// }
console.log(stablecoin);
// Output:
// {
// int: "10010000",
// float: "10.01" // (10.01 USDT)
// }SDK method getAverageTransferTime can be used to get the average time in ms it takes to complete a transfer for a
given combination of tokens and messenger.
const transferTimeMs = sdk.getAverageTransferTime(
sourceToken,
destinationToken,
Messenger.ALLBRIDGE
);