Class Ramps

constructor

• new Ramps(wallet: IWallet): Ramps

  Parameters

  • wallet: IWallet

  Returns Ramps

Readonlywallet

offboard

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

  Offboard vtxos, or "collaborative exit" vtxos to 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 vtxos will be offboarded.

  • OptionaleventCallback: (event: SettlementEvent) => void

    The callback to receive settlement events. optional.

  Returns Promise<string>

onboard

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

  Onboard boarding utxos.

  Parameters

  • feeInfo: FeeInfo

    The fee info to deduct from the onboard amount.

  • OptionalboardingUtxos: ExtendedCoin[]

    The boarding utxos to onboard. If not provided, all boarding utxos will be used.

  • Optionalamount: bigint

    The amount to onboard. If not provided, the total amount of boarding utxos will be onboarded.

  • OptionaleventCallback: (event: SettlementEvent) => void

    The callback to receive settlement events. optional.

  Returns Promise<string>