lumina-node-wasm 0.10.3 → 0.11.0

package/lumina_node_wasm.d.ts

@@ -419,6 +419,16 @@ type ReadableStreamType = "bytes";
     
 
 
+    /**
+     * Coin
+     */
+    export interface Coin {
+      denom: string,
+      amount: bigint
+    }
+    
+
+
     /**
      * Public key
      */
@@ -450,16 +460,6 @@ type ReadableStreamType = "bytes";
     
 
 
-    /**
-     * Coin
-     */
-    export interface Coin {
-      denom: string,
-      amount: bigint
-    }
-    
-
-
     /**
      * Transaction info
      */
@@ -500,21 +500,21 @@ type ReadableStreamType = "bytes";
     
 
 
-/**
- * A payload to be signed
- */
-export interface SignDoc {
-  bodyBytes: Uint8Array;
-  authInfoBytes: Uint8Array;
-  chainId: string;
-  accountNumber: bigint;
-}
-
-/**
- * A function that produces a signature of a payload
- */
-export type SignerFn = ((arg: SignDoc) => Uint8Array) | ((arg: SignDoc) => Promise<Uint8Array>);
+    /**
+     * A payload to be signed
+     */
+    export interface SignDoc {
+      bodyBytes: Uint8Array;
+      authInfoBytes: Uint8Array;
+      chainId: string;
+      accountNumber: bigint;
+    }
 
