XchainJS

https://xchainjs.gitbook.io/xchainjs
Admin
XchainJS is a TypeScript library for cross-chain wallets, offering lightweight functionality to...
Tokens:74,785
Snippets:199
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Testing Setup

Source: https://xchainjs.gitbook.io/xchainjs/protocols/thorchain/xchain-thorchain-query/how-to-use

Installs project dependencies and runs tests for the xchain-thorchain-query library. This ensures the library functions as expected.

```bash
yarn install
yarn test
```

--------------------------------

### Install xchain-ethereum Package

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-evm/xchain-ethereum/how-to-use

Installs the xchain-ethereum client library using Yarn. This is the primary step to begin using the library in your project.

```bash
yarn add @xchainjs/xchain-ethereum
```

--------------------------------

### Example Server Script

Source: https://xchainjs.gitbook.io/xchainjs/installation

A basic example command to run a Node.js server script. This is often used in project setup or examples.

```bash
node server.js
```

--------------------------------

### Environment Setup and Testing

Source: https://xchainjs.gitbook.io/xchainjs/contributors

This section outlines the steps for setting up the development environment for xchainjs contributors. It includes cloning the repository, navigating to the directory, and running build and test commands.

```shell
git clone https://github.com/username/xchain-lib.git
```

```shell
cd xchain-lib
```

```shell
yarn
```

```shell
yarn build
```

```shell
yarn test
```

--------------------------------

### xchain-bsc Client Usage Example

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-evm/xchain-bsc/how-to-use

Demonstrates how to initialize and use the xchain-bsc client for connecting to the Binance Smart Chain. It covers setting up the client, getting an address, validating it, and fetching balances.

```javascript
import { Client, defaultBscParams, AssetBSC } from "@xchainjs/xchain-bsc"
import { FeeOption } from "@xchainjs/xchain-client"
import { assetToBase, baseToAsset, assetAmount, Asset, Chain  } from "@xchainjs/xchain-util"

// Create new Bsc Asset
const assetRIP: Asset = {
    chain: AssetBSC.chain,
    symbol: `RIP-0x224695ba2a98e4a096a519b503336e06d9116e48`,
    ticker: `RIP`,
    synth: false,
  }
// Create new Bsc Client Instance
const connectWallet =async () => {
    defaultBscParams.phrase = "phrase"
    const bscClient = new Client(defaultBscParams)
    let address = bscClient.getAddress()
    console.log(`Address: ${address}`)
    let isValid = bscClient.validateAddress(address)
    if( isValid === true ){
        try {
            const balance = await bscClient.getBalance(address)
            let assetAmount = (baseToAsset(balance[1].amount)).amount()
            console.log(`With balance: ${assetAmount}`)

        } catch (error) {
            console.log(`Caught: ${error}`)
        }
    }
}
```

--------------------------------

### Install xchain-doge

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-utxo/xchain-doge/how-to-use

Installs the @xchainjs/xchain-doge package using yarn.

```bash
yarn add @xchainjs/xchain-doge
```

--------------------------------

### Install Solana Client with NPM

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-solana/how-to-use

Installs the xchainjs-solana package using the NPM package manager. This command fetches and installs the necessary Solana client library.

```bash
npm install @xchainjs/xchain-solana
```

--------------------------------

### Install xchain-avax Package

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-evm/xchain-avax/how-to-use

Installs the xchain-avax library using Yarn. This is the primary step to begin using the Avalanche client in your project.

```bash
yarn add @xchainjs/xchain-avax
```

--------------------------------

### Run Tests for xchain-ethereum

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-evm/xchain-ethereum/how-to-use

Installs project dependencies and executes the test suite for the xchain-ethereum package. This is useful for verifying the library's integrity or contributing to its development.

```bash
yarn install
yarn test
```

--------------------------------

### Estimate Swap Example

Source: https://xchainjs.gitbook.io/xchainjs/protocols/thorchain/xchain-thorchain-query/estimate-a-swap

Provides a link to an example demonstrating how to estimate a swap using xchainjs. This example is hosted on CodeSandbox and showcases practical usage within the xchainjs-lib repository.

