@tari-project/ootle-ts-bindings 1.34.2 → 1.43.0

package/dist/helpers/cbor.d.ts

@@ -0,0 +1,38 @@
+export declare const CBOR_SENTINEL_KEY = "@cbor";
+export declare const CBOR_SENTINEL_BYTES = "bytes";
+export declare const CBOR_SENTINEL_INT = "int";
+export declare const CBOR_SENTINEL_MAP = "map";
+export declare const CBOR_SENTINEL_TAG = "tag";
+/**
+ * Decode `BinaryTag(N, value)` into a domain-specific representation. Receives the tag number
+ * and the *already-decoded* tag payload. Return whatever you want callers to see — the decoder
+ * does not further transform the result. Throw or return `value` for tags you don't recognise.
+ */
+export type CborTagHandler = (tag: number, value: any) => any;
+export interface DecodeCborJsonOptions {
+    /** Plug-in tag handler. Defaults to a passthrough that returns `{ tag, value }`. */
+    onTag?: CborTagHandler;
+}
+/**
+ * Walk JSON produced by the sentinel encoding of `tari_bor::Value` and return native JS:
+ *
+ * - primitives, arrays, and text-keyed objects pass through (after recursive decoding);
+ * - `{ "@cbor": "bytes", hex }` → `number[]` of byte values;
+ * - `{ "@cbor": "int", value }` → `number` when safe, otherwise `BigInt`;
+ * - `{ "@cbor": "map", entries }` → plain object (keys coerced via `String(decoded)`);
+ * - `{ "@cbor": "tag", tag, value }` → whatever `opts.onTag` returns.
+ *
+ * Decoding is shallow-by-default for tags: `onTag` receives the *decoded* `value`, so it can
+ * inspect it without recursing again.
+ */
+export declare function decodeCborJson(input: any, opts?: DecodeCborJsonOptions): any;
+/**
+ * Tari-flavoured `convertCborValue`. Identical to `decodeCborJson(input, { onTag: tariCborTagHandler })`.
+ */
+export declare function convertCborValue(input: any): any;
+/**
+ * Recognise the Tari CBOR tag set and render known byte-payload tags as canonical address
+ * strings (e.g. tag 132 → `vault_<hex>`). Falls through to a `{ tag, value }` envelope for
+ * unknown tags so callers can still see them in the JSON output.
+ */
+export declare function tariCborTagHandler(tag: number, value: any): any;

package/dist/helpers/cbor.js