+    /**
+     * A function that produces a signature of a payload
+     */
+    export type SignerFn = ((arg: SignDoc) => Uint8Array) | ((arg: SignDoc) => Promise<Uint8Array>);
+    
 
 /**
  * ABCIMessageLog defines a structure containing an indexed tx ABCI message log.
@@ -1423,52 +1423,54 @@ export class GetTxResponse {
   tx_response: TxResponse;
 }
 /**
- * Celestia GRPC client
+ * Celestia gRPC client, for builder see [`GrpcClientBuilder`]
  */
 export class GrpcClient {
   private constructor();
   free(): void;
   /**
-   * Create a new client connected with the given `url`
+   * Create a builder for [`GrpcClient`] connected to `url`
    */
-  static new(url: string): Promise<GrpcClient>;
+  static withUrl(url: string): GrpcClientBuilder;
   /**
    * Get auth params
    */
-  get_auth_params(): Promise<AuthParams>;
+  getAuthParams(): Promise<AuthParams>;
   /**
    * Get account
    */
-  get_account(account: string): Promise<BaseAccount>;
+  getAccount(account: string): Promise<BaseAccount>;
   /**
    * Get accounts
    */
-  get_accounts(): Promise<BaseAccount[]>;
+  getAccounts(): Promise<BaseAccount[]>;
   /**
-   * Get balance of coins with bond denom for the given address, together with a proof,
-   * and verify the returned balance against the corresponding block's app hash.
+   * Retrieves the verified Celestia coin balance for the address.
    *
-   * NOTE: the balance returned is the balance reported by the parent block of
-   * the provided header. This is due to the fact that for block N, the block's
-   * app hash is the result of applying the previous block's transaction list.
+   * # Notes
+   *
+   * This returns the verified balance which is the one that was reported by
+   * the previous network block. In other words, if you transfer some coins,
+   * you need to wait 1 more block in order to see the new balance. If you want
+   * something more immediate then use [`GrpcClient::get_balance`].
    */
-  get_verified_balance(address: string, header: ExtendedHeader): Promise<Coin>;
+  getVerifiedBalance(address: string, header: ExtendedHeader): Promise<Coin>;
   /**
-   * Get balance of coins with given denom
+   * Retrieves the Celestia coin balance for the given address.
    */
-  get_balance(address: string, denom: string): Promise<Coin>;
+  getBalance(address: string, denom: string): Promise<Coin>;
   /**
    * Get balance of all coins
    */
-  get_all_balances(address: string): Promise<Coin[]>;
+  getAllBalances(address: string): Promise<Coin[]>;
   /**
    * Get balance of all spendable coins
    */
-  get_spendable_balances(address: string): Promise<Coin[]>;
+  getSpendableBalances(address: string): Promise<Coin[]>;
   /**
    * Get total supply
    */
-  get_total_supply(): Promise<Coin[]>;
+  getTotalSupply(): Promise<Coin[]>;
   /**
    * Get node configuration
    */
@@ -1476,23 +1478,23 @@ export class GrpcClient {
   /**
    * Get latest block
    */
-  get_latest_block(): Promise<Block>;
+  getLatestBlock(): Promise<Block>;
   /**
    * Get block by height
    */
-  get_block_by_height(height: bigint): Promise<Block>;
+  getBlockByHeight(height: bigint): Promise<Block>;
   /**
    * Issue a direct ABCI query to the application
    */
-  abci_query(data: Uint8Array, path: string, height: bigint, prove: boolean): Promise<AbciQueryResponse>;
+  abciQuery(data: Uint8Array, path: string, height: bigint, prove: boolean): Promise<AbciQueryResponse>;
   /**
    * Broadcast prepared and serialised transaction
    */
-  broadcast_tx(tx_bytes: Uint8Array, mode: BroadcastMode): Promise<TxResponse>;
+  broadcastTx(tx_bytes: Uint8Array, mode: BroadcastMode): Promise<TxResponse>;
   /**
    * Get Tx
    */
-  get_tx(hash: string): Promise<GetTxResponse>;
+  getTx(hash: string): Promise<GetTxResponse>;
   /**
    * Simulate prepared and serialised transaction, returning simulated gas usage
    */
@@ -1500,11 +1502,162 @@ export class GrpcClient {
   /**
    * Get blob params
    */
-  get_blob_params(): Promise<BlobParams>;
+  getBlobParams(): Promise<BlobParams>;
   /**
    * Get status of the transaction
    */
-  tx_status(hash: string): Promise<TxStatusResponse>;
+  txStatus(hash: string): Promise<TxStatusResponse>;
+  /**
+   * Estimate gas price for given transaction priority based
+   * on the gas prices of the transactions in the last five blocks.
+   *
+   * If no transaction is found in the last five blocks, return the network
+   * min gas price.
+   */
+  estimateGasPrice(priority: TxPriority): Promise<number>;
+  /**
+   * Submit blobs to the celestia network.
+   *
+   * # Example
+   * ```js
+   * const ns = Namespace.newV0(new Uint8Array([97, 98, 99]));
+   * const data = new Uint8Array([100, 97, 116, 97]);
+   * const blob = new Blob(ns, data, AppVersion.latest());
+   *
+   * const txInfo = await txClient.submitBlobs([blob]);
+   * await txClient.submitBlobs([blob], { gasLimit: 100000n, gasPrice: 0.02, memo: "foo" });
+   * ```
+   *
+   * # Note
+   *
+   * Provided blobs will be consumed by this method, meaning
+   * they will no longer be accessible. If this behavior is not desired,
+   * consider using `Blob.clone()`.
+   *
+   * ```js
+   * const blobs = [blob1, blob2, blob3];
+   * await txClient.submitBlobs(blobs.map(b => b.clone()));
+   * ```
+   */
+  submitBlobs(blobs: Blob[], tx_config?: TxConfig | null): Promise<TxInfo>;
+  /**
+   * Submit message to the celestia network.
+   *
+   * # Example
+   * ```js
+   * import { Registry } from "@cosmjs/proto-signing";
+   *
+   * const registry = new Registry();
+   * const sendMsg = {
+   *   typeUrl: "/cosmos.bank.v1beta1.MsgSend",
+   *   value: {
+   *     fromAddress: "celestia169s50psyj2f4la9a2235329xz7rk6c53zhw9mm",
+   *     toAddress: "celestia1t52q7uqgnjfzdh3wx5m5phvma3umrq8k6tq2p9",
+   *     amount: [{ denom: "utia", amount: "10000" }],
+   *   },
+   * };
+   * const sendMsgAny = registry.encodeAsAny(sendMsg);
+   *
+   * const txInfo = await txClient.submitMessage(sendMsgAny);
+   * ```
+   */
+  submitMessage(message: ProtoAny, tx_config?: TxConfig | null): Promise<TxInfo>;
+  /**
+   * Chain id of the client
+   */
+  readonly chainId: Promise<string>;
+  /**
+   * AppVersion of the client
+   */
+  readonly appVersion: Promise<AppVersion>;
+}
+/**
+ * Builder for [`GrpcClient`] and [`TxClient`].
+ *
+ * Url must point to a [grpc-web proxy](https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-WEB.md).
+ *
+ * # Keyless client example
+ *
+ * ```js
+ * const client = await GrpcClient
+ *   .withUrl("http://127.0.0.1:18080")
+ *   .build()
+ * ```
+ *
+ * # Transaction client examples
+ *
+ * ## Example with noble/curves
+ * ```js
+ * import { secp256k1 } from "@noble/curves/secp256k1";
+ *
+ * const privKey = "fdc8ac75dfa1c142dbcba77938a14dd03078052ce0b49a529dcf72a9885a3abb";
+ * const pubKey = secp256k1.getPublicKey(privKey);
+ *
+ * const signer = (signDoc) => {
+ *   const bytes = protoEncodeSignDoc(signDoc);
+ *   const sig = secp256k1.sign(bytes, privKey, { prehash: true });
+ *   return sig.toCompactRawBytes();
+ * };
+ *
+ * const client = await GrpcClient
+ *   .withUrl("http://127.0.0.1:18080")
+ *   .withPubkeyAndSigner(pubKey, signer)
+ *   .build();
+ * ```
+ *
+ * ## Example with leap wallet
+ * ```js
+ * await window.leap.enable("mocha-4")
+ * const keys = await window.leap.getKey("mocha-4")
+ *
+ * const signer = (signDoc) => {
+ *   return window.leap.signDirect("mocha-4", keys.bech32Address, signDoc, { preferNoSetFee: true })
+ *     .then(sig => Uint8Array.from(atob(sig.signature.signature), c => c.charCodeAt(0)))
+ * }
+ *
+ * const client = await GrpcClient
+ *   .withUrl("http://127.0.0.1:18080")
+ *   .withPubkeyAndSigner(keys.pubKey, signer)
+ *   .build()
+ * ```
+ */
+export class GrpcClientBuilder {
+  private constructor();
+  free(): void;
+  /**
+   * Set the `url` of the grpc-web server to connect to
+   *
+   * Note that this method **consumes** builder and returns updated instance of it.
+   * Make sure to re-assign it if you keep builder in a variable.
+   */
+  withUrl(url: string): GrpcClientBuilder;
+  /**
+   * Add public key and signer to the client being built
+   *
+   * Note that this method **consumes** builder and returns updated instance of it.
+   * Make sure to re-assign it if you keep builder in a variable.
+   */
+  withPubkeyAndSigner(account_pubkey: Uint8Array, signer_fn: SignerFn): GrpcClientBuilder;
+  /**
+   * Appends ascii metadata to all requests made by the client.
+   *
+   * Note that this method **consumes** builder and returns updated instance of it.
+   * Make sure to re-assign it if you keep builder in a variable.
+   */
+  withMetadata(key: string, value: string): GrpcClientBuilder;
+  /**
+   * Appends binary metadata to all requests made by the client.
+   *
+   * Keys for binary metadata must have `-bin` suffix.
+   *
+   * Note that this method **consumes** builder and returns updated instance of it.
+   * Make sure to re-assign it if you keep builder in a variable.
+   */
+  withMetadataBin(key: string, value: Uint8Array): GrpcClientBuilder;
+  /**
+   * build gRPC client
+   */
+  build(): GrpcClient;
 }
 /**
  * Block Header values contain metadata about the block and about the consensus,
@@ -2005,6 +2158,16 @@ export class NodeConfig {
    * A list of bootstrap peers to connect to.
    */
   bootnodes: string[];
+  /**
+   * Optionally start with a provided private key used as libp2p identity. Expects 32 bytes
+   * containing ed25519 secret key.
+   */
+  get identity_key(): Uint8Array | undefined;
+  /**
+   * Optionally start with a provided private key used as libp2p identity. Expects 32 bytes
+   * containing ed25519 secret key.
+   */
+  set identity_key(value: Uint8Array | null | undefined);
   /**
    * Whether to store data in persistent memory or not.
    *
@@ -2280,146 +2443,6 @@ export class TxBody {
    */
   readonly timeout_height: bigint;
 }
-/**
- * Celestia grpc transaction client.
- */
-export class TxClient {
-  free(): void;
-  /**
-   * Create a new transaction client with the specified account.
-   *
-   * Url must point to a [grpc-web proxy](https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-WEB.md).
-   *
-   * # Example with noble/curves
-   * ```js
-   * import { secp256k1 } from "@noble/curves/secp256k1";
-   *
-   * const privKey = "fdc8ac75dfa1c142dbcba77938a14dd03078052ce0b49a529dcf72a9885a3abb";
-   * const pubKey = secp256k1.getPublicKey(privKey);
-   *
-   * const signer = (signDoc) => {
-   *   const bytes = protoEncodeSignDoc(signDoc);
-   *   const sig = secp256k1.sign(bytes, privKey, { prehash: true });
-   *   return sig.toCompactRawBytes();
-   * };
-   *
-   * const txClient = await new TxClient("http://127.0.0.1:18080", pubKey, signer);
-   * ```
-   *
-   * # Example with leap wallet
-   * ```js
-   * await window.leap.enable("mocha-4")
-   * const keys = await window.leap.getKey("mocha-4")
-   *
-   * const signer = (signDoc) => {
-   *   return window.leap.signDirect("mocha-4", keys.bech32Address, signDoc, { preferNoSetFee: true })
-   *     .then(sig => Uint8Array.from(atob(sig.signature.signature), c => c.charCodeAt(0)))
-   * }
-   *
-   * const tx_client = await new TxClient("http://127.0.0.1:18080", keys.pubKey, signer)
-   * ```
-   */
-  constructor(url: string, pubkey: Uint8Array, signer_fn: SignerFn);
-  /**
-   * estimate_gas_price takes a transaction priority and estimates the gas price based
-   * on the gas prices of the transactions in the last five blocks.
-   *
-   * If no transaction is found in the last five blocks, return the network
-   * min gas price.
-   */
-  getEstimateGasPrice(priority: TxPriority): Promise<number>;
-  /**
-   * Submit blobs to the celestia network.
-   *
-   * When no `TxConfig` is provided, client will automatically calculate needed
-   * gas and update the `gasPrice`, if network agreed on a new minimal value.
-   * To enforce specific values use a `TxConfig`.
-   *
-   * # Example
-   * ```js
-   * const ns = Namespace.newV0(new Uint8Array([97, 98, 99]));
-   * const data = new Uint8Array([100, 97, 116, 97]);
-   * const blob = new Blob(ns, data, AppVersion.latest());
-   *
-   * const txInfo = await txClient.submitBlobs([blob]);
-   * await txClient.submitBlobs([blob], { gasLimit: 100000n, gasPrice: 0.02, memo: "foo" });
-   * ```
-   *
-   * # Note
-   *
-   * Provided blobs will be consumed by this method, meaning
-   * they will no longer be accessible. If this behavior is not desired,
-   * consider using `Blob.clone()`.
-   *
-   * ```js
-   * const blobs = [blob1, blob2, blob3];
-   * await txClient.submitBlobs(blobs.map(b => b.clone()));
-   * ```
-   */
-  submitBlobs(blobs: Blob[], tx_config?: TxConfig | null): Promise<TxInfo>;
-  /**
-   * Submit message to the celestia network.
-   *
-   * When no `TxConfig` is provided, client will automatically calculate needed
-   * gas and update the `gasPrice`, if network agreed on a new minimal value.
-   * To enforce specific values use a `TxConfig`.
-   *
-   * # Example
-   * ```js
-   * import { Registry } from "@cosmjs/proto-signing";
-   *
-   * const registry = new Registry();
-   * const sendMsg = {
-   *   typeUrl: "/cosmos.bank.v1beta1.MsgSend",
-   *   value: {
-   *     fromAddress: "celestia169s50psyj2f4la9a2235329xz7rk6c53zhw9mm",
-   *     toAddress: "celestia1t52q7uqgnjfzdh3wx5m5phvma3umrq8k6tq2p9",
-   *     amount: [{ denom: "utia", amount: "10000" }],
-   *   },
-   * };
-   * const sendMsgAny = registry.encodeAsAny(sendMsg);
-   *
-   * const txInfo = await txClient.submitMessage(sendMsgAny);
-   * ```
-   */
-  submitMessage(message: ProtoAny, tx_config?: TxConfig | null): Promise<TxInfo>;
-  /**
-   * Get auth params
-   */
-  getAuthParams(): Promise<AuthParams>;
-  /**
-   * Get account
-   */
-  getAccount(account: string): Promise<BaseAccount>;
-  /**
-   * Get accounts
-   */
-  getAccounts(): Promise<BaseAccount[]>;
-  /**
-   * Get balance of coins with given denom
-   */
-  getBalance(address: string, denom: string): Promise<Coin>;
-  /**
-   * Get balance of all coins
-   */
-  getAllBalances(address: string): Promise<Coin[]>;
-  /**
-   * Get balance of all spendable coins
-   */
-  getSpendableBalances(address: string): Promise<Coin[]>;
-  /**
-   * Get total supply
-   */
-  getTotalSupply(): Promise<Coin[]>;
-  /**
-   * Chain id of the client
-   */
-  readonly chainId: string;
-  /**
-   * AppVersion of the client
-   */
-  readonly appVersion: AppVersion;
-}
 /**
  * Response to a tx query
  */