```link
https://codesandbox.io/p/devbox/github/xchainjs/xchainjs-lib/tree/master/examples/estimate-swap
```

--------------------------------

### Installation

Source: https://xchainjs.gitbook.io/xchainjs/protocols/thorchain/xchain-thorchain-query/how-to-use

Installs the xchain-thorchain-query package using yarn. This is the primary step to integrate the library into your project.

```bash
yarn add @xchainjs/xchain-thorchain-query
```

--------------------------------

### Install xchain-cosmos

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-cosmos-sdk/xchain-cosmos/how-to-use

Installs the xchain-cosmos package using Yarn. This is the primary step to begin using the library.

```bash
yarn add @xchainjs/xchain-cosmos
```

--------------------------------

### Install xchain-litecoin

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-utxo/xchain-litecoin/how-to-use

Installs the xchain-litecoin package using Yarn. This is the primary step to integrate Litecoin functionality into your project.

```bash
yarn add @xchainjs/xchain-litecoin
```

--------------------------------

### xchainjs Liquidity Examples

Source: https://xchainjs.gitbook.io/xchainjs/protocols/thorchain/xchain-thorchain-amm/handle-liquidity-and-savers

Provides access to example code for managing liquidity within the xchainjs library, specifically for the THORChain protocol. These examples demonstrate practical usage scenarios.

```Link
https://codesandbox.io/p/devbox/github/xchainjs/xchainjs-lib/tree/master/examples/liquidity
```

--------------------------------

### Install xchain-thornode

Source: https://xchainjs.gitbook.io/xchainjs/protocols/thorchain/xchain-thornode/how-to-use

Installs the xchain-thornode package using Yarn. This is the primary step to begin using the library.

```bash
yarn add @xchainjs/xchain-thornode
```

--------------------------------

### Install xchain-midgard-query

Source: https://xchainjs.gitbook.io/xchainjs/protocols/thorchain/xchain-midgard-query/how-to-use

Installs the @xchainjs/xchain-midgard-query package using Yarn. This is the primary step to include the library in your project.

```bash
yarn add @xchainjs/xchain-midgard-query
```

--------------------------------

### Install xchain-bsc with Yarn

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-evm/xchain-bsc/how-to-use

Instructions for installing the xchain-bsc package using Yarn. This is the first step to integrate BSC functionality into your project.

```shell
yarn add @xchainjs/xchain-bsc
```

--------------------------------

### Install xchain-crypto

Source: https://xchainjs.gitbook.io/xchainjs/others/xchain-crypto/how-to-use

Installs the @xchainjs/xchain-crypto package using Yarn. This is the primary step to integrate the library into your project.

```bash
yarn add @xchainjs/xchain-crypto
```

--------------------------------

### Install xchain-thorchain Package

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-cosmos-sdk/xchain-thorchain/how-to-use

Installs the xchain-thorchain package using Yarn. This is the first step to integrate Thorchain functionality into your project.

```bash
yarn add @xchainjs/xchain-thorchain
```

--------------------------------

### Install xchain-mayachain Package

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-cosmos-sdk/xchain-mayachain/how-to-use

Installs the xchain-mayachain package using Yarn. This is the primary step to include the library in your project.

```bash
yarn add @xchainjs/xchain-mayachain
```

--------------------------------

### Get Solana Token Balance Example

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-solana/examples/get-token-balance

Demonstrates how to retrieve the balance of a specific token for a given address on the Solana network. This example utilizes the xchainjs-lib for Solana integration.

```typescript
import { SolanaClient } from '@xchainjs/xchain-solana'

// Assuming you have initialized the SolanaClient
const solanaClient = new SolanaClient({ 
  network: 'mainnet' // or 'testnet'
});

async function getTokenBalance(address: string, tokenAddress: string) {
  try {
    const balance = await solanaClient.getTokenBalance({ 
      address: address,
      tokenAddress: tokenAddress
    });
    console.log(`Token balance for ${address} (${tokenAddress}): ${balance.amount}`);
    return balance;
  } catch (error) {
    console.error('Error fetching token balance:', error);
    throw error;
  }
}

// Example usage:
// const userAddress = 'YOUR_SOLANA_ADDRESS';
// const tokenContractAddress = 'YOUR_TOKEN_ADDRESS';
// getTokenBalance(userAddress, tokenContractAddress);
```

