@tari-project/ootle-ts-bindings 1.55.0 → 1.57.0

package/dist/tari-indexer-client.d.ts

@@ -49,10 +49,13 @@ export * from "./types/tari-indexer-client/ListWatchedSubstatesResponse";
 export * from "./types/tari-indexer-client/ListWatchedTemplatesResponse";
 export * from "./types/tari-indexer-client/NetworkDescription";
 export * from "./types/tari-indexer-client/NonFungibleSubstate";
+export * from "./types/tari-indexer-client/ProvenTransactionReceipt";
 export * from "./types/tari-indexer-client/QueryTransactionEventsRequest";
 export * from "./types/tari-indexer-client/QueryTransactionEventsResponse";
 export * from "./types/tari-indexer-client/ScheduledBurnRate";
 export * from "./types/tari-indexer-client/StreamTransactionEventsRequest";
+export * from "./types/tari-indexer-client/SubstateProof";
+export * from "./types/tari-indexer-client/SubstateProofAnchor";
 export * from "./types/tari-indexer-client/SyncProgress";
 export * from "./types/tari-indexer-client/TemplateCatalogueItem";
 export * from "./types/tari-indexer-client/TransactionEntry";

package/dist/tari-indexer-client.js

@@ -51,10 +51,13 @@ export * from "./types/tari-indexer-client/ListWatchedSubstatesResponse";
 export * from "./types/tari-indexer-client/ListWatchedTemplatesResponse";
 export * from "./types/tari-indexer-client/NetworkDescription";
 export * from "./types/tari-indexer-client/NonFungibleSubstate";
+export * from "./types/tari-indexer-client/ProvenTransactionReceipt";
 export * from "./types/tari-indexer-client/QueryTransactionEventsRequest";
 export * from "./types/tari-indexer-client/QueryTransactionEventsResponse";
 export * from "./types/tari-indexer-client/ScheduledBurnRate";
 export * from "./types/tari-indexer-client/StreamTransactionEventsRequest";
+export * from "./types/tari-indexer-client/SubstateProof";
+export * from "./types/tari-indexer-client/SubstateProofAnchor";
 export * from "./types/tari-indexer-client/SyncProgress";
 export * from "./types/tari-indexer-client/TemplateCatalogueItem";
 export * from "./types/tari-indexer-client/TransactionEntry";

package/dist/types/tari-indexer-client/GetIndexerInfoResponse.d.ts

