@tari-project/tarijs-types 0.4.0

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, The Tari Developer Community
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/Amount.d.ts

@@ -0,0 +1,23 @@
+export declare class Amount {
+    private value;
+    constructor(value: number);
+    static readonly MAX: Amount;
+    static newAmount(amount: number): Amount;
+    static zero(): Amount;
+    isZero(): boolean;
+    isPositive(): boolean;
+    isNegative(): boolean;
+    getValue(): number;
+    getStringValue(): string;
+    checkedAdd(other: Amount): Amount | null;
+    saturatingAdd(other: Amount): Amount;
+    checkedSub(other: Amount): Amount | null;
+    saturatingSub(other: Amount): Amount;
+    saturatingSubPositive(other: Amount): Amount;
+    checkedSubPositive(other: Amount): Amount | null;
+    checkedMul(other: Amount): Amount | null;
+    saturatingMul(other: Amount): Amount;
+    checkedDiv(other: Amount): Amount | null;
+    saturatingDiv(other: Amount): Amount;
+    asU64Checked(): number | null;
+}

package/dist/Amount.js

@@ -0,0 +1,93 @@
+export class Amount {
+    value;
+    constructor(value) {
+        this.value = value;
+    }
+    static MAX = new Amount(Number.MAX_SAFE_INTEGER);
+    static newAmount(amount) {
+        return new Amount(amount);
+    }
+    static zero() {
+        return new Amount(0);
+    }
+    isZero() {
+        return this.value === 0;
+    }
+    isPositive() {
+        return this.value >= 0;
+    }
+    isNegative() {
+        return !this.isPositive();
+    }
+    getValue() {
+        return this.value;
+    }
+    getStringValue() {
+        return this.value.toString();
+    }
+    checkedAdd(other) {
+        const result = this.value + other.value;
+        if (result < Number.MIN_SAFE_INTEGER || result > Number.MAX_SAFE_INTEGER) {
+            return null;
+        }
+        return new Amount(result);
+    }
+    saturatingAdd(other) {
+        return new Amount(Math.min(Number.MAX_SAFE_INTEGER, Math.max(Number.MIN_SAFE_INTEGER, this.value + other.value)));
+    }
+    checkedSub(other) {
+        const result = this.value - other.value;
+        if (result < Number.MIN_SAFE_INTEGER || result > Number.MAX_SAFE_INTEGER) {
+            return null;
+        }
+        return new Amount(result);
+    }
+    saturatingSub(other) {
+        return new Amount(Math.min(Number.MAX_SAFE_INTEGER, Math.max(Number.MIN_SAFE_INTEGER, this.value - other.value)));
+    }
+    saturatingSubPositive(other) {
+        const result = this.value - other.value;
+        return result < 0 ? new Amount(0) : new Amount(result);
+    }
+    checkedSubPositive(other) {
+        if (this.isNegative() || other.isNegative()) {
+            return null;
+        }
+        if (this.value < other.value) {
+            return null;
+        }
+        return new Amount(this.value - other.value);
+    }
+    checkedMul(other) {
+        const result = this.value * other.value;
+        if (result < Number.MIN_SAFE_INTEGER || result > Number.MAX_SAFE_INTEGER) {
+            return null;
+        }
+        return new Amount(result);
+    }
+    saturatingMul(other) {
+        return new Amount(Math.min(Number.MAX_SAFE_INTEGER, Math.max(Number.MIN_SAFE_INTEGER, this.value * other.value)));
+    }
+    checkedDiv(other) {
+        if (other.value === 0) {
+            throw new Error("Division by zero");
+        }
+        const result = this.value / other.value;
+        if (result < Number.MIN_SAFE_INTEGER || result > Number.MAX_SAFE_INTEGER) {
+            return null;
+        }
+        return new Amount(result);
+    }
+    saturatingDiv(other) {
+        if (other.value === 0) {
+            throw new Error("Division by zero");
+        }
+        return new Amount(Math.min(Number.MAX_SAFE_INTEGER, Math.max(Number.MIN_SAFE_INTEGER, this.value / other.value)));
+    }
+    asU64Checked() {
+        if (this.value < 0) {
+            return null;
+        }
+        return this.value;
+    }
+}

package/dist/Arg.d.ts

@@ -0,0 +1 @@
+export type Arg = any;

package/dist/Arg.js

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

package/dist/ComponentAddress.d.ts

@@ -0,0 +1 @@
+export type ComponentAddress = string;

package/dist/ComponentAddress.js

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

package/dist/ConfidentialClaim.d.ts

