lwk_node 0.14.1 → 0.16.0

package/README.md

@@ -119,42 +119,4 @@ node network.js
 
 ## Javascript code conventions
 
-### String
-
-For object that have a string representation we implement `std::fmt::Display` and we expose them like that
-
-```rust
-#[wasm_bindgen(js_name = toString)]
-pub fn to_string_js(&self) -> String {
-    self.to_string()
-}
-```
-
-### JSON
-
-For objects that have a json representation, like the balance we provide a `toJSON()` method that must work when the caller use for example `JSON.stringify(object)`
-Unfortunately `JSON.stringify` cannot serialize big integers  by default, thus we use string representation for `BigInt`.
-
-### Entries
-
-Since JSON doesn't support `BigInt` some object expose also the js standard `entries()` method so that the following code is possible
-
-```js
-const balance = wallet.balance();
-
-// 1. Create a Map
-const balanceMap = new Map(balance.entries());
-
-// 2. Iterate directly in a for...of loop
-for (const [currency, amount] of balance.entries()) {
-  console.log(`${currency}: ${amount}`);
-}
-
-// 3. Convert to a plain object
-const balanceObject = Object.fromEntries(balance.entries());
-```
-
-## Documentation
-
-Documentation of this crate should not use link to rust types such as [`Transaction`] because they are not usable in end-user javascript packages.
-Many types are wrappers of types in lwk crates, in this cases we mostly duplicate the original documentation with context adjustment. 
+For new additions and improvements, follow our [guidelines](GUIDE.md).

package/lwk_wasm.d.ts

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+export function searchLedgerDevice(): Promise<HIDDevice>;
 /**
  * Convert the given string to a QR code image uri
  *
@@ -9,7 +10,6 @@
  * 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
  */
@@ -290,6 +290,38 @@ export class AssetAmount {
   amount(): bigint;
   asset(): AssetId;
 }
+/**
+ * A blinding factor for asset commitments.
+ */
+export class AssetBlindingFactor {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Creates an `AssetBlindingFactor` from a string.
+   */
+  static fromString(s: string): AssetBlindingFactor;
+  /**
+   * Creates an `AssetBlindingFactor` from a byte slice.
+   */
+  static fromBytes(bytes: Uint8Array): AssetBlindingFactor;
+  /**
+   * Returns a zero asset blinding factor.
+   */
+  static zero(): AssetBlindingFactor;
+  /**
+   * Returns the bytes (32 bytes) in little-endian byte order.
+   *
+   * This is the internal representation used by secp256k1. The byte order is
+   * reversed compared to the hex string representation (which uses big-endian,
+   * following Bitcoin display conventions).
+   */
+  toBytes(): Uint8Array;
+  /**
+   * Returns string representation of the ABF
+   */
+  toString(): string;
+}
 /**
  * A valid asset identifier.
  *
@@ -300,11 +332,25 @@ export class AssetId {
   [Symbol.dispose](): void;
   /**
    * Creates an `AssetId`
+   *
+   * Deprecated: use `from_string()` instead
    */
   constructor(asset_id: string);
+  /**
+   * Creates an `AssetId` from hex string
+   */
+  static fromString(s: string): AssetId;
+  /**
+   * Creates an `AssetId` from a bytes.
+   */
+  static fromBytes(bytes: Uint8Array): AssetId;
+  /**
+   * Returns the `AssetId` bytes in little-endian byte order.
+   */
+  toBytes(): Uint8Array;
   /**
    * Return the string representation of the asset identifier (64 hex characters).
-   * This representation can be used to recreate the asset identifier via `new()`
+   * This representation can be used to recreate the asset identifier via `fromString()`
    */
   toString(): string;
 }
@@ -620,6 +666,17 @@ export class ExchangeRates {
    */
   serialize(): string;
 }
+/**
+ * An external UTXO, owned by another wallet.
+ */
+export class ExternalUtxo {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Construct an ExternalUtxo
+   */
+  constructor(vout: number, tx: Transaction, unblinded: TxOutSecrets, max_weight_to_satisfy: number, is_segwit: boolean);
+}
 /**
  * Wrapper over [`lwk_boltz::InvoiceResponse`]
  */
@@ -758,6 +815,42 @@ export class JadeWebSocket {
   keyoriginXpub(bip: Bip): Promise<string>;
   registerDescriptor(name: string, desc: WolletDescriptor): Promise<boolean>;
 }
