C-Address Onboarding Bridge SDK - v0.1.0

Fileoverview

C-Address Onboarding Bridge SDK — public entry point.

This package provides a TypeScript/JavaScript SDK for the Onboarding Bridge Soroban smart contract on Stellar. It handles transaction building, signing, submission, and automatic retries so callers only need to supply their Keypair and intent.

Quick start

import { OnboardingBridgeSDK, OffRampIntegration } from '@stellar/c-address-onboarding-bridge-sdk';
import { Keypair, Networks } from '@stellar/stellar-sdk';

const sdk = new OnboardingBridgeSDK({
  contractId: 'CA...',
  rpcUrl: 'https://soroban-testnet.stellar.org',
  networkPassphrase: Networks.TESTNET,
});

const result = await sdk.fundCAddress(
  { source: keypair.publicKey(), target: 'CC...', asset: 'CD...', amount: '1000000' },
  keypair,
);
Copy

Exports

All types are also re-exported; import them directly:

import type { BridgeConfig, FundCOptions, TransactionResult } from '@stellar/c-address-onboarding-bridge-sdk';
Copy