lumina-node-wasm 0.12.0 → 0.13.0

package/lumina_node_wasm.d.ts

@@ -478,6 +478,24 @@ type ReadableStreamType = "bytes";
       height: bigint;
     }
 
+    /**
+     * A transaction that was broadcasted
+     */
+    export interface BroadcastedTx {
+      /**
+       * Broadcasted bytes
+       */
+      tx: Uint8Array;
+      /**
+       * Transaction hash
+       */
+      hash: string;
+      /**
+       * Transaction sequence
+       */
+      sequence: bigint;
+    }
+
     /**
      * Transaction config.
      */
@@ -755,6 +773,29 @@ export class BlobParams {
    */
   gov_max_square_size: bigint;
 }
+/**
+ * List of blobs together with height they were published at
+ */
+export class BlobsAtHeight {
+  private constructor();
+/**
+** Return copy of self without private attributes.
+*/
+  toJSON(): Object;
+/**
+* Return stringified version of self.
+*/
+  toString(): string;
+  free(): void;
+  /**
+   * Height the blobs were published at
+   */
+  height: bigint;
+  /**
+   * Published blobs
+   */
+  blobs: Blob[];
+}
 /**
  * Blocks consist of a header, transactions, votes (the commit), and a list of
  * evidence of malfeasance (i.e. signing conflicting votes).
@@ -1129,7 +1170,7 @@ export class Data {
  * # fn extended_header() -> ExtendedHeader {
  * #     unimplemented!();
  * # }
- * # fn shares_with_proof(_: Height, _: &Namespace) -> (Vec<Share>, NamespaceProof) {
+ * # fn shares_with_proof(_: u64, _: &Namespace) -> (Vec<Share>, NamespaceProof) {
  * #     unimplemented!();
  * # }
  * // fetch the block header and data for your namespace
@@ -1439,6 +1480,22 @@ export class GrpcClient {
    * Issue a direct ABCI query to the application
    */
   abciQuery(data: Uint8Array, path: string, height: bigint, prove: boolean): Promise<AbciQueryResponse>;
+  /**
+   * Confirm transaction broadcasted with [`broadcast_blobs`] or [`broadcast_message`].
+   *
+   * # 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 broadcastedTx = await txClient.broadcastBlobs([blob]);
+   * console.log("Tx hash:", broadcastedTx.hash);
+   * const txInfo = await txClient.confirmTx(broadcastedTx);
+   * console.log("Confirmed at height:", txInfo.height);
+   * ```
+   */
+  confirmTx(broadcasted_tx: BroadcastedTx, tx_config?: TxConfig | null): Promise<TxInfo>;
   /**
    * Get account
    */
