CrossFi is a blockchain platform built to enable seamless cross-chain asset transfers and decentralized finance (DeFi) applications. With a focus on interoperability, security, and scalability, CrossFi provides developers and users with a powerful ecosystem for deploying decentralized applications (dApps) that can operate across multiple blockchain networks.

The CrossFi API facilitates interaction with the CrossFi network through a collection of JSON-RPC methods. Given its developer-friendly design, those familiar with Ethereum's JSON-RPC APIs will find working with CrossFi intuitive and straightforward.

Send Your First Request on Alchemy

Let's use the viem package to create a CrossFi client connected to Alchemy and fetch the latest block number!

npm install --save viem

Create Client Connected to Alchemy

import { createPublicClient, http, defineChain } from "viem";
 
const crossfi = defineChain({
  id: 4158,
  name: "CrossFi",
  nativeCurrency: { name: "XFI", symbol: "XFI", decimals: 18 },
  rpcUrls: {
    default: { http: ["https://crossfi-mainnet.g.alchemy.com/v2/YOUR_ALCHEMY_API_KEY"] },
  },
});
 
const client = createPublicClient({
  chain: crossfi,
  transport: http("https://crossfi-mainnet.g.alchemy.com/v2/YOUR_ALCHEMY_API_KEY"),
});

Now that you've created a client connected to Alchemy, you can continue with some basics:

Get Latest Block Number

const blockNumber = await client.getBlockNumber();
console.log("Current block number:", blockNumber);

Get an Address Balance

const balance = await client.getBalance({ address: "0xab5801a7d398351b8be11c439e05c5b3259aec9b" });
console.log("Balance (XFI):", Number(balance) / 1e18);

Read Block Data

const block = await client.getBlock({
  blockNumber: blockNumber, // from previous example
});
console.log(block);

Fetch a Transaction by Hash

const tx = await client.getTransaction({ hash: "0xYOUR_TX_HASH" });
console.log(tx);

Fetch Transaction Receipt

const receipt = await client.getTransactionReceipt({
  hash: "0xYOUR_TX_HASH"
});
console.log(receipt);

CrossFi APIs

For the full list of CrossFi APIs, see the CrossFi API Endpoints.