@tari-project/ootle-ts-bindings 1.34.0 → 1.34.1

package/dist/index.d.ts

@@ -10,8 +10,8 @@ export * from "./types/ArgDef";
 export * from "./types/Assertion";
 export * from "./types/AuthHook";
 export * from "./types/BlobHashes";
-export * from "./types/Blob";
 export * from "./types/Blobs";
+export * from "./types/Blob";
 export * from "./types/BlockHeader";
 export * from "./types/BlockId";
 export * from "./types/Block";

package/dist/index.js

@@ -12,8 +12,8 @@ export * from "./types/ArgDef";
 export * from "./types/Assertion";
 export * from "./types/AuthHook";
 export * from "./types/BlobHashes";
-export * from "./types/Blob";
 export * from "./types/Blobs";
+export * from "./types/Blob";
 export * from "./types/BlockHeader";
 export * from "./types/BlockId";
 export * from "./types/Block";

package/dist/types/Blob.d.ts

@@ -1,10 +1,12 @@
 /**
  * An opaque, content-addressed payload referenced from a transaction's instructions by index.
  *
- * Blobs are the prunable side-channel of a transaction: only their per-blob hashes participate
- * in the signing domain, so blob payloads can be dropped post-finalization without affecting
- * signature verifiability or the transaction id.
+ * Blobs are the prunable side-channel of a transaction: the bytes themselves are not bound
+ * directly into the signing domain — only their per-blob hashes are. Once a transaction has
+ * been finalized and its retention window has elapsed, blob payloads can be discarded without
+ * affecting the transaction id or signature verifiability.
  *
- * JSON encoding is base64.
+ * JSON encoding is base64 (matches `PublishTemplate` binary today). Borsh and CBOR use the
+ * `Bytes` byte-array form.
  */
 export type Blob = string;

package/dist/types/BlobHashes.d.ts

@@ -2,5 +2,10 @@ import type { Hash32 } from "./Hash32";
 /**
  * A typed collection of per-blob commitments — the prunable surrogate of `Blobs` in the
  * signing domain.
+ *
+ * The only public way to obtain a non-default `BlobHashes` is via `Blobs::hashes()`. There is
+ * no `from_raw` constructor: anywhere a `BlobHashes` appears, it either originated from
+ * hashing real blobs or arrived via deserialization of bytes previously written by this
+ * crate's storage layer (and is bound by a signature, so tampering is detectable).
  */
 export type BlobHashes = Array<Hash32>;

package/dist/types/Blobs.d.ts

@@ -1,6 +1,6 @@
 import type { Blob } from "./Blob";
 /**
- * Ordered collection of blobs carried by a transaction. Index 0 is the first blob, etc.
- * Instructions and arguments reference blobs by `BlobIndex` (number) into this list.
+ * Ordered collection of `Blob`s carried by a transaction. Index 0 corresponds to the first
+ * blob, etc. Instructions and arguments reference blobs by `BlobIndex` into this list.
  */
 export type Blobs = Array<Blob>;

package/dist/types/BlockHeader.d.ts