@@ -1502,6 +1559,32 @@ export class GrpcClient {
    * ```
    */
   submitMessage(message: ProtoAny, tx_config?: TxConfig | null): Promise<TxInfo>;
+  /**
+   * Broadcast blobs to the celestia network, and return without confirming.
+   *
+   * # 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 broadcastedTx = await txClient.broadcastBlobs([blob]);
+   * console.log("Tx hash:", broadcastedTx.hash);
+   * const txInfo = await txClient.confirmTx(broadcastedTx);
+   * ```
+   *
+   * # 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.broadcastBlobs(blobs.map(b => b.clone()));
+   * ```
+   */
+  broadcastBlobs(blobs: Blob[], tx_config?: TxConfig | null): Promise<BroadcastedTx>;
   /**
    * Get auth params
    */
@@ -1526,6 +1609,30 @@ export class GrpcClient {
    * Get total supply
    */
   getTotalSupply(): Promise<Coin[]>;
+  /**
+   * Broadcast message to the celestia network, and return without confirming.
+   *
+   * # 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 broadcastedTx = await txClient.broadcastMessage(sendMsgAny);
+   * console.log("Tx hash:", broadcastedTx.hash);
+   * const txInfo = await txClient.confirmTx(broadcastedTx);
+   * ```
+   */
+  broadcastMessage(message: ProtoAny, tx_config?: TxConfig | null): Promise<BroadcastedTx>;
   /**
    * Estimate gas price for given transaction priority based
    * on the gas prices of the transactions in the last five blocks.
@@ -1569,6 +1676,13 @@ export class GrpcClient {
    * Get status of the transaction
    */
   txStatus(hash: string): Promise<TxStatusResponse>;
+  /**
+   * Create a builder for [`GrpcClient`] with multiple URL endpoints for fallback support.
+   *
+   * When multiple endpoints are configured, the client will automatically
+   * fall back to the next endpoint if a network-related error occurs.
+   */
+  static withUrls(urls: string[]): GrpcClientBuilder;
   /**
    * AppVersion of the client
    */
@@ -1588,6 +1702,7 @@ export class GrpcClient {
  * ```js
  * const client = await GrpcClient
  *   .withUrl("http://127.0.0.1:18080")
+ *   .withTimeout(5000)  // Optional: 5 second timeout
  *   .build()
  * ```
  *
@@ -1631,6 +1746,13 @@ export class GrpcClient {
 export class GrpcClientBuilder {
   private constructor();
   free(): void;
+  /**
+   * Sets the request timeout in milliseconds, overriding default one from the transport.
+   *
+   * 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.
+   */
+  withTimeout(timeout_ms: bigint): GrpcClientBuilder;
   /**
    * Appends ascii metadata to all requests made by the client.
    *
@@ -1665,6 +1787,16 @@ export class GrpcClientBuilder {
    * Make sure to re-assign it if you keep builder in a variable.
    */
   withUrl(url: string): GrpcClientBuilder;
+  /**
+   * Add multiple URL endpoints at once for fallback support.
+   *
+   * When multiple endpoints are configured, the client will automatically
+   * fall back to the next endpoint if a network-related error occurs.
+   *
+   * 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.
+   */
+  withUrls(urls: string[]): GrpcClientBuilder;
 }
 /**
  * Block Header values contain metadata about the block and about the consensus,
@@ -1773,6 +1905,21 @@ export class IntoUnderlyingSource {
   pull(controller: ReadableStreamDefaultController): Promise<any>;
   cancel(): void;
 }
+export class IteratorResultObject {
+  private constructor();
+  free(): void;
+  /**
+   * Has the value true if the iterator is past the end of the
+   * iterated sequence. In this case value optionally specifies
+   * the return value of the iterator.
+   */
+  done: boolean;
+  /**
+   * Any JavaScript value returned by the iterator.
+   * Can be omitted when done is true.
+   */
+  value: any;
+}
 /**
  * Array of bits
  */
@@ -2053,6 +2200,13 @@ export class NodeClient {
    * Get node's local peer ID.
    */
   localPeerId(): Promise<string>;
+  /**
+   * Subscribe to the shares from the namespace, as new headers are received by the node
+   *
+   * Return an async iterator which will yield all the blobs from the namespace, as the new headers
+   * are being received by the node, starting from the first header received after the call.
+   */
+  blobSubscribe(namespace: Namespace): Promise<AsyncIterable<BlobsAtHeight | SubscriptionError>>;
   /**
    * Returns a [`BroadcastChannel`] for events generated by [`Node`].
    */
@@ -2069,6 +2223,13 @@ export class NodeClient {
    * Get all the peers that node is connected to.
    */
   connectedPeers(): Promise<Array<any>>;
+  /**
+   * Subscribe to new headers received by the node from the network.
+   *
+   * Return an async iterator which will yield all the headers, as they are being received by the
+   * node, starting from the first header received after the call.
+   */
+  headerSubscribe(): Promise<AsyncIterable<ExtendedHeader | SubscriptionError>>;
   /**
    * Get current [`PeerTracker`] info.
    */
@@ -2082,6 +2243,13 @@ export class NodeClient {
    * Get a synced header for the block with a given hash.
    */
   getHeaderByHash(hash: string): Promise<ExtendedHeader>;
+  /**
+   * Subscribe to the blobs from the namespace, as new headers are received by the node
+   *
+   * Return an async iterator which will yield all the shares from the namespace, as the new headers
+   * are being received by the node, starting from the first header received after the call.
+   */
+  namespaceSubscribe(namespace: Namespace): Promise<AsyncIterable<SharesAtHeight | SubscriptionError>>;
   /**
    * Request the head header from the network.
    */
@@ -2318,6 +2486,58 @@ export class SamplingMetadata {
    */
   readonly cids: Uint8Array[];
 }
+/**
+ * A single fixed-size chunk of data which is used to form an [`ExtendedDataSquare`].
+ *
+ * All data in Celestia is split into [`Share`]s before being put into a
+ * block's data square. See [`Blob::to_shares`].
+ *
+ * All shares have the fixed size of 512 bytes and the following structure:
+ *
+ * ```text
+ * | Namespace | InfoByte | (optional) sequence length | data |
+ * ```
+ *
+ * `sequence length` is the length of the original data in bytes and is present only in the first of the shares the data was split into.
+ *
+ * [`ExtendedDataSquare`]: crate::eds::ExtendedDataSquare
+ * [`Blob::to_shares`]: crate::Blob::to_shares
+ */
+export class Share {
+  private constructor();
+/**
+** Return copy of self without private attributes.
+*/
+  toJSON(): Object;
+/**
+* Return stringified version of self.
+*/
+  toString(): string;
+  free(): void;
+}
+/**
+ * A list of shares that were published at particular height.
+ */
+export class SharesAtHeight {
+  private constructor();
+/**
+** Return copy of self without private attributes.
+*/
+  toJSON(): Object;
+/**
+* Return stringified version of self.
+*/
+  toString(): string;
+  free(): void;
+  /**
+   * height the shares were published at
+   */
+  height: bigint;
+  /**
+   * shares published
+   */
+  shares: Share[];
+}
 /**
  * Signature
  */
@@ -2376,6 +2596,25 @@ export class StringEvent {
   type: string;
   attributes: Attribute[];
 }
+/**
+ * Error thrown while processing subscription
+ */
+export class SubscriptionError {
+  private constructor();
+  free(): void;
+  /**
+   * Height at which the error occurred, if applicable
+   */
+  get height(): bigint | undefined;
+  /**
+   * Height at which the error occurred, if applicable
+   */
+  set height(value: bigint | null | undefined);
+  /**
+   * error message
+   */
+  error: string;
+}
 /**
  * Status of the synchronization.
  */