Class OnchainWallet

Readonlynetwork

ReadonlyonchainP2TR

Readonlyprovider

StaticMIN_FEE_RATE

address

• get address(): string

  Returns string

bumpAnchor

• bumpAnchor(parentHex: string, feeRate: number): Promise<[string, string]>

  Build and sign a CPFP fee child for a parent tx (given as raw hex) carrying a P2A anchor, funding it from this wallet's confirmed coins, and return the 1P1C package hexes WITHOUT broadcasting.

  This is the graph-mode fee source (ExitFeeWallet): the exit executor calls it to bump each transported virtual tx at execution time, so funding can be deferred rather than pre-signed.

  Parameters

  • parentHex: string

    Finalized parent transaction, raw network hex

  • feeRate: number

    sat/vB floor for the package (raised to MIN_FEE_RATE)

  Returns Promise<[string, string]>

  Tuple of parent hex (unchanged) and signed child hex

  Throws

  If the parent has no anchor, or funding cannot be selected/signed

bumpP2A

• bumpP2A(parent: Transaction): Promise<[string, string]>

  CPFP-bump a parent transaction that contains a pay-to-anchor output.

  Parameters

  • parent: Transaction

    Parent transaction containing a pay-to-anchor output

  Returns Promise<[string, string]>

  Tuple of parent transaction id and child transaction id

  Throws

  Error if the parent transaction has no pay-to-anchor output or bumping cannot be funded

  See

  send

getBalance

• getBalance(): Promise<number>

  Return the wallet's total onchain balance in satoshis.

  Returns Promise<number>

  Confirmed plus unconfirmed onchain balance

  See

  getCoins

getCoins

• getCoins(): Promise<Coin[]>

  Fetch spendable onchain outputs for the wallet address.

  Returns Promise<Coin[]>

  Spendable onchain outputs for the wallet address

  See

  getBalance

send

• send(params: SendBitcoinParams): Promise<string>

  Send bitcoin to a single onchain address.

  Parameters

  • params: SendBitcoinParams

    destination address, amount (in satoshis), and optional feeRate override (other fields ignored)

  Returns Promise<string>

  Broadcast transaction id

  Throws

  Error if the amount is non-positive, below dust, or cannot be funded

  See

  SendBitcoinParams

Staticcreate

• create(
      identity: Identity,
      networkName?: NetworkName,
      provider?: OnchainProvider,
  ): Promise<OnchainWallet>

  Create an onchain wallet for the given identity and Bitcoin network.

  Parameters

  • identity: Identity

    Identity used to derive the Taproot key and sign transactions

  • networkName: NetworkName = DEFAULT_NETWORK_NAME

    Bitcoin network name,

  • Optionalprovider: OnchainProvider

    Optional onchain provider override,

  Returns Promise<OnchainWallet>

  Configured onchain wallet

  See

  • NetworkName
  • OnchainProvider

  Throws

  Error if the configured identity cannot produce a valid x-only public key