lwk_node 0.9.0 → 0.9.2

package/lwk_wasm.d.ts

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+export function searchLedgerDevice(): Promise<HIDDevice>;
 /**
  * Wallet chain
  */
@@ -21,8 +22,14 @@ export class Address {
   free(): void;
   /**
    * Creates an `Address`
+   *
+   * If you know the network, you can use [`Address::parse()`] to validate that the network is consistent.
    */
   constructor(s: string);
+  /**
+   * Parses an `Address` ensuring is for the right network
+   */
+  static parse(s: string, network: Network): Address;
   scriptPubkey(): Script;
   isBlinded(): boolean;
   isMainnet(): boolean;
@@ -37,7 +44,7 @@ export class Address {
    * and use styling to scale up the image in the browser. eg
    * `style="image-rendering: pixelated; border: 20px solid white;"`
    */
-  QRCodeUri(pixel_per_module?: number): string;
+  QRCodeUri(pixel_per_module?: number | null): string;
   /**
    * Returns a string of the QR code printable in a terminal environment
    */
@@ -72,6 +79,15 @@ export class Amp2Descriptor {
   descriptor(): WolletDescriptor;
   toString(): string;
 }
+/**
+ * Wrapper of [`lwk_wollet::AssetAmount`]
+ */
+export class AssetAmount {
+  private constructor();
+  free(): void;
+  amount(): bigint;
+  asset(): AssetId;
+}
 /**
  * A valid asset identifier. wrapper of [`elements::AssetId`]
  *
@@ -85,6 +101,12 @@ export class AssetId {
   constructor(asset_id: string);
   toString(): string;
 }
+export class AssetMeta {
+  private constructor();
+  free(): void;
+  contract(): Contract;
+  tx(): Transaction;
+}
 /**
  * wrapper over [`lwk_common::Bip`]
  */
@@ -126,7 +148,7 @@ export class EsploraClient {
   /**
    * Creates a client, wrapper of [`asyncr::EsploraClient`]
    */
-  constructor(network: Network, url: string, waterfalls: boolean);
+  constructor(network: Network, url: string, waterfalls: boolean, concurrency: number);
   fullScan(wollet: Wollet): Promise<Update | undefined>;
   /**
    * Scan the blockchain for the scripts generated by a watch-only wallet up to a specified derivation index
@@ -186,6 +208,66 @@ export class Jade {
   keyoriginXpub(bip: Bip): Promise<string>;
   registerDescriptor(name: string, desc: WolletDescriptor): Promise<boolean>;
 }
+/**
+ * WebSocket-based Wrapper of [`asyncr::Jade`]
+ */
+export class JadeWebSocket {
+  free(): void;
+  /**
+   * Creates a Jade from WebSocket for the given network
+   *
+   * The url should point to your WebSocket bridge that connects to the Docker Jade emulator
+   */
+  constructor(network: Network, url: string);
+  getVersion(): Promise<any>;
+  getMasterXpub(): Promise<Xpub>;
+  /**
+   * Return a single sig address with the given `variant` and `path` derivation
+   */
+  getReceiveAddressSingle(variant: Singlesig, path: Uint32Array): Promise<string>;
+  /**
+   * Return a multisig address of a registered `multisig_name` wallet
+   *
+   * This method accept `path` and `path_n` in place of a single `Vec<Vec<u32>>` because the
+   * latter is not supported by wasm_bindgen (and neither `(u32, Vec<u32>)`). `path` and `path_n`
+   * are converted internally to a `Vec<Vec<u32>>` with the caveat all the paths are the same,
+   * which is almost always the case.
+   */
+  getReceiveAddressMulti(multisig_name: string, path: Uint32Array): Promise<string>;
+  /**
+   * Sign and consume the given PSET, returning the signed one
+   */
+  sign(pset: Pset): Promise<Pset>;
+  wpkh(): Promise<WolletDescriptor>;
+  shWpkh(): Promise<WolletDescriptor>;
+  multi(name: string): Promise<WolletDescriptor>;
+  getRegisteredMultisigs(): Promise<any>;
+  keyoriginXpub(bip: Bip): Promise<string>;
+  registerDescriptor(name: string, desc: WolletDescriptor): Promise<boolean>;
+}
+export class LedgerWeb {
+  free(): void;
+  /**
+   * hid_device must be already opened
+   */
+  constructor(hid_device: HIDDevice, network: Network);
+  getVersion(): Promise<string>;
+  deriveXpub(path: string): Promise<string>;
+  slip77MasterBlindingKey(): Promise<string>;
+  fingerprint(): Promise<string>;
+  /**
+   * TODO Should use Signer::wpkh_slip77_descriptor
+   */
+  wpkhSlip77Descriptor(): Promise<WolletDescriptor>;
+  /**
+   * Sign and consume the given PSET, returning the signed one
+   */
+  sign(pset: Pset): Promise<Pset>;
+  /**
+   * Return a single sig address with the given `variant` and `index`
+   */
+  getReceiveAddressSingle(index: number): Promise<string>;
+}
 /**
  * Wrapper of [`bip39::Mnemonic`]
  */
@@ -224,11 +306,13 @@ export class Network {
    */
   static regtest(policy_asset: AssetId): Network;
   /**
-   * Creates the default regtest `Network`
+   * Creates the default regtest `Network` with the policy asset `5ac9f65c0efcc4775e0baec4ec03abdde22473cd3cf33c0419ca290e0751b225`
    */
   static regtestDefault(): Network;
   defaultEsploraClient(): EsploraClient;
   isMainnet(): boolean;
+  isTestnet(): boolean;
+  isRegtest(): boolean;
   toString(): string;
   policyAsset(): AssetId;
   txBuilder(): TxBuilder;
@@ -279,7 +363,8 @@ export class Pset {
   toString(): string;
   extractTx(): Transaction;
   combine(other: Pset): void;
-  inputs(): (PsetInput)[];
+  inputs(): PsetInput[];
+  outputs(): PsetOutput[];
 }
 /**
  * PSET details from a perspective of a wallet, wrapper of [`lwk_common::PsetBalance`]
@@ -292,7 +377,7 @@ export class PsetBalance {
    * The net balance for every asset with respect of the wallet asking the pset details
    */
   balances(): any;
-  recipients(): (Recipient)[];
+  recipients(): Recipient[];
 }
 /**
  * PSET details from a perspective of a wallet, wrapper of [`lwk_common::PsetDetails`]
@@ -304,13 +389,13 @@ export class PsetDetails {
   /**
    * For each input existing or missing signatures
    */
-  signatures(): (PsetSignatures)[];
-  fingerprintsMissing(): (string)[];
-  fingerprintsHas(): (string)[];
+  signatures(): PsetSignatures[];
+  fingerprintsMissing(): string[];
+  fingerprintsHas(): string[];
   /**
    * Return an element for every input that could possibly be a issuance or a reissuance
    */
-  inputsIssuances(): (Issuance)[];
+  inputsIssuances(): Issuance[];
 }
 /**
  * PSET input
@@ -335,6 +420,14 @@ export class PsetInput {
    */
   issuanceToken(): AssetId | undefined;
 }
+/**
+ * PSET output
+ */
+export class PsetOutput {
+  private constructor();
+  free(): void;
+  script_pubkey(): Script;
+}
 /**
  * PSET details from a perspective of a wallet, wrapper of [`lwk_common::PsetSignatures`]
  */
@@ -358,6 +451,19 @@ export class Recipient {
   address(): Address | undefined;
   vout(): number;
 }
+export class Registry {
+  private constructor();
+  free(): void;
+  static new(url: string): Registry;
+  static defaultForNetwork(network: Network): Registry;
+  fetchWithTx(asset_id: AssetId, client: EsploraClient): Promise<AssetMeta>;
+  post(data: RegistryPost): Promise<void>;
+}
+export class RegistryPost {
+  free(): void;
+  constructor(contract: Contract, asset_id: AssetId);
+  toString(): string;
+}
 /**
  * Wrapper of [`elements::Script`]
  */
@@ -384,6 +490,10 @@ export class Signer {
    * Sign and consume the given PSET, returning the signed one
    */
   sign(pset: Pset): Pset;
+  /**
+   * Sign a message with the master key, return the signature as a base64 string
+   */
+  signMessage(message: string): string;
   wpkhSlip77Descriptor(): WolletDescriptor;
   getMasterXpub(): Xpub;
   keyoriginXpub(bip: Bip): string;
@@ -437,7 +547,7 @@ export class TxBuilder {
   /**
    * Set the fee rate
    */
-  feeRate(fee_rate?: number): TxBuilder;
+  feeRate(fee_rate?: number | null): TxBuilder;
   /**
    * Select all available L-BTC inputs
    */
@@ -465,16 +575,18 @@ export class TxBuilder {
   /**
    * Issue an asset, wrapper of [`lwk_wollet::TxBuilder::issue_asset()`]
    */
-  issueAsset(asset_sats: bigint, asset_receiver: Address | undefined, token_sats: bigint, token_receiver?: Address, contract?: Contract): TxBuilder;
+  issueAsset(asset_sats: bigint, asset_receiver: Address | null | undefined, token_sats: bigint, token_receiver?: Address | null, contract?: Contract | null): TxBuilder;
   /**
    * Reissue an asset, wrapper of [`lwk_wollet::TxBuilder::reissue_asset()`]
    */
-  reissueAsset(asset_to_reissue: AssetId, satoshi_to_reissue: bigint, asset_receiver?: Address, issuance_tx?: Transaction): TxBuilder;
+  reissueAsset(asset_to_reissue: AssetId, satoshi_to_reissue: bigint, asset_receiver?: Address | null, issuance_tx?: Transaction | null): TxBuilder;
   /**
    * Manual coin selection, wrapper of [`lwk_wollet::TxBuilder::set_wallet_utxos()`]
    */
-  setWalletUtxos(outpoints: (OutPoint)[]): TxBuilder;
+  setWalletUtxos(outpoints: OutPoint[]): TxBuilder;
   toString(): string;
+  liquidexMake(utxo: OutPoint, address: Address, satoshi: bigint, asset_id: AssetId): TxBuilder;
+  liquidexTake(proposals: ValidatedLiquidexProposal[]): TxBuilder;
 }
 /**
  * Wrapper of [`elements::TxOutSecrets`]
@@ -500,6 +612,18 @@ export class Txid {
   constructor(tx_id: string);
   toString(): string;
 }
+/**
+ * Wrapper of [`lwk_wollet::LiquidexProposal<Unvalidated>`]
+ */
+export class UnvalidatedLiquidexProposal {
+  private constructor();
+  free(): void;
+  static new(s: string): UnvalidatedLiquidexProposal;
+  static from_pset(pset: Pset): UnvalidatedLiquidexProposal;
+  insecure_validate(): ValidatedLiquidexProposal;
+  validate(tx: Transaction): ValidatedLiquidexProposal;
+  toString(): string;
+}
 /**
  * Wrapper of [`lwk_wollet::Update`]
  */
@@ -515,6 +639,16 @@ export class Update {
   onlyTip(): boolean;
   prune(wollet: Wollet): void;
 }
+/**
+ * Wrapper of [`lwk_wollet::LiquidexProposal<Validated>`]
+ */
+export class ValidatedLiquidexProposal {
+  private constructor();
+  free(): void;
+  input(): AssetAmount;
+  output(): AssetAmount;
+  toString(): string;
+}
 /**
  * Wrapper of [`lwk_wollet::WalletTx`]
  */
@@ -528,8 +662,8 @@ export class WalletTx {
   fee(): bigint;
   txType(): string;
   timestamp(): number | undefined;
-  inputs(): (OptionWalletTxOut)[];
-  outputs(): (OptionWalletTxOut)[];
+  inputs(): OptionWalletTxOut[];
+  outputs(): OptionWalletTxOut[];
   unblindedUrl(explorer_url: string): string;
 }
 /**
@@ -561,19 +695,19 @@ export class Wollet {
    * If Some return the address at the given index,
    * otherwise the last unused address.
    */
-  address(index?: number): AddressResult;
+  address(index?: number | null): AddressResult;
   addressFullPath(index: number): Uint32Array;
   applyUpdate(update: Update): void;
   balance(): any;
-  transactions(): (WalletTx)[];
+  transactions(): WalletTx[];
   /**
    * Get the unspent transaction outputs of the wallet
    */
-  utxos(): (WalletTxOut)[];
+  utxos(): WalletTxOut[];
   /**
    * Get all the transaction outputs of the wallet, both spent and unspent
    */
-  txos(): (WalletTxOut)[];
+  txos(): WalletTxOut[];
   /**
    * Finalize and consume the given PSET, returning the finalized one
    */
@@ -597,7 +731,7 @@ export class WolletDescriptor {
    */
   constructor(descriptor: string);
   toString(): string;
-  static newMultiWshSlip77(threshold: number, participants: (string)[]): WolletDescriptor;
+  static newMultiWshSlip77(threshold: number, participants: string[]): WolletDescriptor;
   isMainnet(): boolean;
 }
 /**