+/**
+ * A bridge that connects a [`JsStorage`] to [`lwk_common::Store`].
+ */
+export class JsStoreLink {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new `JsStoreLink` from a JavaScript storage object.
+   *
+   * The JS object must have `get(key)`, `put(key, value)`, and `remove(key)` methods.
+   */
+  constructor(storage: any);
+}
+/**
+ * Test helper to verify Rust can read/write through a JS store.
+ */
+export class JsTestStore {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Create a new test helper wrapping the given JS storage.
+   */
+  constructor(storage: any);
+  /**
+   * Write a key-value pair to the store.
+   */
+  write(key: string, value: Uint8Array): void;
+  /**
+   * Read a value from the store.
+   */
+  read(key: string): Uint8Array | undefined;
+  /**
+   * Remove a key from the store.
+   */
+  remove(key: string): void;
+}
 /**
  * Response from the last_used_index endpoint
  *
@@ -920,6 +1013,10 @@ export class Network {
    * Return the policy asset for this network
    */
   policyAsset(): AssetId;
+  /**
+   * Return the genesis block hash for this network as hex string.
+   */
+  genesisBlockHash(): string;
   /**
    * Return the transaction builder for this network
    */
@@ -949,9 +1046,13 @@ export class OutPoint {
   free(): void;
   [Symbol.dispose](): void;
   /**
-   * Creates an `OutPoint`
+   * Creates an `OutPoint` from a string representation.
    */
   constructor(s: string);
+  /**
+   * Creates an `OutPoint` from a transaction ID and output index.
+   */
+  static fromParts(txid: Txid, vout: number): OutPoint;
   /**
    * Return the transaction identifier.
    */
@@ -1096,6 +1197,12 @@ export class Pset {
    * the available signature information in place.
    */
   extractTx(): Transaction;
+  /**
+   * Get the unique id of the PSET as defined by [BIP-370](https://github.com/bitcoin/bips/blob/master/bip-0370.mediawiki#unique-identification)
+   *
+   * The unique id is the txid of the PSET with sequence numbers of inputs set to 0
+   */
+  uniqueId(): Txid;
   /**
    * Attempt to merge with another `Pset`.
    */
@@ -1175,6 +1282,14 @@ export class PsetInput {
    * Prevout vout of the input
    */
   previousVout(): number;
+  /**
+   * Prevout scriptpubkey of the input
+   */
+  previousScriptPubkey(): Script | undefined;
+  /**
+   * Redeem script of the input
+   */
+  redeemScript(): Script | undefined;
   /**
    * If the input has an issuance, the asset id
    */
@@ -1183,6 +1298,19 @@ export class PsetInput {
    * If the input has an issuance, the token id
    */
   issuanceToken(): AssetId | undefined;
+  /**
+   * If the input has a (re)issuance, the issuance object
+   */
+  issuance(): Issuance | undefined;
+  /**
+   * Input sighash
+   */
+  sighash(): number;
+  /**
+   * If the input has an issuance, returns [asset_id, token_id].
+   * Returns undefined if the input has no issuance.
+   */
+  issuanceIds(): AssetId[] | undefined;
 }
 /**
  * PSET output
@@ -1191,7 +1319,22 @@ export class PsetOutput {
   private constructor();
   free(): void;
   [Symbol.dispose](): void;
+  /**
+   * Get the script pubkey
+   */
   scriptPubkey(): Script;
+  /**
+   * Get the explicit amount, if set
+   */
+  amount(): bigint | undefined;
+  /**
+   * Get the explicit asset ID, if set
+   */
+  asset(): AssetId | undefined;
+  /**
+   * Get the blinder index, if set
+   */
+  blinderIndex(): number | undefined;
 }
 /**
  * The details of the signatures in a PSET, divided in available and missing signatures.
@@ -1302,16 +1445,44 @@ export class Script {
    * Creates a `Script` from its hex string representation.
    */
   constructor(s: string);
+  /**
+   * Creates an empty `Script`.
+   */
+  static empty(): Script;
   /**
    * Return the consensus encoded bytes of the script.
    */
   bytes(): Uint8Array;
+  /**
+   * Returns SHA256 of the script's consensus bytes.
+   *
+   * Returns an equivalent value to the `jet::input_script_hash(index)`/`jet::output_script_hash(index)`.
+   */
+  jet_sha256_hex(): string;
   /**
    * Return the string of the script showing op codes and their arguments.
    *
    * For example: "OP_DUP OP_HASH160 OP_PUSHBYTES_20 088ac47276d105b91cf9aa27a00112421dd5f23c OP_EQUALVERIFY OP_CHECKSIG"
    */
   asm(): string;
+  /**
+   * Creates an OP_RETURN script with the given data.
+   */
+  static newOpReturn(data: Uint8Array): Script;
+  /**
+   * Returns true if the script is provably unspendable.
+   *
+   * A script is provably unspendable if it starts with OP_RETURN or is larger
+   * than the maximum script size.
+   */
+  isProvablyUnspendable(): boolean;
+  /**
+   * Returns true if this script_pubkey is provably SegWit.
+   *
+   * This checks if the script_pubkey is provably SegWit based on the
+   * script_pubkey itself and an optional redeem_script.
+   */
+  isProvablySegwit(redeem_script?: Script | null): boolean;
   /**
    * Return the string representation of the script (hex encoding of its consensus encoded bytes).
    * This representation can be used to recreate the script via `new()`
@@ -1401,8 +1572,18 @@ export class Transaction {
   [Symbol.dispose](): void;
   /**
    * Creates a `Transaction`
+   *
+   * Deprecated: use `fromString()` instead.
    */
   constructor(tx_hex: string);
+  /**
+   * Creates a `Transaction` from hex-encoded consensus bytes.
+   */
+  static fromString(s: string): Transaction;
+  /**
+   * Creates a `Transaction` from consensus-encoded bytes.
+   */
+  static fromBytes(bytes: Uint8Array): Transaction;
   /**
    * Return the transaction identifier.
    */
@@ -1410,6 +1591,12 @@ export class Transaction {
   /**
    * Return the consensus encoded bytes of the transaction.
    */
+  toBytes(): Uint8Array;
+  /**
+   * Return the consensus encoded bytes of the transaction.
+   *
+   * Deprecated: use `toBytes()` instead.
+   */
   bytes(): Uint8Array;
   /**
    * Return the fee of the transaction in the given asset.
@@ -1539,22 +1726,28 @@ export class TxOutSecrets {
   private constructor();
   free(): void;
   [Symbol.dispose](): void;
+  /**
+   * Creates a new `TxOutSecrets` for an explicit (unblinded) output.
+   *
+   * The blinding factors are set to zero.
+   */
+  static fromExplicit(asset_id: AssetId, value: bigint): TxOutSecrets;
   /**
    * Return the asset of the output.
    */
   asset(): AssetId;
   /**
-   * Return the asset blinding factor as a hex string.
+   * Return the asset blinding factor as a typed object.
    */
-  assetBlindingFactor(): string;
+  assetBlindingFactor(): AssetBlindingFactor;
   /**
    * Return the value of the output.
    */
   value(): bigint;
   /**
-   * Return the value blinding factor as a hex string.
+   * Return the value blinding factor as a typed object.
    */
-  valueBlindingFactor(): string;
+  valueBlindingFactor(): ValueBlindingFactor;
   /**
    * Return true if the output is explicit (no blinding factors).
    */
@@ -1659,6 +1852,38 @@ export class ValidatedLiquidexProposal {
   output(): AssetAmount;
   toString(): string;
 }
+/**
+ * A blinding factor for value commitments.
+ */
+export class ValueBlindingFactor {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Creates a `ValueBlindingFactor` from a string.
+   */
+  static fromString(s: string): ValueBlindingFactor;
+  /**
+   * Creates a `ValueBlindingFactor` from a byte slice.
+   */
+  static fromBytes(bytes: Uint8Array): ValueBlindingFactor;
+  /**
+   * Returns a zero value blinding factor.
+   */
+  static zero(): ValueBlindingFactor;
+  /**
+   * Returns the bytes (32 bytes) in little-endian byte order.
+   *
+   * This is the internal representation used by secp256k1. The byte order is
+   * reversed compared to the hex string representation (which uses big-endian,
+   * following Bitcoin display conventions).
+   */
+  toBytes(): Uint8Array;
+  /**
+   * Returns string representation of the VBF
+   */
+  toString(): string;
+}
 /**
  * Value returned by asking transactions to the wallet. Contains details about a transaction
  * from the perspective of the wallet, for example the net-balance of the transaction for the