lwk_node 0.16.0 → 0.17.1

package/lwk_wasm.d.ts

@@ -164,9 +164,9 @@ export class Amp0Connected {
   free(): void;
   [Symbol.dispose](): void;
   /**
-   * Connect and register to AMP0
+   * Connect and register to AMP0.
    */
-  constructor(network: Network, signer_data: Amp0SignerData);
+  static connect(network: Network, signer_data: Amp0SignerData): Promise<Amp0Connected>;
   /**
    * Obtain a login challenge
    *
@@ -247,6 +247,13 @@ export class Amp2 {
   private constructor();
   free(): void;
   [Symbol.dispose](): void;
+  /**
+   * Create a new AMP2 client
+   *
+   *  * `server_key` - The keyorigin xpub of the AMP2 server key
+   *  * `url` - The URL of the AMP2 server
+   */
+  static new(server_key: string, url: string): Amp2;
   /**
    * Create a new AMP2 client with the default url and server key for the testnet network.
    */
@@ -254,7 +261,7 @@ export class Amp2 {
   /**
    * Get an AMP2 wallet descriptor from the keyorigin xpub string obtained from a signer
    */
-  descriptorFromStr(keyorigin_xpub: string): Amp2Descriptor;
+  descriptorFromStr(keyorigin_xpub: string, descriptor_blinding_key: string): Amp2Descriptor;
   /**
    * Register an AMP2 wallet with the AMP2 server
    */
@@ -745,12 +752,12 @@ export class Jade {
   free(): void;
   [Symbol.dispose](): void;
   /**
-   * Creates a Jade from Web Serial for the given network
+   * Creates a Jade from Web Serial for the given network.
    *
    * When filter is true, it will filter available serial with Blockstream released chips, use
    * false if you don't see your DYI jade
    */
-  constructor(network: Network, filter: boolean);
+  static fromSerial(network: Network, filter: boolean): Promise<Jade>;
   getVersion(): Promise<any>;
   getMasterXpub(): Promise<Xpub>;
   /**
@@ -788,7 +795,7 @@ export class JadeWebSocket {
    *
    * The url should point to your WebSocket bridge that connects to the Docker Jade emulator
    */
-  constructor(network: Network, url: string);
+  static fromWebSocket(network: Network, url: string): Promise<JadeWebSocket>;
   getVersion(): Promise<any>;
   getMasterXpub(): Promise<Xpub>;
   /**
@@ -824,7 +831,8 @@ export class JsStoreLink {
   /**
    * Create a new `JsStoreLink` from a JavaScript storage object.
    *
-   * The JS object must have `get(key)`, `put(key, value)`, and `remove(key)` methods.
+   * The JS object must have `get(key)`, `put(key, value)`, `remove(key)`,
+   * and `isPersisted()` methods.
    */
   constructor(storage: any);
 }
@@ -1215,6 +1223,10 @@ export class Pset {
    * Return a copy of the outputs of this PSET
    */
   outputs(): PsetOutput[];
+  /**
+   * Add wallet details to this PSET in place
+   */
+  addDetails(wollet: Wollet): void;
 }
 /**
  * The details regarding balance and amounts in a PSET:
@@ -1719,6 +1731,115 @@ export class TxBuilder {
    */
   addInputRangeproofs(add_rangeproofs: boolean): TxBuilder;
 }
+/**
+ * Transaction details
+ */
+export class TxDetails {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Transaction
+   */
+  tx(): Transaction | undefined;
+  /**
+   * Txid
+   */
+  txid(): Txid;
+  /**
+   * Blockchain height
+   */
+  height(): number | undefined;
+  /**
+   * Timestamp
+   *
+   * A reasonable timestamp, that however can be inaccurate.
+   * If you need a precise timestamp, do not use this value.
+   */
+  timestamp(): number | undefined;
+  /**
+   * Transaction type
+   *
+   * A tentative description of the transaction type, which
+   * however might be inaccurate. Use this if you want a simple
+   * description of what this transaction is doing, but do
+   * not rely on the value returned.
+   */
+  txType(): string;
+  /**
+   * Balance
+   *
+   * Net balance from the `Wollet` perspective
+   */
+  balance(): Balance;
+  /**
+   * Asset fees
+   */
+  feesAsset(asset: AssetId): bigint;
+  /**
+   * Unblinded URL
+   */
+  unblindedUrl(explorer_url: string): string;
+  /**
+   * Inputs
+   */
+  inputs(): TxOutDetails[];
+  /**
+   * Outputs
+   */
+  outputs(): TxOutDetails[];
+}
+/**
+ * Options for transaction details
+ */
+export class TxOpt {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  static default(): TxOpt;
+}
+/**
+ * Transaction output details
+ */
+export class TxOutDetails {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Outpoint
+   */
+  outpoint(): OutPoint;
+  /**
+   * Scriptpubkey
+   */
+  script_pubkey(): Script | undefined;
+  /**
+   * Height
+   */
+  height(): number | undefined;
+  /**
+   * Address
+   */
+  address(): Address | undefined;
+  /**
+   * Unblinded values (asset, amount, blinders)
+   */
+  unblinded(): TxOutSecrets | undefined;
+  /**
+   * Whether the transaction output is explicit
+   */
+  is_explicit(): boolean;
+  /**
+   * Whether the output is spent by a previously downloaded transaction
+   *
+   * Note: this value might be inaccurate. We compute this from downloaded
+   * transactions, however we only download transactions relevant for the
+   * wallet (i.e. if they include inputs or outputs that belong to the
+   * wallet), thus for non-wallet outputs we might set this value
+   * incorrectly. For wallet outputs, it can be outdated.
+   */
+  is_spent(): boolean;
+}
 /**
  * Contains unblinded information such as the asset and the value of a transaction output
  */
@@ -1783,6 +1904,16 @@ export class Txid {
    */
   toString(): string;
 }
+/**
+ * Options for transaction details
+ */
+export class TxsOpt {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  static default(): TxsOpt;
+  static withPagination(offset: number, limit: number): TxsOpt;
+}
 /**
  * LiquiDEX swap proposal
  *
@@ -1981,6 +2112,22 @@ export class WalletTxOut {
 export class Wollet {
   free(): void;
   [Symbol.dispose](): void;
+  /**
+   * Get the transaction list
+   *
+   * **Experimental**: This API may change without notice.
+   */
+  txs(opt: TxsOpt): TxDetails[];
+  /**
+   * Number of transactions
+   */
+  numTxs(): number;
+  /**
+   * Get the details of a transaction
+   *
+   * **Experimental**: This API may change without notice.
+   */
+  txDetails(txid: Txid, opt: TxOpt): TxDetails | undefined;
   /**
    * Create a `Wollet`
    */
@@ -2047,9 +2194,13 @@ export class Wollet {
    */
   assetsOwned(): AssetIds;
   /**
-   * Get the wallet transactions
+   * Get the wallet transactions, sorted by height descending, then txid descending with unconfirmed first
    */
   transactions(): WalletTx[];
+  /**
+   * Get the wallet transactions with pagination sorted by height descending, then txid descending with unconfirmed first
+   */
+  transactionsPaginated(offset: number, limit: number): WalletTx[];
   /**
    * Get the unspent transaction outputs of the wallet
    */
@@ -2092,6 +2243,62 @@ export class Wollet {
    */
   isAmp0(): boolean;
 }
+/**
+ * A builder for constructing [`Wollet`] instances.
+ */
+export class WolletBuilder {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a builder for a watch-only wallet.
+   */
+  constructor(network: Network, descriptor: WolletDescriptor);
+  /**
+   * Set the threshold used to merge persisted updates during build.
+   *
+   * **Experimental**: This API may change without notice.
+   *
+   * `None` disables merging (default behavior).
+   */
+  withMergeThreshold(merge_threshold?: number | null): WolletBuilder;
+  /**
+   * Set the wallet as "utxo only".
+   *
+   * **Experimental**: This API may change without notice.
+   */
+  utxoOnly(utxo_only: boolean): WolletBuilder;
+  /**
+   * Persist wallet updates in the given JavaScript storage object.
+   *
+   * **Experimental**: This API may change without notice.
+   *
+   * Wallet data is persisted in clear.
+   *
+   * The JS object must have `get(key)`, `put(key, value)`, and `remove(key)` methods.
+   */
+  withExperimentalStore(storage: any): WolletBuilder;
+  /**
+   * Persist wallet transactions in the given JavaScript
+   * storage object.
+   *
+   * **Experimental**: This API may change without notice.
+   *
+   * The JS object must have `get(key)`, `put(key, value)`, and `remove(key)` methods.
+   */
+  withTxsStore(storage: any): WolletBuilder;
+  /**
+   * Set encryption for the transactions store.
+   *
+   * **Experimental**: This API may change without notice.
+   *
+   * Default: encrypted if the store is persisted.
+   */
+  setEncryptionTxsStore(encrypt: boolean): WolletBuilder;
+  /**
+   * Build the wallet from this builder.
+   */
+  build(): Wollet;
+}
 /**
  * A wrapper that contains only the subset of CT descriptors handled by wollet
  */