@@ -0,0 +1,8 @@
+import type { ConfidentialWithdrawProof } from "./ConfidentialWithdrawProof";
+export interface ConfidentialClaim {
+    publicKey: string;
+    outputAddress: string;
+    rangeProof: Array<number>;
+    proofOfKnowledge: string;
+    withdrawProof?: ConfidentialWithdrawProof;
+}

package/dist/ConfidentialClaim.js

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

package/dist/ConfidentialOutput.d.ts

@@ -0,0 +1,8 @@
+import type { ElgamalVerifiableBalance } from "./ElgamalVerifiableBalance";
+export interface ConfidentialOutput {
+    commitment: string;
+    stealthPublicNonce: string;
+    encrypted_data: Array<number>;
+    minimumValuePromise: number;
+    viewableBalance?: ElgamalVerifiableBalance;
+}

package/dist/ConfidentialOutput.js

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

package/dist/ConfidentialOutputStatement.d.ts

@@ -0,0 +1,9 @@
+import type { Amount } from "./Amount";
+import type { ConfidentialStatement } from "./ConfidentialStatement";
+export interface ConfidentialOutputStatement {
+    outputStatement?: ConfidentialStatement;
+    changeStatement?: ConfidentialStatement;
+    rangeProof: Array<number>;
+    outputRevealedAmount: Amount;
+    changeRevealedAmount: Amount;
+}

package/dist/ConfidentialOutputStatement.js

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

package/dist/ConfidentialStatement.d.ts

@@ -0,0 +1,8 @@
+import type { ViewableBalanceProof } from "./ViewableBalanceProof";
+export interface ConfidentialStatement {
+    commitment: Array<number>;
+    senderPublicNonce: Array<number>;
+    encryptedData: Array<number>;
+    minimumValuePromise: number;
+    viewableBalanceProof?: ViewableBalanceProof;
+}

package/dist/ConfidentialStatement.js

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

package/dist/ConfidentialWithdrawProof.d.ts

@@ -0,0 +1,7 @@
+import type { ConfidentialOutputStatement } from "./ConfidentialOutputStatement";
+export interface ConfidentialWithdrawProof {
+    inputs: Array<Uint8Array>;
+    inputRevealedAmount: number;
+    outputProof: ConfidentialOutputStatement;
+    balanceProof: Array<number>;
+}

package/dist/ConfidentialWithdrawProof.js

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

package/dist/ElgamalVerifiableBalance.d.ts

@@ -0,0 +1,4 @@
+export interface ElgamalVerifiableBalance {
+    encrypted: string;
+    public_nonce: string;
+}

package/dist/ElgamalVerifiableBalance.js

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

package/dist/Epoch.d.ts

@@ -0,0 +1 @@
+export type Epoch = number;

package/dist/Epoch.js

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

package/dist/FinalizeResult.d.ts

@@ -0,0 +1,20 @@
+import { FeeReceipt, InstructionResult, LogEntry, RejectReason } from "@tari-project/typescript-bindings";
+import { SubstateDiff } from "./SubstateDiff";
+export type TxResultAccept = {
+    Accept: SubstateDiff;
+};
+export type TxResultAcceptFeeRejectRest = {
+    AcceptFeeRejectRest: [SubstateDiff, RejectReason];
+};
+export type TxResultReject = {
+    Reject: RejectReason;
+};
+export type FinalizeResultStatus = TxResultAccept | TxResultAcceptFeeRejectRest | TxResultReject;
+export interface FinalizeResult {
+    transaction_hash: Uint8Array;
+    events: Array<Event>;
+    logs: Array<LogEntry>;
+    execution_results: Array<InstructionResult>;
+    result: FinalizeResultStatus;
+    fee_receipt: FeeReceipt;
+}

package/dist/FinalizeResult.js

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

package/dist/Instruction.d.ts