--------------------------------

### Install xchain-thorchain-amm

Source: https://xchainjs.gitbook.io/xchainjs/protocols/thorchain/xchain-thorchain-amm/how-to-use

Installs the xchain-thorchain-amm library using Yarn. This is the primary step to begin using the library for THORChain interactions.

```bash
yarn add @xchainjs/xchain-thorchain-amm
```

--------------------------------

### Install xchain-bitcoin Client

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-utxo/xchain-bitcoin/how-to-use

Installs the xchain-bitcoin package using Yarn. This is the primary step to begin using the Bitcoin client library.

```bash
yarn add @xchainjs/xchain-bitcoin
```

--------------------------------

### Project Setup and Testing

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-binance/how-to-use

Commands to set up the project dependencies and run tests for the xchain-binance library. Ensures the development environment is correctly configured.

```bash
yarn install
yarn test
```

--------------------------------

### THORChain Swap Example

Source: https://xchainjs.gitbook.io/xchainjs/protocols/thorchain/xchain-thorchain-amm/how-to-use

Demonstrates how to perform a cross-chain swap using the xchain-thorchain-amm library. It includes setting up a wallet, estimating swap parameters, and executing the swap, along with handling potential errors. This example shows a swap from BUSD to RUNE.

```typescript
// Imports
import { AssetRuneNative, } from '@xchainjs/xchain-util'
import { assetAmount, assetFromString, assetToBase, Chain  } from '@xchainjs/xchain-util'
import { CryptoAmount, EstimateSwapParams, Wallet, Midgard, SwapEstimate, ThorchainAMM } from '@xchainjs/xchain-thorchain-amm'
import BigNumber from 'bignumber.js'

// Swap from BUSD to RUNE
const doSwap = async () => {
  let phrase = "phrase"
  const mainnetWallet = new Wallet(Network.Mainnet, phrase|| 'you forgot to set the phrase')
  const swapParams = {
    input: new CryptoAmount(assetToBase(assetAmount(1)), BUSD), // Assuming BUSD is defined elsewhere
    destinationAsset: AssetRuneNative,
    destinationAddress: mainnetWallet.clients[Chain.THORChain].getAddress(),
    slipLimit: new BigNumber(0.03),
  }
  try {
    // Assuming thorchainQueryMainnet and mainetThorchainAmm are initialized elsewhere
    const outPutCanSwap = await thorchainQueryMainnet.estimateSwap(swapParams)
    print(outPutCanSwap)
    if (outPutCanSwap.txEstimate.canSwap) {
      const output = await mainetThorchainAmm.doSwap(mainnetWallet, swapParams)
      console.log(`Tx hash: ${output.hash},
 Tx url: ${output.url}
 WaitTime: ${output.waitTimeSeconds}`)
      expect(output).toBeTruthy()
    }
  } catch (error: any) {
    console.log(error.message)
  }
}

```

```typescript
// Outputs from estimateSwap and doSwap
{
  memo: '=:THOR.RUNE:xxx:53281999',
  expiry: '2022-09-22T13:14:10.941Z',
  toAddress: 'bnb13fjncau2d3sw9nrvtpg67mh80gulu25v5msznc',
  txEstimate: {
    input: '$ 1',
    totalFees: {
      inboundFee: 'ᚱ 0.01863509',
      swapFee: 'ᚱ 0.00000008',
      outboundFee: 'ᚱ 0.06',
      affiliateFee: 'ᚱ 0'
    },
    slipPercentage: '0.00000012685928643813',
    netOutput: 'ᚱ 0.53281571',
    netOutputDecimals: 8,
    waitTimeSeconds: '12',
    canSwap: true,
    errors: []
  }
}
Tx hash: "Hash will be here",
Tx url: "URL will be here"

```

--------------------------------

### Run Bitcoin Client Tests

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-utxo/xchain-bitcoin/how-to-use

Installs project dependencies and runs the test suite for the xchain-bitcoin client. Ensures the library is functioning correctly.

```bash
yarn install
yarn test
```

--------------------------------

