Quickstart

Install the SDKCopy Anchor Link

npm install @xebra/sdk

The SDK needs Node 20 or later, or any runtime with fetch. No API key is needed.

Price the transferCopy Anchor Link

import { createXebraClient } from "@xebra/sdk";

const xebra = createXebraClient();

const quote = await xebra.quote({ from: "stellar", to: "base", amount: "25" });
console.log(`${quote.recipientGets} USDC arrives; fees ${quote.fees.total} USDC`);

Amounts are decimal strings of USDC with at most six places ("25", "12.5"), never numbers. Fees come out of the amount: the recipient gets amount minus fees.total. A quote is good until expiresAt, then ask again. See Fees for what each part pays for.

Build the transferCopy Anchor Link

const { steps } = await xebra.createTransfer({
  from: "stellar",
  to: "base",
  amount: "25",
  sender: "GABC...", // the Stellar account that signs and pays
  recipient: "0x1234...", // who receives on Base
  maxTotalFee: quote.fees.total, // refuse if fees rose since the quote
});

for (const step of steps) {
  console.log(step.id, step.description);
}

steps is the list of transactions to sign, in order. From Stellar it is one step, burn, whose tx is a Stellar transaction (tx.kind === "stellar", base64 XDR plus the network passphrase). From an EVM chain there can be an approve step before the burn. Nothing has been signed or sent.

Sign and submitCopy Anchor Link

Hand each step's tx to the user's wallet, in order, and submit it. With Freighter on Stellar:

import { signTransaction } from "@stellar/freighter-api";
import { TransactionBuilder, rpc } from "@stellar/stellar-sdk";

const step = steps[0];
if (step.tx.kind !== "stellar") throw new Error("expected a Stellar transaction");

const { signedTxXdr } = await signTransaction(step.tx.xdr, {
  networkPassphrase: step.tx.networkPassphrase,
});
const server = new rpc.Server("https://your-soroban-rpc.example");
const sent = await server.sendTransaction(
  TransactionBuilder.fromXDR(signedTxXdr, step.tx.networkPassphrase),
);
const burnHash = sent.hash; // 64 hex characters

Submit before the step's expiresAt. After that, build the transfer again. Wallet integration covers LOBSTR, EVM wallets and Sui wallets.

Follow the burnCopy Anchor Link

const status = await xebra.waitForDelivery("stellar", burnHash);

if (status.state === "delivered") {
  console.log("Delivered in", status.deliveryTx);
} else {
  // needs_claim or failed: the recipient can finish it at status.claimUrl
  console.log(status.state, status.reason, status.claimUrl);
}

waitForDelivery asks every 5 seconds, for up to 30 minutes, until the transfer is delivered, needs a claim, or failed. To check once, call xebra.getTransfer("stellar", burnHash). Track a transfer explains each state.