@tari-project/tarijs-types 0.5.2 → 0.5.4

package/dist/TransactionResult.d.ts

@@ -1,14 +1,25 @@
 import { TransactionStatus } from "./TransactionStatus";
 import { FinalizeResult } from "./FinalizeResult";
+import { DownSubstates, UpSubstates } from "./SubstateDiff";
+import { ComponentAddress } from "@tari-project/typescript-bindings";
 export type SubmitTransactionResponse = {
     transaction_id: string;
 };
 export interface SubmitTxResult {
     response: SubmitTransactionResponse;
     result: TransactionResult;
+    upSubstates: UpSubstates;
+    downSubstates: DownSubstates;
+    newComponents: UpSubstates;
+    getComponentForTemplate(templateAddress: string): ComponentAddress | null;
 }
 export type TransactionResult = {
     transaction_id: string;
     status: TransactionStatus;
     result: FinalizeResult | null;
 };
+export type TransactionResultResponse = {
+    transaction_id: string;
+    status: TransactionStatus;
+    result: FinalizeResult | null;
+};

package/dist/helpers/cbor.d.ts

@@ -0,0 +1,33 @@
+export type CborValue = {
+    Map: Array<[CborValue, CborValue]>;
+} | {
+    Array: CborValue[];
+} | {
+    Tag: [BinaryTag, CborValue];
+} | {
+    Bool: boolean;
+} | {
+    Bytes: number[];
+} | {
+    Text: string;
+} | {
+    Float: number;
+} | {
+    Integer: number;
+} | "Null";
+export declare function parseCbor(value: CborValue): unknown;
+export declare function getCborValueByPath(cborRepr: CborValue | null, path: string): unknown;
+export declare enum BinaryTag {
+    ComponentAddress = 128,
+    Metadata = 129,
+    NonFungibleAddress = 130,
+    ResourceAddress = 131,
+    VaultId = 132,
+    BucketId = 133,
+    TransactionReceipt = 134,
+    ProofId = 135,
+    UnclaimedConfidentialOutputAddress = 136,
+    TemplateAddress = 137,
+    ValidatorNodeFeePool = 138
+}
+export declare function convertTaggedValue(type: number, value: CborValue): string | unknown;

package/dist/helpers/cbor.js