### Get Ethereum Explorer URLs

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-evm/xchain-ethereum/how-to-use

Retrieves the Etherscan interface and generates explorer URLs for a given Ethereum address and transaction hash. Requires an initialized Ethereum client.

```javascript
const explorerUrl = async () => {
    let phrase = "phrase"
    const ethClient = new Client({phrase})
    let address = ethClient.getAddress()
    let hash = "0xa4707105d861fab959421203ef299d6ca5131067e58812062b2aa94494047f06"
    try {
        const etherscanInterface = ethClient.getEtherscanProvider() // returns the current etherjs etherscan interface
        console.log(etherscanInterface)
        const explorerAddressUrl = ethClient.getExplorerAddressUrl(address)
        console.log(`Etherscan url: ${explorerAddressUrl} for address: ${address} `)
        const explorerTxUrl = ethClient.getExplorerTxUrl(hash)
        console.log(`Explorer url: ${explorerTxUrl} for tx id:${hash}  `)
    } catch (error) {
        console.log(`Caught error: ${error}`)
    }
}
```

--------------------------------

### Test xchain-doge Package

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-utxo/xchain-doge/how-to-use

Installs dependencies and runs tests for the xchain-doge package.

```bash
yarn install
yarn test
```

--------------------------------

### Get Ethereum Transaction History by Address

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-evm/xchain-ethereum/how-to-use

Retrieves the transaction history for a given Ethereum address. It returns the total transaction count and a list of transaction hashes. Requires an address and an initialized Ethereum client.

```javascript
const transactionHistory = async () => {
    let phrase = "phrase"
    const ethClient = new Client({ phrase})
    let Address = ethClient.getAddress()
    try {
        const txHistory = await ethClient.getTransactions({address: Address})
        console.log(`Found ${txHistory.total.toString()}`)
        txHistory.txs.forEach(tx => console.log(tx.hash))
    } catch (error) {
        console.log(`Caught: ${error} `)
    }
}
```

--------------------------------

### Test xchain-litecoin

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-utxo/xchain-litecoin/how-to-use

Installs project dependencies and runs tests for the xchain-litecoin library. This ensures the library is functioning correctly in your environment.

```bash
yarn install
yarn test
```

--------------------------------

### Get Ethereum Transaction Data by Hash

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-evm/xchain-ethereum/how-to-use

Retrieves detailed transaction data for a specific transaction hash on the Ethereum network using the xchainjs client. Requires a valid transaction hash and an initialized Ethereum client.

```javascript
const transactionData = async () => {
    let phrase = "phrase"
    const ethClient = new Client({phrase})
    let hash = "insert hash"
    try {
        const txData = await ethClient.getTransactionData(hash)
        console.log(`Transaction data ${JSON.stringify(txData)}`)
    } catch (error) {
        console.log(`Caught: ${error} `)
    }
}
```

--------------------------------

### Get Current Network Fees

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-binance/how-to-use

Retrieves the current network fees for transactions. The Binance Chain client provides fixed fees, and the 'average', 'fast', and 'fastest' values are typically the same. The example logs these fee values after converting them to a user-friendly asset amount.

```javascript
try {
    const fee = await bncClient.getFees()
    console.log(`Fees average:  ${baseToAsset(fee.average).amount()}`)
    console.log(`Fees fast:  ${baseToAsset(fee.fast).amount()}`)
    console.log(`Fees fastest:  ${baseToAsset(fee.fastest).amount()}`)

} catch (error) {
    console.log(error)
}
```

--------------------------------

### Get Transaction History

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-utxo/xchain-bitcoin/how-to-use

Retrieves a history of transactions associated with a given Bitcoin address. The `getTransactions` method allows for filtering results using parameters like `offset`, `limit`, `startTime`, and `asset`. The example demonstrates fetching the first 4 transactions and logging the total count and transaction hashes.

```javascript
const transactionHistory = async () => {
    let phrase = "phrase"
    let btcClient = new Client({phrase })
    let Address = keystore1Address

    try {
        const txHistory = await btcClient.getTransactions({ address: Address, limit: 4 })
        console.log(`Found ${txHistory.total.toString()}`)
        txHistory.txs.forEach(tx => console.log(tx.hash))

    } catch (error) {
            console.log(`Error: ${error}`)
    }
}
```