@@ -0,0 +1,56 @@
+import { ComponentAddress, LogLevel } from "@tari-project/typescript-bindings";
+import { Arg } from "./Arg";
+import { ConfidentialClaim } from "./ConfidentialClaim";
+import { Amount } from "./Amount";
+import { ConfidentialOutput } from "./ConfidentialOutput";
+import { TemplateAddress } from "./TemplateAddress";
+export type Instruction = CreateAccount | CallFunction | CallMethod | PutLastInstructionOutputOnWorkspace | EmitLog | ClaimBurn | ClaimValidatorFees | DropAllProofsInWorkspace | CreateFreeTestCoins;
+export type CreateAccount = {
+    CreateAccount: {
+        owner_public_key: string;
+        workspace_bucket: string | null;
+    };
+};
+export type CallFunction = {
+    CallFunction: {
+        template_address: TemplateAddress;
+        function: string;
+        args: Array<Arg>;
+    };
+};
+export type CallMethod = {
+    CallMethod: {
+        component_address: ComponentAddress;
+        method: string;
+        args: Array<Arg>;
+    };
+};
+export type PutLastInstructionOutputOnWorkspace = {
+    PutLastInstructionOutputOnWorkspace: {
+        key: number[];
+    };
+};
+export type EmitLog = {
+    EmitLog: {
+        level: LogLevel;
+        message: string;
+    };
+};
+export type ClaimBurn = {
+    ClaimBurn: {
+        claim: ConfidentialClaim;
+    };
+};
+export type ClaimValidatorFees = {
+    ClaimValidatorFees: {
+        epoch: number;
+        validator_public_key: string;
+    };
+};
+export type DropAllProofsInWorkspace = "DropAllProofsInWorkspace";
+export type CreateFreeTestCoins = {
+    CreateFreeTestCoins: {
+        revealed_amount: Amount;
+        output: ConfidentialOutput | null;
+    };
+};

package/dist/Instruction.js

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

package/dist/ResourceAddress.d.ts

@@ -0,0 +1 @@
+export type ResourceAddress = string;

package/dist/ResourceAddress.js

@@ -0,0 +1,2 @@
+//TODO refactor type (https://github.com/tari-project/tari.js/issues/29)
+export {};

package/dist/SubstateDiff.d.ts

@@ -0,0 +1,7 @@
+import { Substate, SubstateId } from "@tari-project/typescript-bindings";
+export type UpSubstates = Array<[SubstateId, Substate]>;
+export type DownSubstates = Array<[SubstateId, number]>;
+export interface SubstateDiff {
+    up_substates: UpSubstates;
+    down_substates: DownSubstates;
+}

package/dist/SubstateDiff.js

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

package/dist/SubstateRequirement.d.ts

@@ -0,0 +1,5 @@
+import { SubstateId } from "@tari-project/typescript-bindings";
+export interface SubstateRequirement {
+    substateId: SubstateId;
+    version?: number;
+}

package/dist/SubstateRequirement.js

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

package/dist/TemplateAddress.d.ts

@@ -0,0 +1 @@
+export type TemplateAddress = string;

package/dist/TemplateAddress.js

@@ -0,0 +1,2 @@
+//TODO refactor type (https://github.com/tari-project/tari.js/issues/29)
+export {};

package/dist/Transaction.d.ts

@@ -0,0 +1,15 @@
+import { Instruction } from "./Instruction";
+import { SubstateRequirement } from "./SubstateRequirement";
+import { Epoch } from "./Epoch";
+import { VersionedSubstateId } from "./VersionedSubstateId";
+import { TransactionSignature } from "./TransactionSignature";
+export interface Transaction {
+    id: string;
+    feeInstructions: Array<Instruction>;
+    instructions: Array<Instruction>;
+    inputs: Array<SubstateRequirement>;
+    minEpoch?: Epoch;
+    maxEpoch?: Epoch;
+    signatures: Array<TransactionSignature>;
+    filledInputs: Array<VersionedSubstateId>;
+}

package/dist/Transaction.js

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

package/dist/TransactionId.d.ts

@@ -0,0 +1 @@
+export type TransactionId = string;

package/dist/TransactionId.js

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

package/dist/TransactionResult.d.ts

@@ -0,0 +1,22 @@
+import { FinalizeResult } from "./FinalizeResult";
+export type SubmitTransactionResponse = {
+    transaction_id: string;
+};
+export interface SubmitTxResult {
+    response: SubmitTransactionResponse;
+    result: TransactionResult;
+}
+export declare enum TransactionStatus {
+    New = 0,
+    DryRun = 1,
+    Pending = 2,
+    Accepted = 3,
+    Rejected = 4,
+    InvalidTransaction = 5,
+    OnlyFeeAccepted = 6
+}
+export type TransactionResult = {
+    transaction_id: string;
+    status: TransactionStatus;
+    result: FinalizeResult | null;
+};

package/dist/TransactionResult.js

