Your first onboarding

A complete, zero-touch receive on testnet. We’ll onboard an account into EURCV using the default mechanism — a claimable balance — so the user needs no XLM and no prior trustline.

The shape of the flow

1. Detect

Ask whether the account can already receive the asset. If it has an authorized trustline, you’re done — no onboarding needed.

import { onboarder } from "./onboarder";

const asset = { code: "EURCV", issuer: "GBAD…7QFD" };

const state = await onboarder.detect({ account, asset });
// { hasTrustline: false, authorized: false }

2. Build the transaction

One call assembles the operations for the chosen mechanism — the change-trust, the claim, and the begin/end sponsoring sandwich — and returns an unsigned plan.

const plan = await onboarder.buildOnboardingTx({
  account,
  asset,
  mechanism: "claimable",
});

console.log(plan.mechanism); // "claimable"
console.log(plan.xdr);       // base64 transaction envelope

3. Sign once

The user signs the envelope in their wallet. The sponsor’s signature for the reserve is collected by the SDK, and — for a regulated asset — the approval server adds the issuer authorization. The user sees a single prompt.

const signed = await wallet.sign(plan.xdr);

4. Settle and verify

Submit the signed transaction, then confirm the balance landed and is usable.

const result = await onboarder.submit(signed);
// { hash: "…", balance: "100.00", asset: "EURCV" }

const ok = await onboarder.verifyActivation({ account, asset });
// true — authorized trustline, claim settled