@@ -0,0 +1,136 @@
+// Copyright 2026 The Tari Project
+// SPDX-License-Identifier: BSD-3-Clause
+// JSON-side decoder for `tari_bor::Value`.
+//
+// The minicbor-based encoding (see `crates/tari_bor/src/value_serde.rs`) emits values as natural
+// JSON for primitives, text-keyed maps and arrays, and uses `@cbor` sentinel objects otherwise:
+//   - `{ "@cbor": "bytes", "hex": "..." }`
+//   - `{ "@cbor": "int",   "value": "..." }`   (integers outside i64/u64)
+//   - `{ "@cbor": "map",   "entries": [[k, v], ...] }`
+//   - `{ "@cbor": "tag",   "tag": N, "value": v }`
+//
+// The decoder in this file is generic over the meaning of CBOR tags — consumers plug in a
+// `CborTagHandler` to translate domain-specific tags. The exported `convertCborValue` is the
+// Tari-flavoured convenience wrapper that uses `tariCborTagHandler` to render known address
+// tags as canonical `<type>_<hex>` strings.
+import { TariTypeTag } from "./tariTypeTag";
+export const CBOR_SENTINEL_KEY = "@cbor";
+export const CBOR_SENTINEL_BYTES = "bytes";
+export const CBOR_SENTINEL_INT = "int";
+export const CBOR_SENTINEL_MAP = "map";
+export const CBOR_SENTINEL_TAG = "tag";
+/**
+ * Walk JSON produced by the sentinel encoding of `tari_bor::Value` and return native JS:
+ *
+ * - primitives, arrays, and text-keyed objects pass through (after recursive decoding);
+ * - `{ "@cbor": "bytes", hex }` → `number[]` of byte values;
+ * - `{ "@cbor": "int", value }` → `number` when safe, otherwise `BigInt`;
+ * - `{ "@cbor": "map", entries }` → plain object (keys coerced via `String(decoded)`);
+ * - `{ "@cbor": "tag", tag, value }` → whatever `opts.onTag` returns.
+ *
+ * Decoding is shallow-by-default for tags: `onTag` receives the *decoded* `value`, so it can
+ * inspect it without recursing again.
+ */
+export function decodeCborJson(input, opts) {
+    const onTag = opts?.onTag ?? defaultTagHandler;
+    return walk(input, onTag);
+}
+/**
+ * Tari-flavoured `convertCborValue`. Identical to `decodeCborJson(input, { onTag: tariCborTagHandler })`.
+ */
+export function convertCborValue(input) {
+    return decodeCborJson(input, { onTag: tariCborTagHandler });
+}
+/**
+ * Recognise the Tari CBOR tag set and render known byte-payload tags as canonical address
+ * strings (e.g. tag 132 → `vault_<hex>`). Falls through to a `{ tag, value }` envelope for
+ * unknown tags so callers can still see them in the JSON output.
+ */
+export function tariCborTagHandler(tag, value) {
+    switch (tag) {
+        case TariTypeTag.VaultId:
+            return bytesValueToAddressString("vault", value);
+        case TariTypeTag.ComponentAddress:
+            return bytesValueToAddressString("component", value);
+        case TariTypeTag.ResourceAddress:
+            return bytesValueToAddressString("resource", value);
+        case TariTypeTag.NonFungibleAddress:
+            return bytesValueToAddressString("nft", value);
+        case TariTypeTag.ClaimedOutputTombstoneAddress:
+            return bytesValueToAddressString("tombstone", value);
+        case TariTypeTag.TemplateAddress:
+            return bytesValueToAddressString("template", value);
+        case TariTypeTag.Utxo:
+            return bytesValueToAddressString("utxo", value);
+        case TariTypeTag.TransactionReceipt:
+            return bytesValueToAddressString("txreceipt", value);
+        case TariTypeTag.Metadata:
+            return value;
+        default:
+            return { tag, value };
+    }
+}
+function defaultTagHandler(tag, value) {
+    return { tag, value };
+}
+function walk(value, onTag) {
+    if (value === null || value === undefined) {
+        return null;
+    }
+    if (typeof value !== "object") {
+        return value;
+    }
+    if (Array.isArray(value)) {
+        return value.map((v) => walk(v, onTag));
+    }
+    if (CBOR_SENTINEL_KEY in value) {
+        return walkSentinel(value, onTag);
+    }
+    const result = {};
+    for (const [k, v] of Object.entries(value)) {
+        result[k] = walk(v, onTag);
+    }
+    return result;
+}
+function walkSentinel(value, onTag) {
+    switch (value[CBOR_SENTINEL_KEY]) {
+        case CBOR_SENTINEL_BYTES:
+            return hexToBytes(value.hex);
+        case CBOR_SENTINEL_INT: {
+            const big = BigInt(value.value);
+            const num = Number(big);
+            return Number.isSafeInteger(num) && BigInt(num) === big ? num : big;
+        }
+        case CBOR_SENTINEL_MAP: {
+            const result = {};
+            for (const [k, v] of value.entries) {
+                result[String(walk(k, onTag))] = walk(v, onTag);
+            }
+            return result;
+        }
+        case CBOR_SENTINEL_TAG:
+            return onTag(value.tag, walk(value.value, onTag));
+        default:
+            return value;
+    }
+}
+function hexToBytes(hex) {
+    const out = [];
+    for (let i = 0; i + 1 < hex.length; i += 2) {
+        out.push(parseInt(hex.substring(i, i + 2), 16));
+    }
+    return out;
+}
+function bytesValueToAddressString(type, value) {
+    let hex;
+    if (Array.isArray(value)) {
+        hex = value.map((b) => ("0" + (b & 0xff).toString(16)).slice(-2)).join("");
+    }
+    else if (typeof value === "string") {
+        hex = value;
+    }
+    else {
+        return JSON.stringify(value);
+    }
+    return `${type}_${hex}`;
+}

