mirror of
https://github.com/Brotocol-xyz/bro-sdk.git
synced 2026-01-12 06:44:18 +08:00
chore: apply format to main readme
This commit is contained in:
sofinico
199
README.md
199
README.md
@@ -1,4 +1,5 @@
|
||||
# XLinkSDK
|
||||
|
||||
XLink is designed to facilitate the transfer of digital tokens between different blockchains. Its primary purpose is to act as a bridge, enabling users to move and swap their tokens seamlessly across various blockchain ecosystems.
|
||||
|
||||
## System Type and Purpose
|
||||
@@ -10,27 +11,31 @@ XLinkSDK allows users to interact with XLink. It can be used in backend environm
|
||||
### Prerequisites
|
||||
|
||||
Ensure you have the following installed:
|
||||
|
||||
- [Node.js](https://nodejs.org/en)
|
||||
- [pnpm](https://pnpm.io/)
|
||||
|
||||
### Installation
|
||||
### Installing the XLink SDK Library
|
||||
|
||||
To install the XLink SDK, use the following command:
|
||||
|
||||
```bash
|
||||
pnpm install @xlink-network/xlink-sdk
|
||||
```
|
||||
|
||||
## XLink SDK API
|
||||
|
||||
### Supported Blockchains and Tokens
|
||||
|
||||
#### KnownChainId
|
||||
|
||||
The `KnownChainId` namespace encapsulates types and utility functions to validate blockchain networks supported by the SDK. It ensures that only recognized chain IDs across Bitcoin, EVM-compatible chains, and Stacks are used.
|
||||
|
||||
| Namespace |Mainnet |Testnet |
|
||||
| ----------|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------- |
|
||||
| Bitcoin |`Mainnet` |`Testnet` |
|
||||
| Stacks |`Mainnet` |`Testnet` |
|
||||
| EVM |`Ethereum`, `BSC`, `CoreDAO`, `Bsquared`, `BOB`, `Bitlayer`, `Lorenzo`, `Merlin`, `AILayer`, `Mode`, `XLayer`, `Arbitrum`, `Aurora`, `Manta`, `Linea`|`Sepolia`, `BSCTestnet`, `CoreDAOTestnet`, `BisonTestnet`, `BitboyTestnet`, `BeraTestnet` |
|
||||
| Namespace | Mainnet | Testnet |
|
||||
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| Bitcoin | `Mainnet` | `Testnet` |
|
||||
| Stacks | `Mainnet` | `Testnet` |
|
||||
| EVM | `Ethereum`, `BSC`, `CoreDAO`, `Bsquared`, `BOB`, `Bitlayer`, `Lorenzo`, `Merlin`, `AILayer`, `Mode`, `XLayer`, `Arbitrum`, `Aurora`, `Manta`, `Linea` | `Sepolia`, `BSCTestnet`, `CoreDAOTestnet`, `BisonTestnet`, `BitboyTestnet`, `BeraTestnet` |
|
||||
|
||||
#### KnownTokenId
|
||||
|
||||
@@ -38,20 +43,20 @@ The `KnownTokenId` namespace manages the token IDs of supported cryptocurrencies
|
||||
|
||||
##### Namespaces
|
||||
|
||||
| Namespace |Tokens |
|
||||
| ----------|------------------------------------------------------------------------------------------------------------------- |
|
||||
| Bitcoin |`BTC` |
|
||||
| Stacks |`sUSDT`, `sLUNR`, `aBTC`, `ALEX`, `sSKO`, `vLiSTX`, `vLiALEX`, `uBTC`, `DB20`, `DOG` |
|
||||
| EVM |`USDT`, `LUNR`, `WBTC`, `BTCB`, `aBTC`, `sUSDT`, `ALEX`, `SKO`, `vLiSTX`, `vLiALEX`, `uBTC`, `wuBTC`, `DB20`, `DOG` |
|
||||
| Namespace | Tokens |
|
||||
| --------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| Bitcoin | `BTC` |
|
||||
| Stacks | `sUSDT`, `sLUNR`, `aBTC`, `ALEX`, `sSKO`, `vLiSTX`, `vLiALEX`, `uBTC`, `DB20`, `DOG` |
|
||||
| EVM | `USDT`, `LUNR`, `WBTC`, `BTCB`, `aBTC`, `sUSDT`, `ALEX`, `SKO`, `vLiSTX`, `vLiALEX`, `uBTC`, `wuBTC`, `DB20`, `DOG` |
|
||||
|
||||
|
||||
**Future Support**: Support for Runes and BR20 tokens on the Bitcoin network is planned for a future update.
|
||||
**Future Support**: Support for Runes and BR20 tokens on the Bitcoin network is planned for a future update.
|
||||
|
||||
### XLink SDK
|
||||
|
||||
The [`XLinkSDK`](/modules/XLinkSDK) object contains the most important functions of this library, all grouped together. To create it:
|
||||
|
||||
```typescript
|
||||
const theSdk = new XLinkSDK();
|
||||
const theSdk = new XLinkSDK()
|
||||
```
|
||||
|
||||
For detailed API documentation, including a full list of available methods and their usage, please refer to:
|
||||
@@ -60,25 +65,27 @@ For detailed API documentation, including a full list of available methods and t
|
||||
|
||||
### Use Cases
|
||||
|
||||
Create an instance of the SDK with default options
|
||||
Create an instance of the SDK with default options:
|
||||
|
||||
```typescript
|
||||
import { XLinkSDK } from '@xlink-network/xlink-sdk';
|
||||
const xlinkSdk = new XLinkSDK();
|
||||
import { XLinkSDK } from "@xlink-network/xlink-sdk"
|
||||
const xlinkSdk = new XLinkSDK()
|
||||
```
|
||||
|
||||
1. Bridge from Stacks
|
||||
#### Bridge from Stacks
|
||||
|
||||
```typescript
|
||||
import { serializeCVBytes } from '@stacks/transactions';
|
||||
import {
|
||||
BridgeInfoFromStacksInput,
|
||||
import {
|
||||
BridgeInfoFromStacksInput,
|
||||
BridgeFromStacksInput,
|
||||
KnownChainId,
|
||||
KnownTokenId,
|
||||
KnownTokenId,
|
||||
toSDKNumberOrUndefined,
|
||||
} from '@xlink-network/xlink-sdk';
|
||||
|
||||
// Get bridge info
|
||||
const bridgeInfo = await xlinkSdk.bridgeInfoFromStacks({
|
||||
const bridgeInfo = await xlinkSdk.bridgeInfoFromStacks({
|
||||
fromChain: KnownChainId.Stacks.Mainnet,
|
||||
fromToken: KnownTokenId.Stacks.sUSDT,
|
||||
toChain: KnownChainId.EVM.Ethereum,
|
||||
@@ -88,7 +95,7 @@ const bridgeInfo = await xlinkSdk.bridgeInfoFromStacks({
|
||||
console.log("Bridge Info:", bridgeInfo);
|
||||
|
||||
// Perform the bridge operation
|
||||
const result = await xlinkSdk.bridgeFromStacks({
|
||||
const result = await xlinkSdk.bridgeFromStacks({
|
||||
fromChain: KnownChainId.Stacks.Mainnet,
|
||||
fromToken: KnownTokenId.Stacks.sUSDT,
|
||||
toChain: KnownChainId.EVM.Ethereum,
|
||||
@@ -116,89 +123,97 @@ const result = await xlinkSdk.bridgeFromStacks({
|
||||
console.log("Transaction ID:", result.txid);
|
||||
```
|
||||
|
||||
2. Bridge from EVM
|
||||
#### Bridge from EVM
|
||||
|
||||
```typescript
|
||||
import {
|
||||
BridgeInfoFromEVMInput,
|
||||
BridgeFromEVMInput,
|
||||
KnownChainId,
|
||||
KnownTokenId,
|
||||
toSDKNumberOrUndefined,
|
||||
} from '@xlink-network/xlink-sdk';
|
||||
import {
|
||||
BridgeInfoFromEVMInput,
|
||||
BridgeFromEVMInput,
|
||||
KnownChainId,
|
||||
KnownTokenId,
|
||||
toSDKNumberOrUndefined,
|
||||
} from "@xlink-network/xlink-sdk"
|
||||
|
||||
// Get bridge info
|
||||
const bridgeInfo = await xlinkSdk.bridgeInfoFromEVM({
|
||||
fromChain: KnownChainId.EVM.Ethereum,
|
||||
fromToken: KnownTokenId.EVM.USDT,
|
||||
toChain: KnownChainId.Stacks.Mainnet,
|
||||
toToken: KnownTokenId.Stacks.sUSDT,
|
||||
amount: toSDKNumberOrUndefined(100),
|
||||
});
|
||||
console.log("Bridge Info:", bridgeInfo);
|
||||
fromChain: KnownChainId.EVM.Ethereum,
|
||||
fromToken: KnownTokenId.EVM.USDT,
|
||||
toChain: KnownChainId.Stacks.Mainnet,
|
||||
toToken: KnownTokenId.Stacks.sUSDT,
|
||||
amount: toSDKNumberOrUndefined(100),
|
||||
})
|
||||
console.log("Bridge Info:", bridgeInfo)
|
||||
|
||||
// Perform the bridge operation
|
||||
const result = await xlinkSdk.bridgeFromEVM({
|
||||
fromChain: KnownChainId.EVM.Ethereum,
|
||||
fromToken: KnownTokenId.EVM.USDT,
|
||||
fromAddress: "0x95222290DD7278Aa3D......................",
|
||||
toChain: KnownChainId.Stacks.Mainnet,
|
||||
toToken: KnownTokenId.Stacks.sUSDT,
|
||||
toAddress: "0x95222290DD7278Aa3D......................",
|
||||
amount: toSDKNumberOrUndefined(10),
|
||||
sendTransaction: async function (tx: {
|
||||
from: `0x${string}`;
|
||||
to: `0x${string}`;
|
||||
data: Uint8Array;
|
||||
recommendedGasLimit: `${string} (XLinkSDK number)`;
|
||||
}): Promise<{ txHash: string; }> {
|
||||
// Implementation for sending transaction from EVM chain
|
||||
return { txHash: "....." }
|
||||
}
|
||||
});
|
||||
console.log("Transaction ID:", result.txHash);
|
||||
fromChain: KnownChainId.EVM.Ethereum,
|
||||
fromToken: KnownTokenId.EVM.USDT,
|
||||
fromAddress: "0x95222290DD7278Aa3D......................",
|
||||
toChain: KnownChainId.Stacks.Mainnet,
|
||||
toToken: KnownTokenId.Stacks.sUSDT,
|
||||
toAddress: "0x95222290DD7278Aa3D......................",
|
||||
amount: toSDKNumberOrUndefined(10),
|
||||
sendTransaction: async function (tx: {
|
||||
from: `0x${string}`
|
||||
to: `0x${string}`
|
||||
data: Uint8Array
|
||||
recommendedGasLimit: `${string} (XLinkSDK number)`
|
||||
}): Promise<{ txHash: string }> {
|
||||
// Implementation for sending transaction from EVM chain
|
||||
return { txHash: "....." }
|
||||
},
|
||||
})
|
||||
console.log("Transaction ID:", result.txHash)
|
||||
```
|
||||
|
||||
3. Bridge from Bitcoin
|
||||
#### Bridge from Bitcoin
|
||||
|
||||
```typescript
|
||||
import {
|
||||
BridgeInfoFromBitcoinInput,
|
||||
BridgeFromBitcoinInput,
|
||||
KnownChainId,
|
||||
KnownTokenId,
|
||||
toSDKNumberOrUndefined,
|
||||
} from '@xlink-network/xlink-sdk';
|
||||
import {
|
||||
BridgeInfoFromBitcoinInput,
|
||||
BridgeFromBitcoinInput,
|
||||
KnownChainId,
|
||||
KnownTokenId,
|
||||
toSDKNumberOrUndefined,
|
||||
} from "@xlink-network/xlink-sdk"
|
||||
|
||||
// Get bridge info
|
||||
const bridgeInfo = await xlinkSdk.bridgeInfoFromBitcoin({
|
||||
fromChain: KnownChainId.Bitcoin.Mainnet,
|
||||
fromToken: KnownTokenId.Bitcoin.BTC,
|
||||
toChain: KnownChainId.EVM.Ethereum,
|
||||
toToken: KnownTokenId.EVM.BTCB,
|
||||
amount: toSDKNumberOrUndefined(1),
|
||||
});
|
||||
console.log("Bridge Info:", bridgeInfo);
|
||||
fromChain: KnownChainId.Bitcoin.Mainnet,
|
||||
fromToken: KnownTokenId.Bitcoin.BTC,
|
||||
toChain: KnownChainId.EVM.Ethereum,
|
||||
toToken: KnownTokenId.EVM.BTCB,
|
||||
amount: toSDKNumberOrUndefined(1),
|
||||
})
|
||||
console.log("Bridge Info:", bridgeInfo)
|
||||
|
||||
// Perform the bridge operation
|
||||
const result = await xlinkSdk.bridgeFromBitcoin({
|
||||
fromChain: KnownChainId.Bitcoin.Mainnet,
|
||||
fromToken: KnownTokenId.Bitcoin.BTC,
|
||||
fromAddress: "bitcoin address",
|
||||
toChain: KnownChainId.EVM.Ethereum,
|
||||
toToken: KnownTokenId.EVM.WBTC,
|
||||
toAddress: "0x...",
|
||||
fromAddressScriptPubKey: new Uint8Array([10, 20, 30, 40,]),
|
||||
amount: toSDKNumberOrUndefined(1),
|
||||
networkFeeRate: 10n,
|
||||
reselectSpendableUTXOs(satsToSend: bigint, pinnedUTXOs: UTXOSpendable[], lastTimeSelectedUTXOs: UTXOSpendable[]): Promise<UTXOSpendable[]> {
|
||||
return Promise.resolve([]);
|
||||
},
|
||||
signPsbt: function (tx: { psbt: Uint8Array; signInputs: number[]; }): Promise<{ psbt: Uint8Array }> {
|
||||
throw new Error("Function not implemented.");
|
||||
},
|
||||
sendTransaction: function (tx: { hex: string }): Promise<{ txid: string; }> {
|
||||
throw new Error("Function not implemented.");
|
||||
}
|
||||
|
||||
});
|
||||
console.log("Transaction ID:", result.tx);
|
||||
fromChain: KnownChainId.Bitcoin.Mainnet,
|
||||
fromToken: KnownTokenId.Bitcoin.BTC,
|
||||
fromAddress: "bitcoin address",
|
||||
toChain: KnownChainId.EVM.Ethereum,
|
||||
toToken: KnownTokenId.EVM.WBTC,
|
||||
toAddress: "0x...",
|
||||
fromAddressScriptPubKey: new Uint8Array([10, 20, 30, 40]),
|
||||
amount: toSDKNumberOrUndefined(1),
|
||||
networkFeeRate: 10n,
|
||||
reselectSpendableUTXOs(
|
||||
satsToSend: bigint,
|
||||
pinnedUTXOs: UTXOSpendable[],
|
||||
lastTimeSelectedUTXOs: UTXOSpendable[],
|
||||
): Promise<UTXOSpendable[]> {
|
||||
return Promise.resolve([])
|
||||
},
|
||||
signPsbt: function (tx: {
|
||||
psbt: Uint8Array
|
||||
signInputs: number[]
|
||||
}): Promise<{ psbt: Uint8Array }> {
|
||||
throw new Error("Function not implemented.")
|
||||
},
|
||||
sendTransaction: function (tx: { hex: string }): Promise<{ txid: string }> {
|
||||
throw new Error("Function not implemented.")
|
||||
},
|
||||
})
|
||||
console.log("Transaction ID:", result.tx)
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user