lwk_node 0.12.1 → 0.13.1

package/lwk_wasm.d.ts

@@ -1,5 +1,14 @@
 /* tslint:disable */
 /* eslint-disable */
+/**
+ * Convert the given string to a QR code image uri
+ *
+ * The image format is monocromatic bitmap, returned as an encoded in base64 uri.
+ *
+ * Without `pixel_per_module` the default is no border, and 1 pixel per module, to be used
+ * for example in html: `style="image-rendering: pixelated; border: 20px solid white;"`
+ */
+export function stringToQr(str: string, pixel_per_module?: number | null): string;
 export function searchLedgerDevice(): Promise<HIDDevice>;
 /**
  * Wallet chain
@@ -20,6 +29,7 @@ export enum Chain {
  */
 export class Address {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates an `Address`
    *
@@ -74,6 +84,7 @@ export class Address {
 export class AddressResult {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Return the address.
    */
@@ -108,6 +119,7 @@ export class AddressResult {
 export class Amp0 {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Create a new AMP0 context for the specified network
    */
@@ -150,6 +162,7 @@ export class Amp0 {
  */
 export class Amp0Connected {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Connect and register to AMP0
    */
@@ -174,6 +187,7 @@ export class Amp0Connected {
 export class Amp0LoggedIn {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * List of AMP IDs.
    */
@@ -207,6 +221,7 @@ export class Amp0LoggedIn {
  */
 export class Amp0Pset {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a `Amp0Pset`
    */
@@ -223,6 +238,7 @@ export class Amp0Pset {
 export class Amp0SignerData {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
 }
 /**
  * Context for actions interacting with Asset Management Platform version 2
@@ -230,6 +246,7 @@ export class Amp0SignerData {
 export class Amp2 {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Create a new AMP2 client with the default url and server key for the testnet network.
    */
@@ -253,6 +270,7 @@ export class Amp2 {
 export class Amp2Descriptor {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Return the descriptor as a `WolletDescriptor`
    */
@@ -268,6 +286,7 @@ export class Amp2Descriptor {
 export class AssetAmount {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   amount(): bigint;
   asset(): AssetId;
 }
@@ -278,6 +297,7 @@ export class AssetAmount {
  */
 export class AssetId {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates an `AssetId`
    */
@@ -294,6 +314,7 @@ export class AssetId {
 export class AssetIds {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Return an empty list of asset identifiers.
    */
@@ -311,6 +332,7 @@ export class AssetIds {
 export class AssetMeta {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Return the contract of the asset.
    */
@@ -327,6 +349,7 @@ export class AssetMeta {
 export class Balance {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Convert the balance to a JsValue for serialization
    *
@@ -349,6 +372,7 @@ export class Balance {
 export class Bip {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a bip49 variant
    */
@@ -366,11 +390,111 @@ export class Bip {
    */
   toString(): string;
 }
+/**
+ * Wrapper over [`lwk_boltz::BoltzSession`]
+ */
+export class BoltzSession {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Get the rescue file
+   */
+  rescueFile(): string;
+  /**
+   * Prepare a lightning invoice payment
+   */
+  preparePay(lightning_payment: LightningPayment, refund_address: Address): Promise<PreparePayResponse>;
+  /**
+   * Create a lightning invoice for receiving payment
+   */
+  invoice(amount: bigint, description: string | null | undefined, claim_address: Address): Promise<InvoiceResponse>;
+  /**
+   * Restore a swap from its serialized data
+   */
+  restorePreparePay(data: string): Promise<PreparePayResponse>;
+  /**
+   * Restore a swap from its serialized data
+   */
+  restoreInvoice(data: string): Promise<InvoiceResponse>;
+}
+/**
+ * Wrapper over [`lwk_boltz::BoltzSessionBuilder`]
+ */
+export class BoltzSessionBuilder {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new BoltzSessionBuilder with the given network
+   *
+   * This creates a builder with default Esplora client for the network.
+   */
+  constructor(network: Network, esplora_client: EsploraClient);
+  /**
+   * Set the timeout for creating swaps
+   *
+   * If not set, the default timeout of 10 seconds is used.
+   */
+  createSwapTimeout(timeout_seconds: bigint): BoltzSessionBuilder;
+  /**
+   * Set the timeout for the advance call
+   *
+   * If not set, the default timeout of 3 minutes is used.
+   */
+  timeoutAdvance(timeout_seconds: bigint): BoltzSessionBuilder;
+  /**
+   * Set the mnemonic for deriving swap keys
+   *
+   * If not set, a new random mnemonic will be generated.
+   */
+  mnemonic(mnemonic: Mnemonic): BoltzSessionBuilder;
+  /**
+   * Set the polling flag
+   *
+   * If true, the advance call will not await on the websocket connection returning immediately
+   * even if there is no update, thus requiring the caller to poll for updates.
+   *
+   * If true, the timeout_advance will be ignored even if set.
+   */
+  polling(polling: boolean): BoltzSessionBuilder;
+  /**
+   * Set the next index to use for deriving keypairs
+   *
+   * Avoid a call to the boltz API to recover this information.
+   *
+   * When the mnemonic is not set, this is ignored.
+   */
+  nextIndexToUse(next_index_to_use: number): BoltzSessionBuilder;
+  /**
+   * Set the referral id for the BoltzSession
+   */
+  referralId(referral_id: string): BoltzSessionBuilder;
+  /**
+   * Set the url of the bitcoin electrum client
+   */
+  bitcoinElectrumClient(bitcoin_electrum_client: string): BoltzSessionBuilder;
+  /**
+   * Set the random preimages flag
+   *
+   * The default is false, the preimages will be deterministic and the rescue file will be
+   * compatible with the Boltz web app.
+   * If true, the preimages will be random potentially allowing concurrent sessions with the same
+   * mnemonic, but completing the swap will be possible only with the preimage data. For example
+   * the boltz web app will be able only to refund the swap, not to bring it to completion.
+   * If true, when serializing the swap data, the preimage will be saved in the data.
+   */
+  randomPreimages(random_preimages: boolean): BoltzSessionBuilder;
+  /**
+   * Build the BoltzSession
+   */
+  build(): Promise<BoltzSession>;
+}
 /**
  * A contract defining metadata of an asset such the name and the ticker
  */
 export class Contract {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a `Contract`
    */
@@ -391,6 +515,14 @@ export class Contract {
    */
   clone(): Contract;
 }
+export class CurrencyCode {
+  free(): void;
+  [Symbol.dispose](): void;
+  constructor(code: string);
+  name(): string;
+  alpha3(): string;
+  exp(): number;
+}
 /**
  * A blockchain backend implementation based on the
  * [esplora HTTP API](https://github.com/blockstream/esplora/blob/master/API.md).
@@ -399,6 +531,7 @@ export class Contract {
  */
 export class EsploraClient {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates an Esplora client with the given options
    */
@@ -446,12 +579,68 @@ export class EsploraClient {
    */
   setWaterfallsServerRecipient(recipient: string): Promise<void>;
 }
+/**
+ * Multiple exchange rates against BTC provided from various sources
+ */
+export class ExchangeRates {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Get the median exchange rate
+   */
+  median(): number;
+  /**
+   * Get the individual exchange rates as a JSON array
+   *
+   * Each rate contains: rate, currency, source, and timestamp
+   */
+  results(): any;
+  /**
+   * Get the number of sources that provided rates
+   */
+  resultsCount(): number;
+  /**
+   * Serialize the entire response to JSON string
+   */
+  serialize(): string;
+}
+/**
+ * Wrapper over [`lwk_boltz::InvoiceResponse`]
+ */
+export class InvoiceResponse {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Serialize the response to JSON string for JS interop
+   */
+  serialize(): string;
+  /**
+   * Return the bolt11 invoice string
+   */
+  bolt11Invoice(): string;
+  swapId(): string;
+  /**
+   * The fee of the swap provider
+   *
+   * It is equal to the amount of the invoice minus the amount of the onchain transaction.
+   * Does not include the fee of the onchain transaction.
+   */
+  fee(): bigint | undefined;
+  /**
+   * Complete the payment by advancing through the swap states until completion or failure
+   * Consumes self as the inner method does
+   */
+  completePay(): Promise<boolean>;
+}
 /**
  * The details of an issuance or reissuance.
  */
 export class Issuance {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Return the asset id or None if it's a null issuance
    */
@@ -482,6 +671,7 @@ export class Issuance {
  */
 export class Jade {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a Jade from Web Serial for the given network
    *
@@ -520,6 +710,7 @@ export class Jade {
  */
 export class JadeWebSocket {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a Jade from WebSocket for the given network
    *
@@ -554,6 +745,7 @@ export class JadeWebSocket {
 }
 export class LedgerWeb {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * hid_device must be already opened
    */
@@ -575,6 +767,45 @@ export class LedgerWeb {
    */
   getReceiveAddressSingle(index: number): Promise<string>;
 }
+/**
+ * Wrapper over [`lwk_boltz::LightningPayment`]
+ */
+export class LightningPayment {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a LightningPayment from a bolt11 invoice string or a bolt12 offer
+   */
+  constructor(invoice: string);
+  /**
+   * Return a string representation of the LightningPayment
+   */
+  toString(): string;
+  /**
+   * Return a QR code image uri for the LightningPayment
+   */
+  toUriQr(pixel_per_module?: number | null): string;
+}
+/**
+ * A struct representing a magic routing hint, with details on how to pay directly without using Boltz
+ */
+export class MagicRoutingHint {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * The address to pay directly to
+   */
+  address(): string;
+  /**
+   * The amount to pay directly to
+   */
+  amount(): bigint;
+  /**
+   * The URI to pay directly to
+   */
+  uri(): string;
+}
 /**
  * A mnemonic secret code used as a master secret for a bip39 wallet.
  *
@@ -582,6 +813,7 @@ export class LedgerWeb {
  */
 export class Mnemonic {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a Mnemonic
    */
@@ -608,6 +840,7 @@ export class Mnemonic {
 export class Network {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a mainnet `Network``
    */
@@ -664,6 +897,7 @@ export class Network {
 export class OptionWalletTxOut {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Return a copy of the WalletTxOut if it exists, otherwise None
    */
@@ -674,6 +908,7 @@ export class OptionWalletTxOut {
  */
 export class OutPoint {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates an `OutPoint`
    */
@@ -687,6 +922,49 @@ export class OutPoint {
    */
   vout(): number;
 }
+/**
+ * POS (Point of Sale) configuration for encoding/decoding
+ */
+export class PosConfig {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new POS configuration
+   */
+  constructor(descriptor: WolletDescriptor, currency: CurrencyCode);
+  /**
+   * Create a POS configuration with all options
+   */
+  static withOptions(descriptor: WolletDescriptor, currency: CurrencyCode, show_gear?: boolean | null, show_description?: boolean | null): PosConfig;
+  /**
+   * Decode a POS configuration from a URL-safe base64 encoded string
+   */
+  static decode(encoded: string): PosConfig;
+  /**
+   * Encode the POS configuration to a URL-safe base64 string
+   */
+  encode(): string;
+  /**
+   * Return a string representation of the POS configuration
+   */
+  toString(): string;
+  /**
+   * Get the wallet descriptor
+   */
+  readonly descriptor: WolletDescriptor;
+  /**
+   * Get the currency code
+   */
+  readonly currency: CurrencyCode;
+  /**
+   * Get whether to show the gear/settings button
+   */
+  readonly showGear: boolean | undefined;
+  /**
+   * Get whether to show the description/note field
+   */
+  readonly showDescription: boolean | undefined;
+}
 /**
  * Helper to convert satoshi values of an asset to the value with the given precision and viceversa.
  *
@@ -694,6 +972,7 @@ export class OutPoint {
  */
 export class Precision {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Create a new Precision, useful to encode e decode values for assets with precision.
    * erroring if the given precision is greater than the allowed maximum (8)
@@ -712,11 +991,58 @@ export class Precision {
    */
   stringToSats(sats: string): bigint;
 }
+export class PreparePayResponse {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Serialize the response to JSON string for JS interop
+   */
+  serialize(): string;
+  swapId(): string;
+  uri(): string;
+  uriAddress(): Address;
+  uriAmount(): bigint;
+  /**
+   * The fee of the swap provider
+   *
+   * It is equal to the amount requested onchain minus the amount of the bolt11 invoice
+   * Does not include the fee of the onchain transaction.
+   */
+  fee(): bigint | undefined;
+  completePay(): Promise<boolean>;
+}
+/**
+ * Wrapper over [`lwk_wollet::PricesFetcher`]
+ */
+export class PricesFetcher {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new PricesFetcher with default settings
+   */
+  constructor();
+  /**
+   * Fetch exchange rates for the given currency (e.g., "USD", "EUR", "CHF")
+   *
+   * Returns an ExchangeRates object containing rates from multiple sources and the median
+   */
+  rates(currency: CurrencyCode): Promise<ExchangeRates>;
+}
+/**
+ * Wrapper over [`lwk_wollet::PricesFetcherBuilder`]
+ */
+export class PricesFetcherBuilder {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+}
 /**
  * Partially Signed Elements Transaction
  */
 export class Pset {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a `Pset` from its base64 string representation.
    */
@@ -754,6 +1080,7 @@ export class Pset {
 export class PsetBalance {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   fee(): bigint;
   /**
    * The net balance for every asset with respect of the wallet asking the pset details
@@ -771,6 +1098,7 @@ export class PsetBalance {
 export class PsetDetails {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Return the balance of the PSET from the point of view of the wallet
    * that generated this via `psetDetails()`
@@ -799,6 +1127,7 @@ export class PsetDetails {
 export class PsetInput {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Prevout TXID of the input
    */
@@ -822,6 +1151,7 @@ export class PsetInput {
 export class PsetOutput {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   scriptPubkey(): Script;
 }
 /**
@@ -830,6 +1160,7 @@ export class PsetOutput {
 export class PsetSignatures {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Returns `Vec<(PublicKey, KeySource)>`
    */
@@ -842,6 +1173,7 @@ export class PsetSignatures {
 export class Recipient {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   asset(): AssetId | undefined;
   value(): bigint | undefined;
   address(): Address | undefined;
@@ -853,6 +1185,7 @@ export class Recipient {
 export class Registry {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Create a new registry cache specifying the URL of the registry,
    * fetch the assets metadata identified by the given asset ids and cache them for later local retrieval.
@@ -899,6 +1232,7 @@ export class Registry {
 export class RegistryData {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   precision(): number;
   ticker(): string;
   name(): string;
@@ -909,6 +1243,7 @@ export class RegistryData {
  */
 export class RegistryPost {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Create a new registry post object to be used to publish a contract for an asset id in the registry.
    */
@@ -923,6 +1258,7 @@ export class RegistryPost {
  */
 export class Script {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a `Script` from its hex string representation.
    */
@@ -948,6 +1284,7 @@ export class Script {
  */
 export class Signer {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * AMP0 signer data for login
    */
@@ -992,10 +1329,15 @@ export class Signer {
    * Return the mnemonic of the signer
    */
   mnemonic(): Mnemonic;
+  /**
+   * Return the derived BIP85 mnemonic
+   */
+  derive_bip85_mnemonic(index: number, word_count: number): Mnemonic;
 }
 export class Singlesig {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   static from(variant: string): Singlesig;
 }
 /**
@@ -1004,6 +1346,7 @@ export class Singlesig {
 export class Tip {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   height(): number;
   hash(): string;
   timestamp(): number | undefined;
@@ -1016,6 +1359,7 @@ export class Tip {
  */
 export class Transaction {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a `Transaction`
    */
@@ -1043,6 +1387,7 @@ export class Transaction {
  */
 export class TxBuilder {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a transaction builder
    */
@@ -1143,6 +1488,10 @@ export class TxBuilder {
    * Set data to take LiquiDEX proposals
    */
   liquidexTake(proposals: ValidatedLiquidexProposal[]): TxBuilder;
+  /**
+   * Add input rangeproofs
+   */
+  addInputRangeproofs(add_rangeproofs: boolean): TxBuilder;
 }
 /**
  * Contains unblinded information such as the asset and the value of a transaction output
@@ -1150,6 +1499,7 @@ export class TxBuilder {
 export class TxOutSecrets {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Return the asset of the output.
    */
@@ -1190,6 +1540,7 @@ export class TxOutSecrets {
  */
 export class Txid {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a `Txid` from its hex string representation (64 characters).
    */
@@ -1215,6 +1566,7 @@ export class Txid {
 export class UnvalidatedLiquidexProposal {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   static new(s: string): UnvalidatedLiquidexProposal;
   static fromPset(pset: Pset): UnvalidatedLiquidexProposal;
   insecureValidate(): ValidatedLiquidexProposal;
@@ -1227,6 +1579,7 @@ export class UnvalidatedLiquidexProposal {
  */
 export class Update {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates an `Update`
    */
@@ -1262,6 +1615,7 @@ export class Update {
 export class ValidatedLiquidexProposal {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   input(): AssetAmount;
   output(): AssetAmount;
   toString(): string;
@@ -1274,6 +1628,7 @@ export class ValidatedLiquidexProposal {
 export class WalletTx {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Return a copy of the transaction.
    */
@@ -1326,6 +1681,7 @@ export class WalletTx {
 export class WalletTxOut {
   private constructor();
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Return the outpoint (txid and vout) of this `WalletTxOut`.
    */
@@ -1360,6 +1716,7 @@ export class WalletTxOut {
  */
 export class Wollet {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Create a `Wollet`
    */
@@ -1371,6 +1728,10 @@ export class Wollet {
    * otherwise the last unused address.
    */
   address(index?: number | null): AddressResult;
+  /**
+   * Return the [ELIP152](https://github.com/ElementsProject/ELIPs/blob/main/elip-0152.mediawiki) deterministic wallet identifier.
+   */
+  dwid(): string;
   /**
    * Get the full derivation path for an address
    *
@@ -1472,6 +1833,7 @@ export class Wollet {
  */
 export class WolletDescriptor {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a `WolletDescriptor`
    */
@@ -1501,6 +1863,7 @@ export class WolletDescriptor {
  */
 export class Xpub {
   free(): void;
+  [Symbol.dispose](): void;
   /**
    * Creates a Xpub
    */