@@ -24,11 +24,22 @@ export type GetIndexerInfoResponse = {
     current_epoch: Epoch;
     /**
      * How many epochs past its terminal epoch this indexer retains a transaction before pruning the
-     * record. `None` means transactions are retained indefinitely. Transaction receipts are retained
-     * regardless of this setting. A client paginating transaction history hits this floor rather
-     * than the start of the chain.
+     * record. `None` means transactions are retained indefinitely. A client paginating transaction
+     * history hits this floor rather than the start of the chain.
      */
     transaction_retention_epochs: bigint | null;
+    /**
+     * How many epochs past the epoch its transaction committed in this indexer retains a transaction
+     * receipt before pruning it. `None` means receipts are retained indefinitely. Longer than
+     * `transaction_retention_epochs`, so a retained transaction always has its receipt.
+     */
+    transaction_receipt_retention_epochs: bigint | null;
+    /**
+     * How many epochs past the epoch its transaction committed in this indexer retains an event
+     * before pruning it. `None` means events are retained indefinitely. Event queries and the event
+     * stream's catch-up answer no further back than this.
+     */
+    event_retention_epochs: bigint | null;
     /**
      * Whether this indexer stores transactions observed on the network gossip topic in addition to
      * those submitted directly to it. When false, a transaction submitted elsewhere is unknown to
@@ -37,8 +48,8 @@ export type GetIndexerInfoResponse = {
      * Even when true the stored set of transactions is best effort: an indexer misses whatever was
      * gossiped while it was offline or while its inbound queue was full, and there is no backfill.
      * Transaction receipts carry no such caveat — they are synced from network state and are
-     * complete from genesis — so a committed transaction always has a receipt even when its body is
-     * missing here. Transactions that never committed get no receipt, so gossip is the only source
+     * complete back to `transaction_receipt_retention_epochs` — so a committed transaction always
+     * has a receipt even when its body is missing here. Transactions that never committed get no receipt, so gossip is the only source
      * for them.
      */
     index_gossiped_transactions: boolean;

package/dist/types/tari-indexer-client/GetNetworkEconomicsResponse.d.ts

@@ -27,6 +27,11 @@ export type GetNetworkEconomicsResponse = {
      * Circulating L2 supply: `total_claimed - receipt_exhaust_burned`.
      */
     total_supply: Amount;
+    /**
+     * Leader fees sitting in validator fee pools that validators have not yet claimed: the sum of every pool's
+     * current balance.
+     */
+    validator_claimable_fees: Amount;
     /**
      * Number of transaction receipts the indexer has stored.
      */

package/dist/types/tari-indexer-client/GetSubstatesRequest.d.ts

@@ -10,4 +10,9 @@ export type GetSubstatesRequest = {
      * which may result in more failures.
      */
     cached_only: boolean;
+    /**
+     * If true, the response carries the proof each substate was verified with. Not combinable with
+     * `cached_only`.
+     */
+    include_proofs: boolean;
 };

package/dist/types/tari-indexer-client/GetSubstatesResponse.d.ts

@@ -1,7 +1,15 @@
 import type { Substate } from "../Substate";
 import type { SubstateId } from "../SubstateId";
+import type { SubstateProof } from "./SubstateProof";
 export type GetSubstatesResponse = {
     substates: {
         [key in SubstateId]?: Substate;
     };
+    /**
+     * The proof each substate was verified with, when `include_proofs` was set. A substate no
+     * committee member could prove has no entry.
+     */
+    proofs: {
+        [key in SubstateId]?: SubstateProof;
+    };
 };

package/dist/types/tari-indexer-client/IndexerGetEpochManagerStatsResponse.d.ts

@@ -5,6 +5,13 @@ export type IndexerGetEpochManagerStatsResponse = {
      * The current epoch according to the indexer's epoch oracle view
      */
     current_epoch: Epoch;
+    /**
+     * The epoch the validators execute transactions in, as the indexer has observed from their
+     * committed blocks, held within one epoch below `current_epoch`. It trails `current_epoch` after
+     * each epoch boundary until every committee has committed its end-of-epoch block. `None` until
+     * the indexer has observed every committee.
+     */
+    consensus_epoch: Epoch | null;
     current_block_height: bigint;
     current_block_hash: Hash32;
 };

package/dist/types/tari-indexer-client/IndexerGetSubstateRequest.d.ts

@@ -2,4 +2,9 @@ import type { SubstateVersion } from "../SubstateVersion";
 export type IndexerGetSubstateRequest = {
     version: SubstateVersion | null;
     local_search_only: boolean;
+    /**
+     * If true, the response carries the proof the substate was verified with. Not combinable with
+     * `local_search_only`.
+     */
+    include_proof: boolean;
 };

package/dist/types/tari-indexer-client/IndexerGetSubstateResponse.d.ts

@@ -1,5 +1,6 @@
 import type { SubstateValue } from "../SubstateValue";
 import type { SubstateVersion } from "../SubstateVersion";
+import type { SubstateProof } from "./SubstateProof";
 export type IndexerGetSubstateResponse = {
     version: SubstateVersion;
     substate: SubstateValue;
@@ -9,4 +10,9 @@ export type IndexerGetSubstateResponse = {
      * proof yet (e.g. nothing committed since an epoch change) and the value was served unverified.
      */
     verified: boolean;
+    /**
+     * The proof the indexer verified this substate with. Present only when `include_proof` was set
+     * and a committee member could prove the substate.
+     */
+    proof?: SubstateProof;
 };

package/dist/types/tari-indexer-client/IndexerGetTransactionResultRequest.d.ts

@@ -4,4 +4,9 @@ export type IndexerGetTransactionResultRequest = {
      * The ID of the transaction to query the result for
      */
     transaction_id: TransactionId;
+    /**
+     * If true, a committed transaction's result carries its receipt and the proof that the receipt
+     * was committed.
+     */
+    include_proof: boolean;
 };

package/dist/types/tari-indexer-client/IndexerGetTransactionResultResponse.d.ts

@@ -1,8 +1,14 @@
 import type { IndexerTransactionFinalizedResult } from "./IndexerTransactionFinalizedResult";
+import type { ProvenTransactionReceipt } from "./ProvenTransactionReceipt";
 export type IndexerGetTransactionResultResponse = {
     /**
      * The result of the transaction, which may be pending (not yet finalized) or finalized with details such as the
      * final decision, execution result, and timestamps
      */
     result: IndexerTransactionFinalizedResult;
+    /**
+     * The committed transaction receipt and its proof, when `include_proof` was set and the
+     * transaction committed. An aborted transaction commits no receipt.
+     */
+    receipt?: ProvenTransactionReceipt;
 };

package/dist/types/tari-indexer-client/ProvenTransactionReceipt.d.ts

@@ -0,0 +1,15 @@
+import type { SubstateVersion } from "../SubstateVersion";
+import type { TransactionReceipt } from "../TransactionReceipt";
+import type { SubstateProof } from "./SubstateProof";
+/**
+ * A committed transaction's receipt substate, with the proof it was verified with.
+ */
+export type ProvenTransactionReceipt = {
+    version: SubstateVersion;
+    receipt: TransactionReceipt;
+    /**
+     * `None` when no committee member could prove the receipt, e.g. when nothing has been committed
+     * since an epoch change.
+     */
+    proof: SubstateProof | null;
+};

package/dist/types/tari-indexer-client/ProvenTransactionReceipt.js

@@ -0,0 +1 @@
+export {};

package/dist/types/tari-indexer-client/QueryTransactionEventsRequest.d.ts

@@ -13,5 +13,12 @@ export type QueryTransactionEventsRequest = {
      */
     resource_address?: ResourceAddress | null;
     limit: number | null;
+    /**
+     * Matches to skip, at most 10,000. Page deeper with `before_id`.
+     */
     offset: number | null;
+    /**
+     * Return only events older than this cursor. Pass the previous page's `next_before_id`.
+     */
+    before_id?: number | bigint | string | null;
 };

package/dist/types/tari-indexer-client/QueryTransactionEventsResponse.d.ts

@@ -2,4 +2,10 @@ import type { Event } from "../Event";
 import type { TransactionId } from "../TransactionId";
 export type QueryTransactionEventsResponse = {
     events: Array<[TransactionId, Event]>;
+    /**
+     * The `before_id` for the next page, or `None` once no older event can match. A wildcard
+     * topic query examines a bounded number of events per request, so a page can be short, or
+     * empty, and still carry a cursor.
+     */
+    next_before_id?: bigint | null;
 };

package/dist/types/tari-indexer-client/SubstateProof.d.ts

@@ -0,0 +1,33 @@
+import type { Epoch } from "../Epoch";
+import type { SubstateProofAnchor } from "./SubstateProofAnchor";
+/**
+ * Proof that a substate value was committed by its shard group.
+ *
+ * Two parts: a commit proof that the shard group committee committed a block whose header carries
+ * `anchor.state_merkle_root`, and a value proof that the substate's leaf is in the state tree under
+ * that root. Verifying it requires the committee for `anchor.epoch` and `anchor.shard_group`.
+ *
+ * A proof shows the value was committed at the anchor block. It says nothing about later blocks, so
+ * a caller judges freshness by the anchor's epoch and height.
+ */
+export type SubstateProof = {
+    /**
+     * The committed block the proof is anchored at, as read from `commit_proof`.
+     */
+    anchor: SubstateProofAnchor;
+    /**
+     * CBOR-encoded `SidechainBlockCommitProof`: the anchor block's header and the chain of quorum
+     * certificates that committed it.
+     */
+    commit_proof: string;
+    /**
+     * CBOR-encoded `SubstateValueProof`: the inclusion proof of the substate's leaf under
+     * `anchor.state_merkle_root`.
+     */
+    value_proof: string;
+    /**
+     * The epoch the substate's leaf value hash was computed in. It is an input to that hash, so a
+     * verifier needs it to recompute the leaf.
+     */
+    value_hash_epoch: Epoch;
+};

package/dist/types/tari-indexer-client/SubstateProof.js

@@ -0,0 +1 @@
+export {};

package/dist/types/tari-indexer-client/SubstateProofAnchor.d.ts

@@ -0,0 +1,16 @@
+import type { Epoch } from "../Epoch";
+import type { Hash32 } from "../Hash32";
+import type { ShardGroup } from "../ShardGroup";
+/**
+ * The committed block a [`SubstateProof`] is anchored at.
+ */
+export type SubstateProofAnchor = {
+    epoch: Epoch;
+    shard_group: ShardGroup;
+    height: number;
+    block_id: Hash32;
+    /**
+     * The shard group state root the block header commits.
+     */
+    state_merkle_root: Hash32;
+};

package/dist/types/tari-indexer-client/SubstateProofAnchor.js

@@ -0,0 +1 @@
+export {};

package/dist/types/wallet-types/SettingsGetResponse.d.ts

@@ -1,7 +1,14 @@
 import type { AdvancedUiFeatures } from "./AdvancedUiFeatures";
 import type { NetworkInfo } from "./NetworkInfo";
 export type SettingsGetResponse = {
+    /**
+     * The indexer the wallet is currently using, one of `indexer_urls`.
+     */
     indexer_url: string;
+    /**
+     * The configured indexers.
+     */
+    indexer_urls: Array<string>;
     network: NetworkInfo;
     advanced_ui_features: AdvancedUiFeatures;
     claimed_accounts: Array<string>;

package/dist/types/wallet-types/SettingsSetRequest.d.ts

@@ -1,6 +1,15 @@
 import type { AdvancedUiFeatures } from "./AdvancedUiFeatures";
 export type SettingsSetRequest = {
+    /**
+     * Replaces the configured indexers with this single indexer. Shorthand for a one-element `indexer_urls`; at
+     * most one of the two may be given.
+     */
     indexer_url: string | null;
+    /**
+     * Replaces the configured indexers. The wallet activates one of them at random and moves to the next when the
+     * active one stops responding.
+     */
+    indexer_urls: Array<string> | null;
     advanced_ui_features: AdvancedUiFeatures | null;
     claimed_accounts: Array<string> | null;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/ootle-ts-bindings",
-  "version": "1.55.0",
+  "version": "1.57.0",
   "private": false,
   "publishConfig": {
     "access": "public"