@@ -0,0 +1,105 @@
+export function parseCbor(value) {
+    if (typeof value === "string") {
+        if (value === "Null") {
+            return null;
+        }
+        throw new Error("Unknown CBOR value type");
+    }
+    if ("Map" in value) {
+        return Object.fromEntries(value.Map.map(([k, v]) => [parseCbor(k), parseCbor(v)]));
+    }
+    else if ("Array" in value) {
+        return value.Array.map(parseCbor);
+    }
+    else if ("Tag" in value) {
+        const [type, data] = value.Tag;
+        return convertTaggedValue(type, data);
+    }
+    else if ("Bool" in value) {
+        return value.Bool;
+    }
+    else if ("Bytes" in value) {
+        return new Uint8Array(value.Bytes);
+    }
+    else if ("Text" in value) {
+        return value.Text;
+    }
+    else if ("Float" in value) {
+        return value.Float;
+    }
+    else if ("Integer" in value) {
+        return value.Integer;
+    }
+    throw new Error("Unknown CBOR value type");
+}
+export function getCborValueByPath(cborRepr, path) {
+    if (!cborRepr) {
+        return null;
+    }
+    let value = cborRepr;
+    for (const part of path.split(".")) {
+        if (part == "$") {
+            continue;
+        }
+        if (typeof value !== "object") {
+            return null;
+        }
+        if ("Map" in value) {
+            const mapEntry = value.Map.find((v) => parseCbor(v[0]) === part)?.[1];
+            if (mapEntry) {
+                value = mapEntry;
+                continue;
+            }
+            else {
+                return null;
+            }
+        }
+        if ("Array" in value) {
+            const arr = value.Array;
+            const index = parseInt(part);
+            if (!Number.isNaN(index) && Array.isArray(arr) && arr.length > index) {
+                value = arr[index];
+                continue;
+            }
+        }
+        return null;
+    }
+    return parseCbor(value);
+}
+function uint8ArrayToHex(bytes) {
+    return Array.from(bytes)
+        .map((byte) => byte.toString(16).padStart(2, "0"))
+        .join("");
+}
+export var BinaryTag;
+(function (BinaryTag) {
+    BinaryTag[BinaryTag["ComponentAddress"] = 128] = "ComponentAddress";
+    BinaryTag[BinaryTag["Metadata"] = 129] = "Metadata";
+    BinaryTag[BinaryTag["NonFungibleAddress"] = 130] = "NonFungibleAddress";
+    BinaryTag[BinaryTag["ResourceAddress"] = 131] = "ResourceAddress";
+    BinaryTag[BinaryTag["VaultId"] = 132] = "VaultId";
+    BinaryTag[BinaryTag["BucketId"] = 133] = "BucketId";
+    BinaryTag[BinaryTag["TransactionReceipt"] = 134] = "TransactionReceipt";
+    BinaryTag[BinaryTag["ProofId"] = 135] = "ProofId";
+    BinaryTag[BinaryTag["UnclaimedConfidentialOutputAddress"] = 136] = "UnclaimedConfidentialOutputAddress";
+    BinaryTag[BinaryTag["TemplateAddress"] = 137] = "TemplateAddress";
+    BinaryTag[BinaryTag["ValidatorNodeFeePool"] = 138] = "ValidatorNodeFeePool";
+})(BinaryTag || (BinaryTag = {}));
+const BINARY_TAG_KEYS = new Map([
+    [BinaryTag.ComponentAddress, "component"],
+    [BinaryTag.Metadata, "metadata"],
+    [BinaryTag.NonFungibleAddress, "nft"],
+    [BinaryTag.ResourceAddress, "resource"],
+    [BinaryTag.VaultId, "vault"],
+    [BinaryTag.BucketId, "bucket"],
+    [BinaryTag.TransactionReceipt, "transaction-receipt"],
+    [BinaryTag.ProofId, "proof"],
+    [BinaryTag.UnclaimedConfidentialOutputAddress, "unclaimed-confidential-output-address"],
+    [BinaryTag.TemplateAddress, "template-address"],
+    [BinaryTag.ValidatorNodeFeePool, "validator-node-fee-pool"],
+]);
+export function convertTaggedValue(type, value) {
+    const tag = BINARY_TAG_KEYS.get(type) ?? "unknown";
+    const decoded = parseCbor(value);
+    return decoded instanceof Uint8Array ? `${tag}_${uint8ArrayToHex(decoded)}` : [tag, decoded];
+}

package/dist/helpers/hexString.d.ts

@@ -0,0 +1,2 @@
+export declare function toHexString(byteArray: any): string;
+export declare function fromHexString(hexString: string): number[];

package/dist/helpers/hexString.js

@@ -0,0 +1,22 @@
+export function toHexString(byteArray) {
+    if (Array.isArray(byteArray)) {
+        return Array.from(byteArray, function (byte) {
+            return ('0' + (byte & 0xff).toString(16)).slice(-2);
+        }).join('');
+    }
+    if (byteArray === undefined) {
+        return 'undefined';
+    }
+    // object might be a tagged object
+    if (byteArray['@@TAGGED@@'] !== undefined) {
+        return toHexString(byteArray['@@TAGGED@@'][1]);
+    }
+    return 'Unsupported type';
+}
+export function fromHexString(hexString) {
+    let res = [];
+    for (let i = 0; i < hexString.length; i += 2) {
+        res.push(Number('0x' + hexString.substring(i, i + 2)));
+    }
+    return res;
+}

package/dist/helpers/index.d.ts

@@ -1,5 +1,8 @@
 import { NonFungibleId, NonFungibleToken, ResourceAddress } from "@tari-project/typescript-bindings";
 import { TransactionStatus } from "../TransactionStatus";
+export { fromHexString, toHexString } from "./hexString";
+export { txResultCheck, getSubstateValueFromUpSubstates, getComponentsForTemplate } from "./txResult";
+export { BinaryTag, CborValue, convertTaggedValue, getCborValueByPath, parseCbor } from "./cbor";
 export { substateIdToString, stringToSubstateId, shortenSubstateId, shortenString, rejectReasonToString, getSubstateDiffFromTransactionResult, getRejectReasonFromTransactionResult, jrpcPermissionToString, } from "@tari-project/typescript-bindings";
 export declare function convertStringToTransactionStatus(status: string): TransactionStatus;
 export declare function createNftAddressFromToken(token: NonFungibleToken): string;