--------------------------------

### Get AVAX Transaction Fees

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-evm/xchain-avax/how-to-use

Demonstrates how to retrieve estimated transaction fees (fast, fastest, average) for AVAX transfers using the xchainjs client. It requires setting up the client with default parameters and transaction details like asset, amount, and recipient. The output logs the fee amounts converted back to a readable format.

```typescript
const returnFees = async () => {
    defaultAvaxParams.phrase = "phrase"
    const avaxClient = new Client(defaultAvaxParams)
    let amountToTransfer = 20
    let amount = assetToBase(assetAmount(amountToTransfer, 18))
    let recipient = "recipient"
    try {
        const txParams: TxParams = {
            walletIndex: 0,
            asset: assetRIP,
            amount: amount,
            recipient: recipient,
        }
        const {fast, fastest, average} = await avaxClient.getFees(txParams)
        console.log(`Fees Fast: ${baseToAsset(fast).amount()} Fastest: ${baseToAsset(fastest).amount()} Average: ${baseToAsset(average).amount()}`)
    } catch (error) {
        console.log(`Caught: ${error}`)
    }
}
```

--------------------------------

### Install Solana Client with Yarn

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-solana/how-to-use

Installs the xchainjs-solana package using the Yarn package manager. This is the first step to integrate Solana functionality into your project.

```bash
yarn add @xchainjs/xchain-solana
```

--------------------------------

### Install xchain-binance Package

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-binance/how-to-use

Installs the xchain-binance client library using Yarn. This is the primary step to begin using the library in your project.

```bash
yarn add @xchainjs/xchain-binance
```

--------------------------------

### Get AVAX Transaction Data and History

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-evm/xchain-avax/how-to-use

Shows how to fetch detailed data for a specific AVAX transaction using its hash and how to retrieve a history of transactions associated with an AVAX address. It involves initializing the xchainjs client and calling getTransactionData or getTransactions with appropriate parameters. The output logs transaction details or the total count and hashes of transactions.

```typescript
const transactionData = async () => {
    defaultAvaxParams.phrase = "phrase"
    const avaxClient = new Client(defaultAvaxParams)
    let hash = "0x60721cf788b7cd4e56acf6479e71dfbd12e6c79c15e76595e4e52409bf686d4c"

    try {
        const txData = await avaxClient.getTransactionData(hash)
        console.log(`From ${JSON.stringify(txData)}`)
    } catch (error) {
        console.log(`Caught: ${error}`)
    }
}
// Address History
const transactionHistory = async () => {
    defaultAvaxParams.phrase = "phrase"
    const avaxClient = new Client(defaultAvaxParams)
    let Address = avaxClient.getAddress()

    try {
        const txHistory = await avaxClient.getTransactions({address: Address, limit: 4 })
        console.log(`Found ${txHistory.total.toString()}`)
        txHistory.txs.forEach(tx => console.log(tx.hash))
    } catch (error) {
        console.log(`Caught: ${error}`)
    }
}
```

--------------------------------

### Test BitcoinCash Client

Source: https://xchainjs.gitbook.io/xchainjs/clients/xchain-utxo/xchain-bitcoincash/how-to-use

Installs project dependencies and executes the test suite for the BitcoinCash client. This ensures the client is functioning correctly.

```bash
yarn install
yarn test
```

--------------------------------

### Build and Test xchain-crypto

Source: https://xchainjs.gitbook.io/xchainjs/others/xchain-crypto/how-to-use

Commands for building the project and running tests for the xchain-crypto library. These are essential for development and verification.

```bash
yarn build
yarn test
```

--------------------------------

### XchainJS Wallet Example

Source: https://xchainjs.gitbook.io/xchainjs/wallet

A live example demonstrating the usage of the XchainJS Wallet class, showcasing how to group and interact with multiple clients.

```javascript
// This snippet points to an external live example.
// For the actual code, please visit the provided link.
// Example Usage:
// https://codesandbox.io/p/devbox/github/xchainjs/xchainjs-lib/tree/master/examples/wallet
```
Tokens:
Raw