@tari-project/ootle-ts-bindings 1.23.3 → 1.24.1

package/dist/index.d.ts

@@ -51,8 +51,8 @@ export * from "./types/FinalizeOutcome";
 export * from "./types/FinalizeResult";
 export * from "./types/ForeignProposalAtom";
 export * from "./types/FunctionDef";
+export * from "./types/Hash32";
 export * from "./types/Hash64";
-export * from "./types/Hash";
 export * from "./types/IndexedValue";
 export * from "./types/IndexedWellKnownTypes";
 export * from "./types/InstructionArg";
@@ -85,6 +85,7 @@ export * from "./types/OwnerRule";
 export * from "./types/PayRef";
 export * from "./types/PedersenCommitmentBytes";
 export * from "./types/PeerAddress";
+export * from "./types/PrecisionAmount";
 export * from "./types/ProofId";
 export * from "./types/ProposalCertificate";
 export * from "./types/PublishedTemplateAddress";

package/dist/index.js

@@ -53,8 +53,8 @@ export * from "./types/FinalizeOutcome";
 export * from "./types/FinalizeResult";
 export * from "./types/ForeignProposalAtom";
 export * from "./types/FunctionDef";
+export * from "./types/Hash32";
 export * from "./types/Hash64";
-export * from "./types/Hash";
 export * from "./types/IndexedValue";
 export * from "./types/IndexedWellKnownTypes";
 export * from "./types/InstructionArg";
@@ -87,6 +87,7 @@ export * from "./types/OwnerRule";
 export * from "./types/PayRef";
 export * from "./types/PedersenCommitmentBytes";
 export * from "./types/PeerAddress";
+export * from "./types/PrecisionAmount";
 export * from "./types/ProofId";
 export * from "./types/ProposalCertificate";
 export * from "./types/PublishedTemplateAddress";

package/dist/types/Bytes.d.ts

@@ -2,8 +2,8 @@
  * A wrapper around a byte buffer that implements efficient serde serialisation.
  *
  * Unfortunately, because we cannot implement a specialized version of serde::Serialize (impl serde::Serialize for
- * Vec<u8>) ciborium will represent bytes as `Array(vec![Integer(u8), ....])` instead of `Bytes(vec![u8, ...])`. which
- * results in a significant size overhead. This wrapper uses the `Value::Bytes` variant (similar to `serde_as(as =
- * "Bytes")`).
+ * `Vec<u8>`) ciborium will represent bytes as `Array(vec![Integer(u8), ....])` instead of `Bytes(vec![u8, ...])`.
+ * which results in a significant size overhead. This wrapper uses the `Value::Bytes` variant (similar to `serde_as(as
+ * = "Bytes")`).
  */
 export type Bytes = Uint8Array;

package/dist/types/ComponentHeader.d.ts

@@ -1,11 +1,11 @@
 import type { ComponentAccessRules } from "./ComponentAccessRules";
 import type { ComponentBody } from "./ComponentBody";
 import type { EntityId } from "./EntityId";