package/dist/helpers/index.js

@@ -1,4 +1,7 @@
 import { TransactionStatus } from "../TransactionStatus";
+export { fromHexString, toHexString } from "./hexString";
+export { txResultCheck, getSubstateValueFromUpSubstates, getComponentsForTemplate } from "./txResult";
+export { BinaryTag, convertTaggedValue, getCborValueByPath, parseCbor } from "./cbor";
 export { substateIdToString, stringToSubstateId, shortenSubstateId, shortenString, rejectReasonToString, getSubstateDiffFromTransactionResult, getRejectReasonFromTransactionResult, jrpcPermissionToString, } from "@tari-project/typescript-bindings";
 export function convertStringToTransactionStatus(status) {
     switch (status) {

package/dist/helpers/txResult.d.ts

@@ -0,0 +1,29 @@
+import { SubstateDiff, VaultId, Vault, SubstateId, SubstateValue, ResourceContainer, ResourceAddress, Amount, RejectReason, ComponentAddress } from "@tari-project/typescript-bindings";
+import { FinalizeResultStatus } from "../FinalizeResult";
+import { UpSubstates } from "../SubstateDiff";
+export declare const txResultCheck: {
+    isAccept: (result: FinalizeResultStatus) => result is {
+        Accept: SubstateDiff;
+    };
+    isVaultId: (substateId: SubstateId) => substateId is {
+        Vault: VaultId;
+    };
+    isVaultSubstate: (substate: SubstateValue) => substate is {
+        Vault: Vault;
+    };
+    isFungible: (resourceContainer: ResourceContainer) => resourceContainer is {
+        Fungible: {
+            address: ResourceAddress;
+            amount: Amount;
+            locked_amount: Amount;
+        };
+    };
+    isReject: (result: FinalizeResultStatus) => result is {
+        Reject: RejectReason;
+    };
+    isAcceptFeeRejectRest: (result: FinalizeResultStatus) => result is {
+        AcceptFeeRejectRest: [SubstateDiff, RejectReason];
+    };
+};
+export declare function getSubstateValueFromUpSubstates(substateType: keyof SubstateValue | string, upSubstates: UpSubstates): UpSubstates;
+export declare function getComponentsForTemplate(templateAddress: string, upSubstates: UpSubstates): ComponentAddress[] | null;

package/dist/helpers/txResult.js

@@ -0,0 +1,46 @@
+import { substateIdToString, } from "@tari-project/typescript-bindings";
+function isOfType(obj, key) {
+    return obj !== null && typeof obj === "object" && key in obj;
+}
+export const txResultCheck = {
+    isAccept: (result) => {
+        return "Accept" in result;
+    },
+    isVaultId: (substateId) => {
+        return isOfType(substateId, "Vault");
+    },
+    isVaultSubstate: (substate) => {
+        return "Vault" in substate;
+    },
+    isFungible: (resourceContainer) => {
+        return "Fungible" in resourceContainer;
+    },
+    isReject: (result) => {
+        return "Reject" in result;
+    },
+    isAcceptFeeRejectRest: (result) => {
+        return "AcceptFeeRejectRest" in result;
+    },
+};
+export function getSubstateValueFromUpSubstates(substateType, upSubstates) {
+    const components = [];
+    for (const [substateId, substate] of upSubstates) {
+        if (substateType in substate.substate) {
+            components.push([substateId, substate]);
+        }
+    }
+    return components;
+}
+export function getComponentsForTemplate(templateAddress, upSubstates) {
+    const components = [];
+    const templateAddressBytes = new TextEncoder().encode(templateAddress);
+    for (const [substateId, substate] of upSubstates) {
+        if ("Component" in substate.substate) {
+            const componentHeader = substate.substate.Component;
+            if (componentHeader.template_address === templateAddressBytes) {
+                components.push(substateIdToString(substateId));
+            }
+        }
+    }
+    return components;
+}

package/dist/index.d.ts

@@ -10,12 +10,13 @@ export { Instruction } from "./Instruction";
 export { Transaction } from "./Transaction";
 export { SubstateDiff, DownSubstates, UpSubstates } from "./SubstateDiff";
 export { SubstateRequirement } from "./SubstateRequirement";
-export { TransactionResult, SubmitTxResult, SubmitTransactionResponse } from "./TransactionResult";
+export { TransactionResult, SubmitTxResult, SubmitTransactionResponse, TransactionResultResponse, } from "./TransactionResult";
 export { TransactionSignature } from "./TransactionSignature";
 export { TransactionStatus } from "./TransactionStatus";
 export { UnsignedTransaction } from "./UnsignedTransaction";
 export { VersionedSubstateId } from "./VersionedSubstateId";
 export { WorkspaceArg } from "./Workspace";
 export { ListAccountNftFromBalancesRequest } from "./ListAccountNftFromBalancesRequest";
+export { Network } from "./network";
 export { AccountData, ListSubstatesRequest, ListSubstatesResponse, SubmitTransactionRequest, Substate, SubstateMetadata, ReqSubstate, TemplateDefinition, VaultBalances, VaultData, GetSubstateRequest, } from "./signer";
-export { convertHexStringToU256Array, convertStringToTransactionStatus, convertU256ToHexString, createNftAddressFromResource, createNftAddressFromToken, getRejectReasonFromTransactionResult, getSubstateDiffFromTransactionResult, jrpcPermissionToString, rejectReasonToString, shortenString, shortenSubstateId, stringToSubstateId, substateIdToString, } from "./helpers";
+export { convertHexStringToU256Array, convertStringToTransactionStatus, convertU256ToHexString, createNftAddressFromResource, createNftAddressFromToken, getRejectReasonFromTransactionResult, getSubstateDiffFromTransactionResult, jrpcPermissionToString, rejectReasonToString, shortenString, shortenSubstateId, stringToSubstateId, substateIdToString, fromHexString, toHexString, convertTaggedValue, getCborValueByPath, parseCbor, getSubstateValueFromUpSubstates, getComponentsForTemplate, txResultCheck, BinaryTag, CborValue, } from "./helpers";

package/dist/index.js

@@ -1,3 +1,4 @@
 export { Amount } from "./Amount";
 export { TransactionStatus } from "./TransactionStatus";
-export { convertHexStringToU256Array, convertStringToTransactionStatus, convertU256ToHexString, createNftAddressFromResource, createNftAddressFromToken, getRejectReasonFromTransactionResult, getSubstateDiffFromTransactionResult, jrpcPermissionToString, rejectReasonToString, shortenString, shortenSubstateId, stringToSubstateId, substateIdToString, } from "./helpers";
+export { Network } from "./network";
+export { convertHexStringToU256Array, convertStringToTransactionStatus, convertU256ToHexString, createNftAddressFromResource, createNftAddressFromToken, getRejectReasonFromTransactionResult, getSubstateDiffFromTransactionResult, jrpcPermissionToString, rejectReasonToString, shortenString, shortenSubstateId, stringToSubstateId, substateIdToString, fromHexString, toHexString, convertTaggedValue, getCborValueByPath, parseCbor, getSubstateValueFromUpSubstates, getComponentsForTemplate, txResultCheck, BinaryTag, } from "./helpers";

package/dist/network.d.ts

@@ -0,0 +1,8 @@
+export declare enum Network {
+    MainNet = 0,
+    StageNet = 1,
+    NextNet = 2,
+    LocalNet = 16,
+    Igor = 36,
+    Esmeralda = 38
+}

package/dist/network.js

@@ -0,0 +1,9 @@
+export var Network;
+(function (Network) {
+    Network[Network["MainNet"] = 0] = "MainNet";
+    Network[Network["StageNet"] = 1] = "StageNet";
+    Network[Network["NextNet"] = 2] = "NextNet";
+    Network[Network["LocalNet"] = 16] = "LocalNet";
+    Network[Network["Igor"] = 36] = "Igor";
+    Network[Network["Esmeralda"] = 38] = "Esmeralda";
+})(Network || (Network = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tarijs-types",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "description": "",
   "type": "module",
   "publishConfig": {
@@ -10,7 +10,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@tari-project/typescript-bindings": "^1.5.1"
+    "@tari-project/typescript-bindings": "^1.5.2"
   },
   "devDependencies": {
     "@types/node": "^22.13.1",