Class Ramps

constructor

• new Ramps(wallet: IWallet): Ramps

  Create convenience wrappers for onboarding and offboarding flows.

  Parameters

  • wallet: IWallet

    Wallet used to query funds and execute settlement transactions

  Returns Ramps

Readonlywallet

offboard

• offboard(
      destinationAddress: string,
      feeInfo: FeeInfo,
      amount?: bigint,
      eventCallback?: (event: SettlementEvent) => void,
  ): Promise<string>

  Offboard virtual outputs, or collaboratively exit them to an onchain address.

  Parameters

  • destinationAddress: string

    The destination address to offboard to.

  • feeInfo: FeeInfo

    The fee info to deduct from the offboard amount.

  • Optionalamount: bigint

    The amount to offboard. If not provided, the total amount of virtual outputs will be offboarded.

  • OptionaleventCallback: (event: SettlementEvent) => void

    Optional callback that receives settlement events

  Returns Promise<string>

  The Arkade transaction id created by settlement

  Throws

  Error if no virtual outputs remain after fee deduction or the destination address cannot be decoded

  See

  • IWallet.getVtxos
  • IWallet.settle

  Example

  const feeInfo = { intentFee: {}, txFeeRate: '1' };
  const ramps = new Ramps(wallet);
  await ramps.offboard('bc1q...', feeInfo);
  Copy

onboard

• onboard(
      feeInfo: FeeInfo,
      boardingUtxos?: ExtendedCoin[],
      amount?: bigint,
      eventCallback?: (event: SettlementEvent) => void,
  ): Promise<string>

  Onboard boarding inputs.

  Parameters

  • feeInfo: FeeInfo

    The fee info to deduct from the onboard amount.

  • OptionalboardingUtxos: ExtendedCoin[]

    Specific boarding inputs to onboard. If not provided, all boarding inputs will be used.

  • Optionalamount: bigint

    Amount to onboard. If not provided, the total amount of boarding inputs will be onboarded.

  • OptionaleventCallback: (event: SettlementEvent) => void

    Optional callback that receives settlement events

  Returns Promise<string>

  The Arkade transaction id created by settlement

  Throws

  Error if no boarding inputs remain after fee deduction or if amount exceeds available value

  See

  • IWallet.getBoardingUtxos
  • IWallet.settle

  Example

  const feeInfo = { intentFee: {}, txFeeRate: '1' };
  const ramps = new Ramps(wallet);
  await ramps.onboard(feeInfo);
  Copy