@@ -41,7 +41,7 @@ export type BlockHeader = {
     /**
      * The total leader fee for this block. This should match the sum of the leader fees in the block's body.
      */
-    total_leader_fee: number;
+    total_leader_fee: bigint;
     /**
      * A Merkle root hash committing to all state after this block has been applied.
      */
@@ -58,7 +58,7 @@ export type BlockHeader = {
      * The Unix Epoch timestamp indicating the creation time of the block. Currently, this can be chosen arbitrarily
      * and is only informational/used for metrics.
      */
-    timestamp: number;
+    timestamp: bigint;
     /**
      * The epoch hash is a hash given by the epoch oracle. E.g. the base layer epoch oracle gives the first block hash
      * of the epoch.

package/dist/types/ForeignProposalAtom.d.ts

@@ -1,4 +1,5 @@
+import type { ShardGroup } from "./ShardGroup";
 export type ForeignProposalAtom = {
     block_id: string;
-    shard_group: number;
+    shard_group: ShardGroup;
 };

package/dist/types/ForeignProposalAtom.js

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

package/dist/types/InstructionArg.d.ts

@@ -1,8 +1,7 @@
 import type { WorkspaceOffsetId } from "./WorkspaceOffsetId";
 /**
- * Represents an argument that can be passed to a transaction instruction. Either a literal
- * value, a reference to an item on the runtime's workspace, or a reference to a transaction
- * blob by index. Use `Blob` for large/opaque data; prefer `Literal` for small values.
+ * Represents an argument that can be passed to a transaction instruction. Either a literal value or a reference to a
+ * item on the runtime's workspace, or a reference to a transaction blob by index.
  */
 export type InstructionArg = {
     Workspace: WorkspaceOffsetId;

package/dist/types/LeaderFee.d.ts

@@ -1,4 +1,4 @@
 export type LeaderFee = {
-    fee: number;
-    exhaust_burn: number;
+    fee: bigint;
+    exhaust_burn: bigint;
 };

package/dist/types/PrunedTransaction.d.ts

@@ -3,6 +3,9 @@ import type { PrunedTransactionV1 } from "./PrunedTransactionV1";
  * Pruned, archive-only counterpart of `Transaction`. Carries blob commitments instead of
  * blob payloads, so API responses can omit the raw bytes while preserving the `TransactionId`,
  * signature verifiability, and the structural shape the UI needs to display.
+ *
+ * Constructed only via `From<Transaction>` (which derives commitments from the full blobs and
+ * drops the payloads) or via deserialization of bytes previously written by the storage layer.
  */
 export type PrunedTransaction = {
     V1: PrunedTransactionV1;

package/dist/types/PrunedTransactionV1.d.ts

@@ -1,9 +1,11 @@
 import type { PrunedUnsealedTransactionV1 } from "./PrunedUnsealedTransactionV1";
 import type { TransactionSealSignature } from "./TransactionSealSignature";
 /**
- * Pruned, archive-only counterpart of `TransactionV1`. Carries blob commitments instead of
- * blob payloads. Produces the same `TransactionId` and verifies the same signatures as the
- * full form.
+ * Pruned, archive-only counterpart of `TransactionV1`.
+ *
+ * Constructed only via `From<TransactionV1>` (which derives blob commitments from the full
+ * blobs and drops the payloads) or via deserialization of bytes previously written by the
+ * storage layer.
  */
 export type PrunedTransactionV1 = {
     body: PrunedUnsealedTransactionV1;

package/dist/types/PrunedUnsignedTransactionV1.d.ts

@@ -18,13 +18,14 @@ export type PrunedUnsignedTransactionV1 = {
     is_seal_signer_authorized: boolean;
     dry_run: boolean;
     /**
-     * Per-blob commitments. Mirrors `UnsignedTransactionV1.blobs.hashes()` of the full form.
+     * Per-blob commitments. Mirrors `UnsignedTransactionV1::blobs.hashes()` of the full form.
      */
     blob_hashes: BlobHashes;
     /**
-     * Byte size of each blob, parallel to `blob_hashes`. Not part of the signing/id digest;
-     * populated at conversion time so UIs can display blob sizes without downloading payloads.
-     * May be empty when deserialised from older archives that didn't record sizes.
+     * Byte size of each blob, parallel to `blob_hashes`. **Not part of the signing/id domain**
+     * — populated at conversion time from `Blobs` so that API consumers and UIs can show
+     * blob sizes without downloading payloads. May be empty when deserialised from older
+     * archives that didn't record sizes.
      */
     blob_sizes: Array<number>;
 };

package/dist/types/TransactionAtom.d.ts

@@ -5,6 +5,6 @@ export type TransactionAtom = {
     id: string;
     decision: Decision;
     evidence: Evidence;
-    transaction_fee: number;
+    transaction_fee: bigint;
     leader_fee: LeaderFee | null;
 };

package/dist/types/TransactionPoolRecord.d.ts

@@ -9,7 +9,7 @@ export type TransactionPoolRecord = {
     transaction_id: string;
     evidence: Evidence;
     is_global: boolean;
-    transaction_fee: number;
+    transaction_fee: bigint;
     leader_fee: LeaderFee | null;
     stage: TransactionPoolStage;
     pending_stage: TransactionPoolStage | null;

package/dist/types/UnsignedTransactionV1.d.ts

@@ -15,8 +15,10 @@ export type UnsignedTransactionV1 = {
     is_seal_signer_authorized: boolean;
     dry_run: boolean;
     /**
-     * Prunable side-channel of opaque payloads referenced by instructions via BlobIndex.
-     * Only the per-blob commitments participate in the signing domain.
+     * Prunable side-channel of opaque payloads referenced by instructions via `BlobIndex`.
+     * Only the per-blob commitments (`blobs.hashes()`) participate in the signing domain —
+     * raw blob bytes are excluded so that storage layers can drop them without affecting
+     * signature verifiability or transaction id.
      */
     blobs: Blobs;
 };

package/dist/types/UnspentOutput.d.ts

@@ -23,7 +23,7 @@ export type UnspentOutput = {
      * Encrypted mask and value for the recipient.
      */
     encrypted_data: EncryptedData;
-    minimum_value_promise: number;
+    minimum_value_promise: bigint;
     /**
      * If the view key is enabled for a given resource, this proof MUST be provided, otherwise it MUST NOT.
      */

package/dist/types/WalletTransaction.d.ts

@@ -6,8 +6,9 @@ import type { NewAccountData } from "./wallet-types/NewAccountData";
 export type WalletTransaction = {
     id: string;
     /**
-     * Pruned transaction — blob commitments are present but raw blob payloads are omitted to
-     * keep API responses small.
+     * The transaction in its pruned (blob-bytes-stripped) form. Blob commitments are retained
+     * so the `TransactionId` and signatures remain verifiable. Wallet daemon storage keeps the
+     * full form on disk for re-submission, but the public API returns this slimmer view.
      */
     transaction: PrunedTransaction;
     status: TransactionStatus;

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

@@ -1,6 +1,6 @@
 import type { ResourceAddress } from "../ResourceAddress";
 export type GetNonFungiblesRequest = {
     address: ResourceAddress;
-    start_index: number;
-    end_index: number;
+    start_index: bigint;
+    end_index: bigint;
 };

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

@@ -5,6 +5,6 @@ export type IndexerGetEpochManagerStatsResponse = {
      * The current epoch according to the indexer's epoch oracle view
      */
     current_epoch: Epoch;
-    current_block_height: number;
+    current_block_height: bigint;
     current_block_hash: Hash32;
 };

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

@@ -3,7 +3,8 @@ import type { TransactionId } from "../TransactionId";
 export type TransactionEntry = {
     transaction_id: TransactionId;
     /**
-     * Pruned transaction — blob commitments retained, raw blob bytes omitted.
+     * Pruned transaction — blob commitments retained, raw blob bytes omitted to keep the
+     * response size bounded. The transaction id and signatures remain verifiable.
      */
     transaction: PrunedTransaction;
     created_at: string;

package/dist/types/validator-node-client/GetBlocksCountResponse.d.ts

@@ -1,3 +1,3 @@
 export type GetBlocksCountResponse = {
-    count: number;
+    count: bigint;
 };

package/dist/types/validator-node-client/GetEpochManagerStatsResponse.d.ts

@@ -2,7 +2,7 @@ import type { CommitteeInfo } from "../CommitteeInfo";
 import type { Epoch } from "../Epoch";
 export type GetEpochManagerStatsResponse = {
     current_epoch: Epoch;
-    current_block_height: number;
+    current_block_height: bigint;
     current_block_hash: string;
     is_valid: boolean;
     is_initial_scanning_complete: boolean;

package/dist/types/validator-node-client/VNCommitteeShardInfo.d.ts

@@ -1,7 +1,8 @@
+import type { Shard } from "../Shard";
 import type { SubstateAddress } from "../SubstateAddress";
 import type { ValidatorNode } from "./ValidatorNode";
 export type VNCommitteeShardInfo = {
-    shard: number;
+    shard: Shard;
     substate_address_range: {
         start: SubstateAddress;
         end: SubstateAddress;

package/dist/types/validator-node-client/VNLogEntry.d.ts

@@ -1,6 +1,6 @@
 import type { VNLogLevel } from "./VNLogLevel";
 export type VNLogEntry = {
-    timestamp: number;
+    timestamp: bigint;
     message: string;
     level: VNLogLevel;
 };

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

@@ -1,5 +1,5 @@
 import type { ComponentAddressOrName } from "./ComponentAddressOrName";
 export type AccountsCreateFreeTestCoinsRequest = {
     account: ComponentAddressOrName;
-    max_fee: number | null;
+    max_fee: bigint;
 };

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

@@ -7,7 +7,7 @@ export type AccountsCreateFreeTestCoinsResponse = {
     account: Account;
     transaction_id: TransactionId;
     amount: Amount;
-    fee: number;
+    fee: bigint;
     result: FinalizeResult;
     address: OotleAddress;
 };

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

@@ -1,5 +1,5 @@
 import type { AccountInfo } from "./AccountInfo";
 export type AccountsListResponse = {
     accounts: Array<AccountInfo>;
-    total: number;
+    total: bigint;
 };

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

@@ -7,7 +7,7 @@ export type AccountsTransferRequest = {
     amount: Amount;
     resource_address: ResourceAddress;
     destination_public_key: RistrettoPublicKeyBytes;
-    max_fee: number | null;
+    max_fee: bigint;
     proof_from_badge_resource: ResourceAddress | null;
     dry_run: boolean;
 };

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

@@ -4,8 +4,7 @@ import type { ComponentAddressOrName } from "./ComponentAddressOrName";
 export type CallInstructionRequest = {
     instructions: Array<Instruction>;
     fee_account: ComponentAddressOrName;
-    dump_outputs_into: ComponentAddressOrName | null;
-    max_fee: number;
+    max_fee: bigint;
     inputs: Array<SubstateRequirement>;
     override_inputs: boolean | null;
     new_outputs: number | null;

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

@@ -3,6 +3,6 @@ import type { ComponentAddressOrName } from "./ComponentAddressOrName";
 export type ClaimBurnRequest = {
     account: ComponentAddressOrName;
     claim_proof: ClaimBurnProof;
-    max_fee: number | null;
+    max_fee: bigint;
     is_dry_run: boolean;
 };

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

@@ -3,7 +3,7 @@ import type { ComponentAddressOrName } from "./ComponentAddressOrName";
 export type ClaimValidatorFeesRequest = {
     account: ComponentAddressOrName | null;
     claim_key_index: number | null;
-    max_fee: number | null;
+    max_fee: bigint;
     shards: Array<Shard>;
     dry_run: boolean;
 };

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

@@ -2,6 +2,6 @@ import type { FinalizeResult } from "../FinalizeResult";
 import type { TransactionId } from "../TransactionId";
 export type ClaimValidatorFeesResponse = {
     transaction_id: TransactionId;
-    fee: number;
+    fee: bigint;
     result: FinalizeResult;
 };

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

@@ -10,7 +10,7 @@ export type ConfidentialTransferRequest = {
     input_selection: UtxoInputSelection;
     resource_address: ResourceAddress;
     destination_address: OotleAddress;
-    max_fee: number | null;
+    max_fee: bigint;
     output_to_revealed: boolean;
     proof_from_badge_resource: ResourceAddress | null;
     memo?: Memo | null;

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

@@ -3,5 +3,5 @@ export type ConfidentialViewVaultBalanceRequest = {
     vault_id: VaultId;
     minimum_expected_value: number | null;
     maximum_expected_value: number | null;
-    view_key_id: number;
+    view_key_id: bigint;
 };

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

@@ -1,5 +1,5 @@
 import type { ValidatorFeePoolAddress } from "../ValidatorFeePoolAddress";
 export type FeePoolDetails = {
     address: ValidatorFeePoolAddress;
-    amount: number;
+    amount: bigint;
 };

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

@@ -1,5 +1,5 @@
 import type { RistrettoPublicKeyBytes } from "../RistrettoPublicKeyBytes";
 export type KeysCreateResponse = {
-    id: number;
+    id: bigint;
     public_key: RistrettoPublicKeyBytes;
 };

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

@@ -1,3 +1,3 @@
 export type KeysSetActiveRequest = {
-    index: number;
+    index: bigint;
 };

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

@@ -3,5 +3,5 @@ export type MintFaucetNftRequest = {
     account: ComponentAddressOrName;
     mutable_data: object;
     number_to_mint: bigint;
-    max_fee: number | null;
+    max_fee: bigint | null;
 };

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

@@ -3,7 +3,7 @@ import type { PublishTemplateMetadata } from "./PublishTemplateMetadata";
 export type PublishTemplateRequest = {
     binary: string;
     fee_account: ComponentAddressOrName | null;
-    max_fee: number;
+    max_fee: bigint;
     /**
      * Attempt to infer inputs and their dependencies from instructions. If false, the provided transaction must
      * contain the required inputs.

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

@@ -11,6 +11,6 @@ export type StealthTransferRequest = {
     resource_address: ResourceAddress;
     badge_usage?: BadgeUsage;
     transfers: Array<StealthTransfer>;
-    max_fee: number;
+    max_fee: bigint;
     dry_run: boolean;
 };

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

@@ -1,5 +1,5 @@
 import type { AuthoredTemplate } from "./AuthoredTemplate";
 export type TemplatesListAuthoredResponse = {
     templates: Array<AuthoredTemplate>;
-    total_templates: number;
+    total_templates: bigint;
 };

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

@@ -3,8 +3,8 @@ import type { PrunedTransaction } from "../PrunedTransaction";
 import type { TransactionStatus } from "../TransactionStatus";
 export type TransactionGetResponse = {
     /**
-     * Pruned transaction — blob commitments are present but raw blob bytes are omitted to keep
-     * API responses small. Use a separate endpoint to fetch blob payloads if required.
+     * Pruned transaction — blob commitments are present but raw blob bytes are omitted to
+     * keep API responses small. Use a separate endpoint to fetch blob payloads if required.
      */
     transaction: PrunedTransaction;
     result: FinalizeResult | null;

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

@@ -9,6 +9,6 @@ export type TransactionSubmitDryRunResponse = {
      * `floor(total_bytes / 4)` by 1 at a rounding boundary). Non-refundable overcharge is
      * subtracted since it won't recur with a tighter max_fee.
      */
-    required_fees: number;
+    required_fees: bigint;
     result: ExecuteResult;
 };

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

@@ -13,11 +13,11 @@ export type TransactionSubmitManifestRequest = {
      * Additional signing keys for accounts involved in the transaction (e.g. for multi-account manifests).
      */
     signing_key_ids: Array<KeyId>;
-    max_fee: number;
+    max_fee: bigint;
     dry_run: boolean;
     /**
-     * Blob payloads referenced from the manifest via `blob!(name)`. Keys are the names used in
-     * the manifest text; values are base64-encoded byte payloads.
+     * Blob payloads referenced from the manifest via `blob!(name)`. Keys are the names used
+     * in the manifest text; values are base64-encoded byte payloads in JSON.
      */
     blobs: {
         [key in string]?: Blob;

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

@@ -5,6 +5,6 @@ export type TransactionWaitResultResponse = {
     transaction_id: TransactionId;
     result: FinalizeResult | null;
     status: TransactionStatus;
-    final_fee: number;
+    final_fee: bigint;
     timed_out: boolean;
 };

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

@@ -8,6 +8,6 @@ export type TransferNftRequest = {
     fee_payer_account: ComponentAddressOrName;
     source_account: ComponentAddressOrName;
     target_account_address: OotleAddress;
-    max_fee: number;
+    max_fee: bigint;
     dry_run: boolean;
 };

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

@@ -2,7 +2,7 @@ import type { FinalizeResult } from "../FinalizeResult";
 import type { TransactionId } from "../TransactionId";
 export type TransferNftResponse = {
     transaction_id: TransactionId;
-    fee: number;
-    fee_refunded: number;
+    fee: bigint;
+    fee_refunded: bigint;
     result: FinalizeResult;
 };

package/package.json

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