/** * barkd REST API * A simple REST API for barkd, a wallet daemon for integrating bitcoin payments into your app over HTTP. Supports self-custodial Lightning, Ark, and on-chain out of the box. barkd is a long-running daemon best suited for always-on or high-connectivity environments like nodes, servers, desktops, and point-of-sale terminals. All endpoints return JSON. Amounts are denominated in satoshis. * * The version of the OpenAPI document: 0.6.1 * Contact: hello@second.tech * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { FeeEstimateResponse, OffboardFeeEstimateRequest, OnchainFeeRatesResponse } from '../models/index'; export interface BoardFeeRequest { amountSat: number; } export interface LightningReceiveFeeRequest { amountSat: number; } export interface LightningSendFeeRequest { amountSat: number; } export interface OffboardAllFeeRequest { address: string; } export interface OffboardFeeRequest { offboardFeeEstimateRequest: OffboardFeeEstimateRequest; } export interface SendOnchainFeeRequest { amountSat: number; address: string; } /** * */ export declare class FeesApi extends runtime.BaseAPI { /** * Creates request options for boardFee without sending the request */ boardFeeRequestOpts(requestParameters: BoardFeeRequest): Promise; /** * Estimates the Ark protocol fee for boarding the specified amount of on-chain bitcoin. The net amount is what the user receives as a VTXO. Does not include the on-chain transaction fee for the board anchor transaction. * Estimate board fee */ boardFeeRaw(requestParameters: BoardFeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Estimates the Ark protocol fee for boarding the specified amount of on-chain bitcoin. The net amount is what the user receives as a VTXO. Does not include the on-chain transaction fee for the board anchor transaction. * Estimate board fee */ boardFee(requestParameters: BoardFeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for lightningReceiveFee without sending the request */ lightningReceiveFeeRequestOpts(requestParameters: LightningReceiveFeeRequest): Promise; /** * Estimates the fee for receiving the specified amount over Lightning. The gross amount is the Lightning payment amount, and the net amount is what the user receives as a VTXO after the Ark server deducts its fee. * Estimate Lightning receive fee */ lightningReceiveFeeRaw(requestParameters: LightningReceiveFeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Estimates the fee for receiving the specified amount over Lightning. The gross amount is the Lightning payment amount, and the net amount is what the user receives as a VTXO after the Ark server deducts its fee. * Estimate Lightning receive fee */ lightningReceiveFee(requestParameters: LightningReceiveFeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for lightningSendFee without sending the request */ lightningSendFeeRequestOpts(requestParameters: LightningSendFeeRequest): Promise; /** * Estimates the fee for sending the specified amount over Lightning. The net amount is what the recipient receives. The fee depends on the VTXOs selected and their expiry. If the wallet has insufficient funds, returns a worst-case fee estimate assuming the user acquires enough funds to cover the payment. * Estimate Lightning send fee */ lightningSendFeeRaw(requestParameters: LightningSendFeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Estimates the fee for sending the specified amount over Lightning. The net amount is what the recipient receives. The fee depends on the VTXOs selected and their expiry. If the wallet has insufficient funds, returns a worst-case fee estimate assuming the user acquires enough funds to cover the payment. * Estimate Lightning send fee */ lightningSendFee(requestParameters: LightningSendFeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for offboardAllFee without sending the request */ offboardAllFeeRequestOpts(requestParameters: OffboardAllFeeRequest): Promise; /** * Estimates the fee for offboarding the entire Ark balance to the given on-chain address. The gross amount is the total spendable balance, and the net amount is what the user receives on-chain after fees. The fee depends on the destination address type, current fee rates, and VTXO expiry. * Estimate offboard-all fee */ offboardAllFeeRaw(requestParameters: OffboardAllFeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Estimates the fee for offboarding the entire Ark balance to the given on-chain address. The gross amount is the total spendable balance, and the net amount is what the user receives on-chain after fees. The fee depends on the destination address type, current fee rates, and VTXO expiry. * Estimate offboard-all fee */ offboardAllFee(requestParameters: OffboardAllFeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for offboardFee without sending the request */ offboardFeeRequestOpts(requestParameters: OffboardFeeRequest): Promise; /** * Estimates the fee for offboarding a specific set of VTXOs to the given on-chain address. Each VTXO is offboarded in full. The gross amount is the total value of the selected VTXOs, and the net amount is what the user receives on-chain after fees. The fee depends on the destination address type, current fee rates, and VTXO expiry. * Estimate offboard fee */ offboardFeeRaw(requestParameters: OffboardFeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Estimates the fee for offboarding a specific set of VTXOs to the given on-chain address. Each VTXO is offboarded in full. The gross amount is the total value of the selected VTXOs, and the net amount is what the user receives on-chain after fees. The fee depends on the destination address type, current fee rates, and VTXO expiry. * Estimate offboard fee */ offboardFee(requestParameters: OffboardFeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for onchainFeeRates without sending the request */ onchainFeeRatesRequestOpts(): Promise; /** * Returns the current mempool fee rates from the chain source at three confirmation targets: fast (~1 block), regular (~3 blocks), and slow (~6 blocks). Rates are in sat/vB, rounded up. * Get on-chain fee rates */ onchainFeeRatesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the current mempool fee rates from the chain source at three confirmation targets: fast (~1 block), regular (~3 blocks), and slow (~6 blocks). Rates are in sat/vB, rounded up. * Get on-chain fee rates */ onchainFeeRates(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for sendOnchainFee without sending the request */ sendOnchainFeeRequestOpts(requestParameters: SendOnchainFeeRequest): Promise; /** * Estimates the total fee for sending bitcoin from the Ark wallet to an on-chain address. The fee depends on the destination address type and current fee rates. The gross amount is what the user pays (including VTXOs spent), and the net amount is what the recipient receives on-chain. * Estimate send-onchain fee */ sendOnchainFeeRaw(requestParameters: SendOnchainFeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Estimates the total fee for sending bitcoin from the Ark wallet to an on-chain address. The fee depends on the destination address type and current fee rates. The gross amount is what the user pays (including VTXOs spent), and the net amount is what the recipient receives on-chain. * Estimate send-onchain fee */ sendOnchainFee(requestParameters: SendOnchainFeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }