@tari-project/ootle-ts-bindings 1.49.1 → 1.50.1

package/dist/helpers/helpers.js

@@ -58,6 +58,10 @@ export function shortenSubstateId(substateId, start = 4, end = 4) {
     return parts[0] + "_" + shortenString(parts[1], start, end);
 }
 export function shortenString(string, start = 8, end = 8) {
+    // The number 3 is from the characters for ellipsis
+    if (string.length < start + end + 3) {
+        return string;
+    }
     return string.substring(0, start) + "..." + string.slice(-end);
 }
 export function rejectReasonToString(reason) {

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

@@ -1,6 +1,7 @@
 export * from "./types/tari-indexer-client/IndexerSubmitTransactionResponse";
 export * from "./types/tari-indexer-client/GetTransactionReceiptResponse";
 export * from "./types/tari-indexer-client/GetNetworkInfoResponse";
+export * from "./types/tari-indexer-client/GetIndexerInfoResponse";
 export * from "./types/tari-indexer-client/WatchedSubstateItem";
 export * from "./types/tari-indexer-client/GetUtxoUpdatesRequest";
 export * from "./types/tari-indexer-client/WatchedTemplateItem";
@@ -8,6 +9,7 @@ export * from "./types/tari-indexer-client/ValidatorConsensusState";
 export * from "./types/tari-indexer-client/StreamTransactionEventsRequest";
 export * from "./types/tari-indexer-client/QueryTransactionEventsRequest";
 export * from "./types/tari-indexer-client/TransactionEntry";
+export * from "./types/tari-indexer-client/TransactionSource";
 export * from "./types/tari-indexer-client/InspectSubstateRequest";
 export * from "./types/tari-indexer-client/ListSubstateItem";
 export * from "./types/tari-indexer-client/IndexerTransactionFinalizedResult";

package/dist/tari-indexer-client.js

@@ -3,6 +3,7 @@
 export * from "./types/tari-indexer-client/IndexerSubmitTransactionResponse";
 export * from "./types/tari-indexer-client/GetTransactionReceiptResponse";
 export * from "./types/tari-indexer-client/GetNetworkInfoResponse";
+export * from "./types/tari-indexer-client/GetIndexerInfoResponse";
 export * from "./types/tari-indexer-client/WatchedSubstateItem";
 export * from "./types/tari-indexer-client/GetUtxoUpdatesRequest";
 export * from "./types/tari-indexer-client/WatchedTemplateItem";
@@ -10,6 +11,7 @@ export * from "./types/tari-indexer-client/ValidatorConsensusState";
 export * from "./types/tari-indexer-client/StreamTransactionEventsRequest";
 export * from "./types/tari-indexer-client/QueryTransactionEventsRequest";
 export * from "./types/tari-indexer-client/TransactionEntry";
+export * from "./types/tari-indexer-client/TransactionSource";
 export * from "./types/tari-indexer-client/InspectSubstateRequest";
 export * from "./types/tari-indexer-client/ListSubstateItem";
 export * from "./types/tari-indexer-client/IndexerTransactionFinalizedResult";

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

@@ -0,0 +1,62 @@
+import type { Epoch } from "../Epoch";
+import type { Network } from "../Network";
+import type { RistrettoPublicKeyBytes } from "../RistrettoPublicKeyBytes";
+/**
+ * The configuration of a single indexer node, as far as it affects what its API returns. Every field
+ * is local to the node answering the request: two indexers on the same network can disagree on all of
+ * them, so a client that cares must ask the node it is talking to.
+ */
+export type GetIndexerInfoResponse = {
+    /**
+     * The indexer's build version.
+     */
+    version: string;
+    network: Network;
+    network_byte: number;
+    /**
+     * The sidechain this indexer follows, if it is configured for one.
+     */
+    sidechain_id: RistrettoPublicKeyBytes | null;
+    /**
+     * The current epoch, so a client can resolve the epoch-denominated fields below against a clock
+     * without a second request.
+     */
+    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.
+     */
+    transaction_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
+     * this indexer until its receipt is synced.
+     *
+     * 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
+     * for them.
+     */
+    index_gossiped_transactions: boolean;
+    /**
+     * Whether substates served by this indexer are verified against a shard group committee proof
+     * before being returned. When false, values are served as fetched from a single validator and
+     * carry no proof of correctness.
+     */
+    verify_substate_proofs: boolean;
+    /**
+     * How long this indexer may serve a cached substate as the latest version of that substate, in
+     * seconds. A read of the latest version may be up to this stale; reads of a specific version are
+     * unaffected.
+     */
+    latest_substate_cache_ttl_secs: bigint;
+    /**
+     * Whether this indexer stores every event on the network. When false it is configured with event
+     * filters, so event queries answer over a subset and absence is not proof an event did not occur.
+     */
+    indexes_all_events: boolean;
+};

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

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

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

@@ -1,5 +1,11 @@
 import type { TransactionId } from "../TransactionId";
+import type { TransactionSource } from "./TransactionSource";
 export type ListRecentTransactionsRequest = {
     limit: number | null;
     last_id: TransactionId | null;
+    /**
+     * Restrict the listing to transactions from this source. Omitted, transactions from every
+     * source are listed.
+     */
+    source: TransactionSource | null;
 };

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

@@ -1,6 +1,7 @@
 import type { PrunedTransaction } from "../PrunedTransaction";
 import type { TransactionId } from "../TransactionId";
 import type { TransactionResultSummary } from "./TransactionResultSummary";
+import type { TransactionSource } from "./TransactionSource";
 export type TransactionEntry = {
     transaction_id: TransactionId;
     /**
@@ -19,4 +20,8 @@ export type TransactionEntry = {
      * this indexer. None if the transaction was not rejected at submission.
      */
     rejected_reason: string | null;
+    /**
+     * Where this indexer learned of the transaction.
+     */
+    source: TransactionSource;
 };

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

@@ -0,0 +1,4 @@
+/**
+ * Where an indexer learned of a transaction it has stored.
+ */
+export type TransactionSource = "local" | "gossip";

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

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/package.json

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