-import type { Hash } from "./Hash";
+import type { Hash32 } from "./Hash32";
 import type { OwnerRule } from "./OwnerRule";
 import type { RistrettoPublicKeyBytes } from "./RistrettoPublicKeyBytes";
 export type ComponentHeader = {
-    template_address: Hash;
+    template_address: Hash32;
     module_name: string;
     owner_key: RistrettoPublicKeyBytes | null;
     owner_rule: OwnerRule;

package/dist/types/Event.d.ts

@@ -1,9 +1,9 @@
-import type { Hash } from "./Hash";
+import type { Hash32 } from "./Hash32";
 import type { Metadata } from "./Metadata";
 import type { SubstateId } from "./SubstateId";
 export type Event = {
     substate_id: SubstateId | null;
-    template_address: Hash;
+    template_address: Hash32;
     topic: string;
     payload: Metadata;
 };

package/dist/types/FinalizeResult.d.ts

@@ -1,11 +1,11 @@
 import type { Event } from "./Event";
 import type { FeeReceipt } from "./FeeReceipt";
-import type { Hash } from "./Hash";
+import type { Hash32 } from "./Hash32";
 import type { InstructionResult } from "./InstructionResult";
 import type { LogEntry } from "./LogEntry";
 import type { TransactionResult } from "./TransactionResult";
 export type FinalizeResult = {
-    transaction_hash: Hash;
+    transaction_hash: Hash32;
     events: Array<Event>;
     logs: Array<LogEntry>;
     execution_results: Array<InstructionResult>;

package/dist/types/{Hash.d.ts → Hash32.d.ts}

@@ -1,4 +1,4 @@
 /**
  * Representation of a 32-byte hash value
  */
-export type Hash = string;
+export type Hash32 = string;

package/dist/types/Instruction.d.ts

@@ -3,7 +3,7 @@ import type { Amount } from "./Amount";
 import type { ClaimBurnOutputData } from "./ClaimBurnOutputData";
 import type { ComponentAccessRules } from "./ComponentAccessRules";
 import type { ComponentReference } from "./ComponentReference";
-import type { Hash } from "./Hash";
+import type { Hash32 } from "./Hash32";
 import type { InstructionArg } from "./InstructionArg";
 import type { LogLevel } from "./LogLevel";
 import type { MigrateFunction } from "./MigrateFunction";
@@ -24,7 +24,7 @@ export type Instruction = {
     };
 } | {
     CallFunction: {
-        address: Hash;
+        address: Hash32;
         function: string;
         args: Array<InstructionArg>;
     };
@@ -92,6 +92,6 @@ export type Instruction = {
     UpdateComponentTemplate: {
         component: ComponentReference;
         migrate: MigrateFunction | null;
-        new_template: Hash;
+        new_template: Hash32;
     };
 };

package/dist/types/PrecisionAmount.d.ts

@@ -0,0 +1,10 @@
+/**
+ * A 192-bit signed amount.
+ *
+ * This is a general purpose signed integer, but is primarily used to represent the smallest unit of value in
+ * resources/vaults etc.
+ *
+ * This allows Tari to support a massive number tokens within resources.
+ * e.g. 2 ETH = 2 x 10^18 Gwei.
+ */
+export type PrecisionAmount = string | number;

package/dist/types/PrecisionAmount.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/dist/types/RuleRequirement.d.ts

@@ -1,5 +1,5 @@
 import type { ComponentAddress } from "./ComponentAddress";
-import type { Hash } from "./Hash";
+import type { Hash32 } from "./Hash32";
 import type { NonFungibleAddress } from "./NonFungibleAddress";
 import type { ResourceAddress } from "./ResourceAddress";
 /**
@@ -12,5 +12,5 @@ export type RuleRequirement = {
 } | {
     ScopedToComponent: ComponentAddress;
 } | {
-    ScopedToTemplate: Hash;
+    ScopedToTemplate: Hash32;
 };

package/dist/types/UpSubstate.d.ts

@@ -1,6 +1,7 @@
+import type { Hash32 } from "./Hash32";
 import type { SubstateId } from "./SubstateId";
 export type UpSubstate = {
     substate_id: SubstateId;
     version: number;
-    value_hash: string;
+    value_hash: Hash32;
 };

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

@@ -1,6 +1,7 @@
 import type { Epoch } from "../Epoch";
+import type { Hash32 } from "../Hash32";
 export type IndexerGetEpochManagerStatsResponse = {
     current_epoch: Epoch;
     current_block_height: number;
-    current_block_hash: string;
+    current_block_hash: Hash32;
 };

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

@@ -1,4 +1,7 @@
 import type { TransactionId } from "../TransactionId";
 export type IndexerGetTransactionResultRequest = {
+    /**
+     * The ID of the transaction to query the result for
+     */
     transaction_id: TransactionId;
 };

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

@@ -1,4 +1,8 @@
 import type { IndexerTransactionFinalizedResult } from "./IndexerTransactionFinalizedResult";
 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;
 };

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