package/dist/helpers/helpers.d.ts

@@ -1,4 +1,4 @@
-import { JrpcPermission } from "../types/JrpcPermission";
+import { Permission } from "../types/Permission";
 import { RejectReason } from "../types/RejectReason";
 import { SubstateDiff } from "../types/SubstateDiff";
 import { SubstateId } from "../types/SubstateId";
@@ -10,4 +10,4 @@ export declare function shortenString(string: string, start?: number, end?: numb
 export declare function rejectReasonToString(reason: RejectReason | null): string;
 export declare function getSubstateDiffFromTransactionResult(result: TransactionResult): SubstateDiff | null;
 export declare function getRejectReasonFromTransactionResult(result: TransactionResult): RejectReason | null;
-export declare function jrpcPermissionToString(jrpcPermission: JrpcPermission): string;
+export declare function permissionToString(permission: Permission): string;

package/dist/helpers/helpers.js

@@ -122,26 +122,54 @@ export function getRejectReasonFromTransactionResult(result) {
     }
     return null;
 }
-export function jrpcPermissionToString(jrpcPermission) {
-    if (typeof jrpcPermission === "string") {
-        return jrpcPermission;
-    }
-    if ("NftGetOwnershipProof" in jrpcPermission) {
-        return `NftGetOwnershipProof(${jrpcPermission.NftGetOwnershipProof})`;
-    }
-    if ("AccountBalance" in jrpcPermission) {
-        return `AccountBalance(${substateIdToString(jrpcPermission.AccountBalance)})`;
-    }
-    if ("AccountList" in jrpcPermission) {
-        return `AccountList(${jrpcPermission.AccountList})`;
-    }
-    if ("TransactionSend" in jrpcPermission) {
-        return `TransactionSend(${jrpcPermission.TransactionSend})`;
-    }
-    if ("GetNft" in jrpcPermission) {
-        return `GetNft(${substateIdToString(jrpcPermission.GetNft[0])}, ${jrpcPermission.GetNft[1]})`;
-    }
-    return "Unknown";
+// Render a Permission to its canonical grant string, e.g.
+//   `admin`, `webrtc`, `accounts:read`, `transfer:create:component_abc…`,
+//   `substates:read`. Round-trips with the Rust `Permission::FromStr`.
+export function permissionToString(permission) {
+    if (typeof permission === "string") {
+        // Bare variants (`Admin`, `Webrtc`) serialise to lowercase strings.
+        return permission.toLowerCase();
+    }
+    // Read-only resources: { Substates: "Read" } / { BurnProofs: "Read" } /
+    // { SwapPools: "Read" } — render with the resource name in snake_case
+    // plus explicit `:read`.
+    if ("Substates" in permission)
+        return "substates:read";
+    if ("BurnProofs" in permission)
+        return "burn_proofs:read";
+    if ("SwapPools" in permission)
+        return "swap_pools:read";
+    // Unscoped CRUD resources: { Keys: "Read" } -> "keys:read".
+    if ("Keys" in permission)
+        return `keys:${permission.Keys.toLowerCase()}`;
+    if ("Templates" in permission)
+        return `templates:${permission.Templates.toLowerCase()}`;
+    if ("Transactions" in permission)
+        return `transactions:${permission.Transactions.toLowerCase()}`;
+    if ("Validators" in permission)
+        return `validators:${permission.Validators.toLowerCase()}`;
+    if ("Settings" in permission)
+        return `settings:${permission.Settings.toLowerCase()}`;
+    if ("AddressBook" in permission)
+        return `address_book:${permission.AddressBook.toLowerCase()}`;
+    // Scoped CRUD resources: { Accounts: ["Read", "component_abc..." | null] }.
+    if ("Accounts" in permission)
+        return scoped("accounts", permission.Accounts);
+    if ("Transfer" in permission)
+        return scoped("transfer", permission.Transfer);
+    if ("Nfts" in permission)
+        return scoped("nfts", permission.Nfts);
+    if ("Confidential" in permission)
+        return scoped("confidential", permission.Confidential);
+    if ("StealthUtxos" in permission)
+        return scoped("stealth_utxos", permission.StealthUtxos);
+    console.error("Unknown permission", permission);
+    return JSON.stringify(permission);
+}
+function scoped(resource, value) {
+    const [action, entity] = value;
+    const base = `${resource}:${action.toLowerCase()}`;
+    return entity ? `${base}:${entity}` : base;
 }
 function splitOnce(str, separator) {
     const index = str.indexOf(separator);

package/dist/index.d.ts

@@ -3,51 +3,57 @@ export * from "./types/AbridgedTransactionKernel";
 export * from "./types/AccessRule";
 export * from "./types/Account";
 export * from "./types/AccountWithAddress";
-export * from "./types/AddressBookPermission";
 export * from "./types/AllocatableAddressType";
 export * from "./types/Amount";
 export * from "./types/ArgDef";
 export * from "./types/Assertion";
+export * from "./types/AtomicCondition";
 export * from "./types/AuthHook";
+export * from "./types/Blob";
 export * from "./types/BlobHashes";
 export * from "./types/Blobs";
-export * from "./types/Blob";
+export * from "./types/Block";
 export * from "./types/BlockHeader";
 export * from "./types/BlockId";
-export * from "./types/Block";
 export * from "./types/BucketId";
+export * from "./types/BuiltinPredicate";
 export * from "./types/Bytes";
 export * from "./types/CheckOrd";
 export * from "./types/ClaimBurnOutputData";
-export * from "./types/ClaimedOutputTombstoneAddress";
 export * from "./types/ClaimedOutputTombstone";
+export * from "./types/ClaimedOutputTombstoneAddress";
 export * from "./types/Claims";
 export * from "./types/Command";
 export * from "./types/CommitmentSignatureBytes";
+export * from "./types/Committee";
 export * from "./types/CommitteeInfo";
 export * from "./types/CommitteeMember";
-export * from "./types/Committee";
+export * from "./types/Component";
 export * from "./types/ComponentAccessRules";
 export * from "./types/ComponentAddress";
 export * from "./types/ComponentBody";
 export * from "./types/ComponentHeader";
 export * from "./types/ComponentKey";
 export * from "./types/ComponentReference";
-export * from "./types/Component";
 export * from "./types/ConfidentialOutputStatement";
 export * from "./types/ConfidentialWithdrawProof";
+export * from "./types/Covenant";
+export * from "./types/CovenantBalanceClaim";
+export * from "./types/Crud";
+export * from "./types/CurrentInputView";
 export * from "./types/Decision";
 export * from "./types/DiffSummary";
 export * from "./types/ElgamalVerifiableBalanceBytes";
 export * from "./types/EncodedMerkleProof";
 export * from "./types/EncryptedData";
+export * from "./types/EndEpochAtom";
 export * from "./types/EntityId";
 export * from "./types/Epoch";
 export * from "./types/Era";
 export * from "./types/Event";
 export * from "./types/EvictNodeAtom";
-export * from "./types/EvidenceInputLockData";
 export * from "./types/Evidence";
+export * from "./types/EvidenceInputLockData";
 export * from "./types/ExecuteResult";
 export * from "./types/ExtraData";
 export * from "./types/FeeBreakdown";
@@ -58,33 +64,34 @@ export * from "./types/FinalizeOutcome";
 export * from "./types/FinalizeResult";
 export * from "./types/ForeignProposalAtom";
 export * from "./types/FunctionDef";
+export * from "./types/FunctionDoc";
 export * from "./types/Hash32";
 export * from "./types/Hash64";
+export * from "./types/HashAlg";
 export * from "./types/IndexedValue";
 export * from "./types/IndexedWellKnownTypes";
+export * from "./types/Instruction";
 export * from "./types/InstructionArg";
 export * from "./types/InstructionResult";
-export * from "./types/Instruction";
-export * from "./types/JrpcPermissions";
-export * from "./types/JrpcPermission";
 export * from "./types/LeaderFee";
-export * from "./types/LockedEpoch";
 export * from "./types/LockFlag";
+export * from "./types/LockedEpoch";
 export * from "./types/LogEntry";
 export * from "./types/LogLevel";
 export * from "./types/Memo";
+export * from "./types/MerkleProof";
 export * from "./types/Metadata";
 export * from "./types/MigrateFunction";
 export * from "./types/MinotariBurnClaimProof";
 export * from "./types/Network";
 export * from "./types/NftCheck";
 export * from "./types/NodeHeight";
-export * from "./types/NonFungibleAddressContents";
+export * from "./types/NonFungible";
 export * from "./types/NonFungibleAddress";
+export * from "./types/NonFungibleAddressContents";
 export * from "./types/NonFungibleContainer";
 export * from "./types/NonFungibleId";
 export * from "./types/NonFungibleToken";
-export * from "./types/NonFungible";
 export * from "./types/NumPreshards";
 export * from "./types/OotleAddress";
 export * from "./types/Ordering";
@@ -94,6 +101,8 @@ export * from "./types/OwnerRule";
 export * from "./types/PayRef";
 export * from "./types/PedersenCommitmentBytes";
 export * from "./types/PeerAddress";
+export * from "./types/Permission";
+export * from "./types/Permissions";
 export * from "./types/PrecisionAmount";
 export * from "./types/ProofId";
 export * from "./types/ProposalCertificate";
@@ -101,36 +110,42 @@ export * from "./types/PrunedTransaction";
 export * from "./types/PrunedTransactionV1";
 export * from "./types/PrunedUnsealedTransactionV1";
 export * from "./types/PrunedUnsignedTransactionV1";
+export * from "./types/PublishedTemplate";
 export * from "./types/PublishedTemplateAddress";
 export * from "./types/PublishedTemplateMetadata";
-export * from "./types/PublishedTemplate";
 export * from "./types/RangeProofBytes";
+export * from "./types/ReadOnly";
 export * from "./types/RejectReason";
 export * from "./types/RequireRule";
+export * from "./types/Resource";
 export * from "./types/ResourceAccessRules";
-export * from "./types/ResourceAddressRef";
 export * from "./types/ResourceAddress";
+export * from "./types/ResourceAddressRef";
 export * from "./types/ResourceContainer";
-export * from "./types/Resource";
 export * from "./types/ResourceType";
 export * from "./types/RestrictedAccessRule";
 export * from "./types/RistrettoPublicKeyBytes";
 export * from "./types/RuleRequirement";
 export * from "./types/Scalar32Bytes";
 export * from "./types/SchnorrSignatureBytes";
+export * from "./types/Shard";
+export * from "./types/ShardGroup";
 export * from "./types/ShardGroupAccumulatedData";
 export * from "./types/ShardGroupEvidence";
-export * from "./types/ShardGroup";
 export * from "./types/ShardStateVersions";
-export * from "./types/Shard";
+export * from "./types/SpendAuthorization";
 export * from "./types/SpendCondition";
+export * from "./types/SpendWitness";
 export * from "./types/StateVersion";
-export * from "./types/StealthInputsStatement";
 export * from "./types/StealthInput";
+export * from "./types/StealthInputView";
+export * from "./types/StealthInputsStatement";
+export * from "./types/StealthOutputView";
 export * from "./types/StealthOutputsStatement";
 export * from "./types/StealthTransferStatement";
 export * from "./types/StealthUnspentOutput";
 export * from "./types/StealthValueProof";
+export * from "./types/Substate";
 export * from "./types/SubstateAddress";
 export * from "./types/SubstateCreated";
 export * from "./types/SubstateDestroyed";
@@ -140,26 +155,26 @@ export * from "./types/SubstateLockType";
 export * from "./types/SubstateOwnerRule";
 export * from "./types/SubstateRecord";
 export * from "./types/SubstateRequirement";
-export * from "./types/Substate";
 export * from "./types/SubstateType";
 export * from "./types/SubstateValue";
 export * from "./types/TemplateDef";
 export * from "./types/TemplateDefV1";
+export * from "./types/TemplateFunction";
 export * from "./types/TemplateMetadata";
 export * from "./types/TimeoutCertificate";
+export * from "./types/Transaction";
 export * from "./types/TransactionAtom";
 export * from "./types/TransactionEnvelope";
 export * from "./types/TransactionExecution";
 export * from "./types/TransactionId";
 export * from "./types/TransactionPoolRecord";
 export * from "./types/TransactionPoolStage";
-export * from "./types/TransactionReceiptAddress";
 export * from "./types/TransactionReceipt";
+export * from "./types/TransactionReceiptAddress";
 export * from "./types/TransactionResult";
 export * from "./types/TransactionSealSignature";
 export * from "./types/TransactionSignature";
 export * from "./types/TransactionStatus";
-export * from "./types/Transaction";
 export * from "./types/TransactionV1";
 export * from "./types/Type";
 export * from "./types/UnsealedTransaction";
@@ -168,8 +183,10 @@ export * from "./types/UnsignedTransaction";
 export * from "./types/UnsignedTransactionV1";
 export * from "./types/UnspentOutput";
 export * from "./types/UpSubstate";
-export * from "./types/UtxoAddressContents";
+export * from "./types/UpdateRule";
+export * from "./types/Utxo";
 export * from "./types/UtxoAddress";
+export * from "./types/UtxoAddressContents";
 export * from "./types/UtxoBurnt";
 export * from "./types/UtxoId";
 export * from "./types/UtxoInputSelection";
@@ -177,19 +194,18 @@ export * from "./types/UtxoOutput";
 export * from "./types/UtxoSpent";
 export * from "./types/UtxoStateUpdateSet";
 export * from "./types/UtxoTag";
-export * from "./types/Utxo";
 export * from "./types/UtxoUnspent";
 export * from "./types/UtxoUpdateSet";
-export * from "./types/ValidatorFeePoolAddress";
 export * from "./types/ValidatorFeePool";
+export * from "./types/ValidatorFeePoolAddress";
 export * from "./types/ValidatorFeeWithdrawal";
 export * from "./types/ValidatorSignatureBytes";
 export * from "./types/ValueKnowledgeProof";
+export * from "./types/Vault";
 export * from "./types/VaultFreezeFlags";
 export * from "./types/VaultId";
-export * from "./types/Vault";
-export * from "./types/VersionedSubstateIdLockIntent";
 export * from "./types/VersionedSubstateId";
+export * from "./types/VersionedSubstateIdLockIntent";
 export * from "./types/ViewableBalanceProof";
 export * from "./types/VotePower";
 export * from "./types/WalletTransaction";
@@ -200,9 +216,10 @@ export * from "./tari-indexer-client";
 export * from "./validator-node-client";
 export * from "./wallet-types";
 export * from "./helpers/BigAmount";
+export * from "./helpers/NetworkByte";
+export * from "./helpers/cbor";
 export * from "./helpers/consts";
 export * from "./helpers/enum";
 export * from "./helpers/helpers";
-export * from "./helpers/NetworkByte";
 export * from "./helpers/ootleAddress";
 export * from "./helpers/tariTypeTag";