@@ -0,0 +1,10 @@
+export var TransactionStatus;
+(function (TransactionStatus) {
+    TransactionStatus[TransactionStatus["New"] = 0] = "New";
+    TransactionStatus[TransactionStatus["DryRun"] = 1] = "DryRun";
+    TransactionStatus[TransactionStatus["Pending"] = 2] = "Pending";
+    TransactionStatus[TransactionStatus["Accepted"] = 3] = "Accepted";
+    TransactionStatus[TransactionStatus["Rejected"] = 4] = "Rejected";
+    TransactionStatus[TransactionStatus["InvalidTransaction"] = 5] = "InvalidTransaction";
+    TransactionStatus[TransactionStatus["OnlyFeeAccepted"] = 6] = "OnlyFeeAccepted";
+})(TransactionStatus || (TransactionStatus = {}));

package/dist/TransactionSignature.d.ts

@@ -0,0 +1,4 @@
+export interface TransactionSignature {
+    public_key: string;
+    signature: string;
+}

package/dist/TransactionSignature.js

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

package/dist/UnsignedTransaction.d.ts

@@ -0,0 +1,12 @@
+import { Instruction } from "./Instruction";
+import { Epoch } from "./Epoch";
+import { SubstateRequirement } from "./SubstateRequirement";
+import { VersionedSubstateId } from "./VersionedSubstateId";
+export interface UnsignedTransaction {
+    feeInstructions: Instruction[];
+    instructions: Instruction[];
+    inputs: SubstateRequirement[];
+    filledInputs: VersionedSubstateId[];
+    minEpoch?: Epoch;
+    maxEpoch?: Epoch;
+}

package/dist/UnsignedTransaction.js

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

package/dist/VersionedSubstateId.d.ts

@@ -0,0 +1,5 @@
+import { SubstateId } from "@tari-project/typescript-bindings";
+export interface VersionedSubstateId {
+    substateId: SubstateId;
+    version: number;
+}

package/dist/VersionedSubstateId.js

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

package/dist/ViewableBalanceProof.d.ts

@@ -0,0 +1,10 @@
+export interface ViewableBalanceProof {
+    elgamal_encrypted: Uint8Array;
+    elgamal_public_nonce: Uint8Array;
+    c_prime: Uint8Array;
+    e_prime: Uint8Array;
+    r_prime: Uint8Array;
+    s_v: Uint8Array;
+    s_m: Uint8Array;
+    s_r: Uint8Array;
+}

package/dist/ViewableBalanceProof.js

@@ -0,0 +1,2 @@
+//TODO refactor type (https://github.com/tari-project/tari.js/issues/29)
+export {};

package/dist/Workspace.d.ts

@@ -0,0 +1,3 @@
+export interface WorkspaceArg {
+    Workspace: number[];
+}

package/dist/Workspace.js

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

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+export { TemplateAddress } from "./TemplateAddress";
+export { Amount } from "./Amount";
+export { Arg } from "./Arg";
+export { ComponentAddress } from "./ComponentAddress";
+export { ConfidentialClaim } from "./ConfidentialClaim";
+export { ConfidentialOutput } from "./ConfidentialOutput";
+export { ConfidentialOutputStatement } from "./ConfidentialOutputStatement";
+export { ConfidentialStatement } from "./ConfidentialStatement";
+export { ConfidentialWithdrawProof } from "./ConfidentialWithdrawProof";
+export { Epoch } from "./Epoch";
+export { FinalizeResult, FinalizeResultStatus, TxResultAccept, TxResultAcceptFeeRejectRest, TxResultReject, } from "./FinalizeResult";
+export { ResourceAddress } from "./ResourceAddress";
+export { Instruction } from "./Instruction";
+export { Transaction } from "./Transaction";
+export { SubstateDiff, DownSubstates, UpSubstates } from "./SubstateDiff";
+export { SubstateRequirement } from "./SubstateRequirement";
+export { TransactionId } from "./TransactionId";
+export { TransactionResult, TransactionStatus, SubmitTxResult, SubmitTransactionResponse } from "./TransactionResult";
+export { TransactionSignature } from "./TransactionSignature";
+export { UnsignedTransaction } from "./UnsignedTransaction";
+export { VersionedSubstateId } from "./VersionedSubstateId";
+export { ViewableBalanceProof } from "./ViewableBalanceProof";
+export { WorkspaceArg } from "./Workspace";

package/dist/index.js

@@ -0,0 +1,2 @@
+export { Amount } from "./Amount";
+export { TransactionStatus } from "./TransactionResult";

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@tari-project/tarijs-types",
+  "version": "0.4.0",
+  "description": "",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@tari-project/typescript-bindings": "^1.4.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.1",
+    "typescript": "^5.0.4"
+  },
+  "files": [
+    "/dist"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -b"
+  }
+}