@@ -1,4 +1,7 @@
 import type { TransactionEnvelope } from "../TransactionEnvelope";
 export type IndexerSubmitTransactionRequest = {
+    /**
+     * A BOR-encoded transaction envelope, base64 encoded as a string
+     */
     transaction: TransactionEnvelope;
 };

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

@@ -1,6 +1,13 @@
 import type { ExecuteResult } from "../ExecuteResult";
 import type { TransactionId } from "../TransactionId";
 export type IndexerSubmitTransactionResponse = {
+    /**
+     * The ID of the transaction that was dry-run
+     */
     transaction_id: TransactionId;
+    /**
+     * The result of the dry-run execution, including any emitted events and state changes, but without a final
+     * decision or commitment to the ledger
+     */
     result: ExecuteResult;
 };

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

@@ -1,9 +1,9 @@
-import type { Hash } from "../Hash";
+import type { Hash32 } from "../Hash32";
 import type { SubstateId } from "../SubstateId";
 export type ListSubstateItem = {
     substate_id: SubstateId;
     module_name: string | null;
     version: number;
-    template_address: Hash | null;
+    template_address: Hash32 | null;
     timestamp: string;
 };

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

@@ -1,9 +1,9 @@
-import type { Hash } from "../Hash";
+import type { Hash32 } from "../Hash32";
 import type { SubstateId } from "../SubstateId";
 import type { SubstateType } from "../SubstateType";
 export type ListSubstatesRequest = {
     by_id: SubstateId | null;
-    filter_by_template: Hash | null;
+    filter_by_template: Hash32 | null;
     filter_by_type: SubstateType | null;
     limit: bigint | null;
     offset: bigint | null;

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

@@ -1,10 +1,10 @@
 import type { Epoch } from "../Epoch";
-import type { Hash } from "../Hash";
+import type { Hash32 } from "../Hash32";
 import type { RistrettoPublicKeyBytes } from "../RistrettoPublicKeyBytes";
 export type TemplateMetadata = {
     name: string;
-    address: Hash;
-    binary_sha: string;
+    address: Hash32;
+    binary_sha: Hash32;
     author_public_key: RistrettoPublicKeyBytes;
     code_size: number;
     epoch: Epoch;

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

@@ -1,4 +1,4 @@
-import type { Hash } from "../Hash";
+import type { Hash32 } from "../Hash32";
 export type GetTemplateRequest = {
-    template_address: Hash;
+    template_address: Hash32;
 };

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

@@ -1,8 +1,8 @@
-import type { Hash } from "../Hash";
+import type { Hash32 } from "../Hash32";
 import type { RistrettoPublicKeyBytes } from "../RistrettoPublicKeyBytes";
 export type VNTemplateMetadata = {
     name: string;
-    address: Hash;
+    address: Hash32;
     code_size: number;
     author: RistrettoPublicKeyBytes;
 };

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

@@ -1,9 +1,9 @@
 import type { FunctionDef } from "../FunctionDef";
-import type { Hash } from "../Hash";
+import type { Hash32 } from "../Hash32";
 import type { RistrettoPublicKeyBytes } from "../RistrettoPublicKeyBytes";
 export type AuthoredTemplate = {
     author_public_key: RistrettoPublicKeyBytes;
-    address: Hash;
+    address: Hash32;
     name: string;
     abi_version: number;
     functions: Array<FunctionDef>;

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

@@ -1,4 +1,4 @@
-import type { Hash } from "../Hash";
+import type { Hash32 } from "../Hash32";
 export type TemplatesGetRequest = {
-    template_address: Hash;
+    template_address: Hash32;
 };

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

@@ -1,9 +1,9 @@
-import type { Hash } from "../Hash";
+import type { Hash32 } from "../Hash32";
 import type { SubstateId } from "../SubstateId";
 export type WalletSubstateInfo = {
     substate_id: SubstateId;
     parent_id: SubstateId | null;
     module_name: string | null;
     version: number;
-    template_address: Hash | null;
+    template_address: Hash32 | null;
 };

package/package.json

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