@sravankumar02/sdk-core 1.0.0

package/out/abi/smartContract.d.ts

@@ -0,0 +1,74 @@
+import { Address } from "../core/address";
+import { Transaction } from "../core/transaction";
+import { ContractFunction } from "./function";
+import { Interaction } from "./interaction";
+import { CallArguments, DeployArguments, ISmartContract, QueryArguments, UpgradeArguments } from "./interface";
+import { Query } from "./query";
+import { Abi, EndpointDefinition, TypedValue } from "./typesystem";
+/**
+ * * @deprecated component. Use "SmartContractTransactionsFactory" or "SmartContractController", instead.
+ *
+ * An abstraction for deploying and interacting with Smart Contracts.
+ */
+export declare class SmartContract implements ISmartContract {
+    private address;
+    private abi?;
+    /**
+     * This object contains a function for each endpoint defined by the contract.
+     * (a bit similar to web3js's "contract.methods").
+     */
+    readonly methodsExplicit: {
+        [key: string]: (args?: TypedValue[]) => Interaction;
+    };
+    /**
+     * This object contains a function for each endpoint defined by the contract.
+     * (a bit similar to web3js's "contract.methods").
+     *
+     * This is an alternative to {@link methodsExplicit}.
+     * Unlike {@link methodsExplicit}, automatic type inference (wrt. ABI) is applied when using {@link methods}.
+     */
+    readonly methods: {
+        [key: string]: (args?: any[]) => Interaction;
+    };
+    /**
+     * Create a SmartContract object by providing its address on the Network.
+     */
+    constructor(options?: {
+        address?: Address;
+        abi?: Abi;
+    });
+    private setupMethods;
+    /**
+     * Sets the address, as on Network.
+     */
+    setAddress(address: Address): void;
+    /**
+     * Gets the address, as on Network.
+     */
+    getAddress(): Address;
+    private getAbi;
+    getEndpoint(name: string | ContractFunction): EndpointDefinition;
+    /**
+     * Creates a {@link Transaction} for deploying the Smart Contract to the Network.
+     */
+    deploy({ deployer, code, codeMetadata, initArguments, value, gasLimit, gasPrice, chainID, }: DeployArguments): Transaction;
+    private getMetadataPropertiesAsObject;
+    /**
+     * Creates a {@link Transaction} for upgrading the Smart Contract on the Network.
+     */
+    upgrade({ caller, code, codeMetadata, initArguments, value, gasLimit, gasPrice, chainID, }: UpgradeArguments): Transaction;
+    /**
+     * Creates a {@link Transaction} for calling (a function of) the Smart Contract.
+     */
+    call({ func, args, value, gasLimit, receiver, gasPrice, chainID, caller }: CallArguments): Transaction;
+    createQuery({ func, args, value, caller }: QueryArguments): Query;
+    private ensureHasAddress;
+    /**
+     * Computes the address of a Smart Contract.
+     * The address is computed deterministically, from the address of the owner and the nonce of the deployment transaction.
+     *
+     * @param owner The owner of the Smart Contract
+     * @param nonce The owner nonce used for the deployment transaction
+     */
+    static computeAddress(owner: Address, nonce: bigint): Address;
+}

package/out/abi/smartContract.js

@@ -0,0 +1,208 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SmartContract = void 0;
+const address_1 = require("../core/address");
+const codeMetadata_1 = require("../core/codeMetadata");
+const compatibility_1 = require("../core/compatibility");
+const constants_1 = require("../core/constants");
+const errors_1 = require("../core/errors");
+const transactionsFactoryConfig_1 = require("../core/transactionsFactoryConfig");
+const utils_1 = require("../core/utils");
+const smartContractTransactionsFactory_1 = require("./../smartContracts/smartContractTransactionsFactory");
+const function_1 = require("./function");
+const interaction_1 = require("./interaction");
+const nativeSerializer_1 = require("./nativeSerializer");
+const query_1 = require("./query");
+/**
+ * * @deprecated component. Use "SmartContractTransactionsFactory" or "SmartContractController", instead.
+ *
+ * An abstraction for deploying and interacting with Smart Contracts.
+ */
+class SmartContract {
+    /**
+     * Create a SmartContract object by providing its address on the Network.
+     */
+    constructor(options = {}) {
+        this.address = address_1.Address.empty();
+        /**
+         * This object contains a function for each endpoint defined by the contract.
+         * (a bit similar to web3js's "contract.methods").
+         */
+        this.methodsExplicit = {};
+        /**
+         * This object contains a function for each endpoint defined by the contract.
+         * (a bit similar to web3js's "contract.methods").
+         *
+         * This is an alternative to {@link methodsExplicit}.
+         * Unlike {@link methodsExplicit}, automatic type inference (wrt. ABI) is applied when using {@link methods}.
+         */
+        this.methods = {};
+        this.address = options.address || address_1.Address.empty();
+        this.abi = options.abi;
+        if (this.abi) {
+            this.setupMethods();
+        }
+    }
+    setupMethods() {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        let contract = this;
+        let abi = this.getAbi();
+        for (const definition of abi.getEndpoints()) {
+            let functionName = definition.name;
+            // For each endpoint defined by the ABI, we attach a function to the "methods" and "methodsAuto" objects,
+            // a function that receives typed values as arguments
+            // and returns a prepared contract interaction.
+            this.methodsExplicit[functionName] = function (args) {
+                let func = new function_1.ContractFunction(functionName);
+                let interaction = new interaction_1.Interaction(contract, func, args || []);
+                return interaction;
+            };
+            this.methods[functionName] = function (args) {
+                let func = new function_1.ContractFunction(functionName);
+                // Perform automatic type inference, wrt. the endpoint definition:
+                let typedArgs = nativeSerializer_1.NativeSerializer.nativeToTypedValues(args || [], definition);
+                let interaction = new interaction_1.Interaction(contract, func, typedArgs || []);
+                return interaction;
+            };
+        }
+    }
+    /**
+     * Sets the address, as on Network.
+     */
+    setAddress(address) {
+        this.address = address;
+    }
+    /**
+     * Gets the address, as on Network.
+     */
+    getAddress() {
+        return this.address;
+    }
+    getAbi() {
+        utils_1.guardValueIsSet("abi", this.abi);
+        return this.abi;
+    }
+    getEndpoint(name) {
+        if (typeof name === "string") {
+            return this.getAbi().getEndpoint(name);
+        }
+        return this.getAbi().getEndpoint(name.name);
+    }
+    /**
+     * Creates a {@link Transaction} for deploying the Smart Contract to the Network.
+     */
+    deploy({ deployer, code, codeMetadata, initArguments, value, gasLimit, gasPrice, chainID, }) {
+        compatibility_1.Compatibility.guardAddressIsSetAndNonZero(deployer, "'deployer' of SmartContract.deploy()", "pass the actual address to deploy()");
+        const config = new transactionsFactoryConfig_1.TransactionsFactoryConfig({ chainID: chainID.valueOf() });
+        const factory = new smartContractTransactionsFactory_1.SmartContractTransactionsFactory({
+            config: config,
+            abi: this.abi,
+        });
+        const bytecode = Buffer.from(code.toString(), "hex");
+        const metadataAsJson = this.getMetadataPropertiesAsObject(codeMetadata);
+        const transaction = factory.createTransactionForDeploy(deployer, {
+            bytecode: bytecode,
+            gasLimit: BigInt(gasLimit.valueOf()),
+            arguments: initArguments ?? [],
+            isUpgradeable: metadataAsJson.upgradeable,
+            isReadable: metadataAsJson.readable,
+            isPayable: metadataAsJson.payable,
+            isPayableBySmartContract: metadataAsJson.payableBySc,
+        });
+        transaction.chainID = chainID;
+        transaction.value = value ?? 0n;
+        transaction.gasPrice = gasPrice ?? BigInt(constants_1.TRANSACTION_MIN_GAS_PRICE);
+        return transaction;
+    }
+    getMetadataPropertiesAsObject(codeMetadata) {
+        let metadata;
+        if (codeMetadata) {
+            metadata = codeMetadata_1.CodeMetadata.newFromBytes(Buffer.from(codeMetadata.toString(), "hex"));
+        }
+        else {
+            metadata = new codeMetadata_1.CodeMetadata();
+        }
+        const metadataAsJson = metadata.toJSON();
+        return metadataAsJson;
+    }
+    /**
+     * Creates a {@link Transaction} for upgrading the Smart Contract on the Network.
+     */
+    upgrade({ caller, code, codeMetadata, initArguments, value, gasLimit, gasPrice, chainID, }) {
+        compatibility_1.Compatibility.guardAddressIsSetAndNonZero(caller, "'caller' of SmartContract.upgrade()", "pass the actual address to upgrade()");
+        this.ensureHasAddress();
+        const config = new transactionsFactoryConfig_1.TransactionsFactoryConfig({ chainID: chainID.valueOf() });
+        const factory = new smartContractTransactionsFactory_1.SmartContractTransactionsFactory({
+            config: config,
+            abi: this.abi,
+        });
+        const bytecode = Uint8Array.from(Buffer.from(code.toString(), "hex"));
+        const metadataAsJson = this.getMetadataPropertiesAsObject(codeMetadata);
+        const transaction = factory.createTransactionForUpgrade(caller, {
+            contract: this.getAddress(),
+            bytecode: bytecode,
+            gasLimit: BigInt(gasLimit.valueOf()),
+            arguments: initArguments ?? [],
+            isUpgradeable: metadataAsJson.upgradeable,
+            isReadable: metadataAsJson.readable,
+            isPayable: metadataAsJson.payable,
+            isPayableBySmartContract: metadataAsJson.payableBySc,
+        });
+        transaction.chainID = chainID;
+        transaction.value = value ?? 0n;
+        transaction.gasPrice = gasPrice ?? BigInt(constants_1.TRANSACTION_MIN_GAS_PRICE);
+        return transaction;
+    }
+    /**
+     * Creates a {@link Transaction} for calling (a function of) the Smart Contract.
+     */
+    call({ func, args, value, gasLimit, receiver, gasPrice, chainID, caller }) {
+        compatibility_1.Compatibility.guardAddressIsSetAndNonZero(caller, "'caller' of SmartContract.call()", "pass the actual address to call()");
+        this.ensureHasAddress();
+        const config = new transactionsFactoryConfig_1.TransactionsFactoryConfig({ chainID: chainID.valueOf() });
+        const factory = new smartContractTransactionsFactory_1.SmartContractTransactionsFactory({
+            config: config,
+            abi: this.abi,
+        });
+        args = args || [];
+        value = value || 0n;
+        const transaction = factory.createTransactionForExecute(caller, {
+            contract: receiver ? receiver : this.getAddress(),
+            function: func.toString(),
+            gasLimit: gasLimit,
+            arguments: args,
+        });
+        transaction.chainID = chainID;
+        transaction.value = value;
+        transaction.gasPrice = gasPrice ?? BigInt(constants_1.TRANSACTION_MIN_GAS_PRICE);
+        return transaction;
+    }
+    createQuery({ func, args, value, caller }) {
+        this.ensureHasAddress();
+        return new query_1.Query({
+            address: this.getAddress(),
+            func: func,
+            args: args,
+            value: value,
+            caller: caller,
+        });
+    }
+    ensureHasAddress() {
+        if (!this.getAddress().toBech32()) {
+            throw new errors_1.ErrContractHasNoAddress();
+        }
+    }
+    /**
+     * Computes the address of a Smart Contract.
+     * The address is computed deterministically, from the address of the owner and the nonce of the deployment transaction.
+     *
+     * @param owner The owner of the Smart Contract
+     * @param nonce The owner nonce used for the deployment transaction
+     */
+    static computeAddress(owner, nonce) {
+        const addressComputer = new address_1.AddressComputer();
+        return addressComputer.computeContractAddress(owner, BigInt(nonce.valueOf()));
+    }
+}
+exports.SmartContract = SmartContract;
+//# sourceMappingURL=smartContract.js.map

package/out/abi/smartContract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartContract.js","sourceRoot":"","sources":["../../src/abi/smartContract.ts"],"names":[],"mappings":";;;AAAA,6CAA2D;AAC3D,uDAAoD;AACpD,yDAAsD;AACtD,iDAA8D;AAC9D,2CAAyD;AAEzD,iFAA8E;AAC9E,yCAAgD;AAChD,2GAAwG;AACxG,yCAA8C;AAC9C,+CAA4C;AAS5C,yDAAsD;AACtD,mCAAgC;AAGhC;;;;GAIG;AACH,MAAa,aAAa;IAmBtB;;OAEG;IACH,YAAY,UAA4C,EAAE;QArBlD,YAAO,GAAY,iBAAO,CAAC,KAAK,EAAE,CAAC;QAG3C;;;WAGG;QACa,oBAAe,GAA4D,EAAE,CAAC;QAE9F;;;;;;WAMG;QACa,YAAO,GAAqD,EAAE,CAAC;QAM3E,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,iBAAO,CAAC,KAAK,EAAE,CAAC;QAClD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QAEvB,IAAI,IAAI,CAAC,GAAG,EAAE;YACV,IAAI,CAAC,YAAY,EAAE,CAAC;SACvB;IACL,CAAC;IAEO,YAAY;QAChB,4DAA4D;QAC5D,IAAI,QAAQ,GAAG,IAAI,CAAC;QACpB,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAExB,KAAK,MAAM,UAAU,IAAI,GAAG,CAAC,YAAY,EAAE,EAAE;YACzC,IAAI,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC;YAEnC,yGAAyG;YACzG,qDAAqD;YACrD,+CAA+C;YAC/C,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,GAAG,UAAU,IAAmB;gBAC9D,IAAI,IAAI,GAAG,IAAI,2BAAgB,CAAC,YAAY,CAAC,CAAC;gBAC9C,IAAI,WAAW,GAAG,IAAI,yBAAW,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;gBAC9D,OAAO,WAAW,CAAC;YACvB,CAAC,CAAC;YAEF,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,UAAU,IAAY;gBAC/C,IAAI,IAAI,GAAG,IAAI,2BAAgB,CAAC,YAAY,CAAC,CAAC;gBAC9C,kEAAkE;gBAClE,IAAI,SAAS,GAAG,mCAAgB,CAAC,mBAAmB,CAAC,IAAI,IAAI,EAAE,EAAE,UAAU,CAAC,CAAC;gBAC7E,IAAI,WAAW,GAAG,IAAI,yBAAW,CAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC;gBACnE,OAAO,WAAW,CAAC;YACvB,CAAC,CAAC;SACL;IACL,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,OAAgB;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,UAAU;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAEO,MAAM;QACV,uBAAe,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,GAAI,CAAC;IACrB,CAAC;IAED,WAAW,CAAC,IAA+B;QACvC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;SAC1C;QACD,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EACH,QAAQ,EACR,IAAI,EACJ,YAAY,EACZ,aAAa,EACb,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,OAAO,GACO;QACd,6BAAa,CAAC,2BAA2B,CACrC,QAAQ,EACR,sCAAsC,EACtC,qCAAqC,CACxC,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,qDAAyB,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC7E,MAAM,OAAO,GAAG,IAAI,mEAAgC,CAAC;YACjD,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,IAAI,CAAC,GAAG;SAChB,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;QACrD,MAAM,cAAc,GAAG,IAAI,CAAC,6BAA6B,CAAC,YAAY,CAAC,CAAC;QAExE,MAAM,WAAW,GAAG,OAAO,CAAC,0BAA0B,CAAC,QAAQ,EAAE;YAC7D,QAAQ,EAAE,QAAQ;YAClB,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACpC,SAAS,EAAE,aAAa,IAAI,EAAE;YAC9B,aAAa,EAAE,cAAc,CAAC,WAAW;YACzC,UAAU,EAAE,cAAc,CAAC,QAAQ;YACnC,SAAS,EAAE,cAAc,CAAC,OAAO;YACjC,wBAAwB,EAAE,cAAc,CAAC,WAAW;SACvD,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;QAC9B,WAAW,CAAC,KAAK,GAAG,KAAK,IAAI,EAAE,CAAC;QAChC,WAAW,CAAC,QAAQ,GAAG,QAAQ,IAAI,MAAM,CAAC,qCAAyB,CAAC,CAAC;QAErE,OAAO,WAAW,CAAC;IACvB,CAAC;IAEO,6BAA6B,CAAC,YAA4B;QAM9D,IAAI,QAAsB,CAAC;QAC3B,IAAI,YAAY,EAAE;YACd,QAAQ,GAAG,2BAAY,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;SACrF;aAAM;YACH,QAAQ,GAAG,IAAI,2BAAY,EAAE,CAAC;SACjC;QACD,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,EAKrC,CAAC;QAEF,OAAO,cAAc,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,EACJ,MAAM,EACN,IAAI,EACJ,YAAY,EACZ,aAAa,EACb,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,OAAO,GACQ;QACf,6BAAa,CAAC,2BAA2B,CACrC,MAAM,EACN,qCAAqC,EACrC,sCAAsC,CACzC,CAAC;QAEF,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAExB,MAAM,MAAM,GAAG,IAAI,qDAAyB,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC7E,MAAM,OAAO,GAAG,IAAI,mEAAgC,CAAC;YACjD,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,IAAI,CAAC,GAAG;SAChB,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACtE,MAAM,cAAc,GAAG,IAAI,CAAC,6BAA6B,CAAC,YAAY,CAAC,CAAC;QAExE,MAAM,WAAW,GAAG,OAAO,CAAC,2BAA2B,CAAC,MAAM,EAAE;YAC5D,QAAQ,EAAE,IAAI,CAAC,UAAU,EAAE;YAC3B,QAAQ,EAAE,QAAQ;YAClB,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACpC,SAAS,EAAE,aAAa,IAAI,EAAE;YAC9B,aAAa,EAAE,cAAc,CAAC,WAAW;YACzC,UAAU,EAAE,cAAc,CAAC,QAAQ;YACnC,SAAS,EAAE,cAAc,CAAC,OAAO;YACjC,wBAAwB,EAAE,cAAc,CAAC,WAAW;SACvD,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;QAC9B,WAAW,CAAC,KAAK,GAAG,KAAK,IAAI,EAAE,CAAC;QAChC,WAAW,CAAC,QAAQ,GAAG,QAAQ,IAAI,MAAM,CAAC,qCAAyB,CAAC,CAAC;QAErE,OAAO,WAAW,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAiB;QACpF,6BAAa,CAAC,2BAA2B,CACrC,MAAM,EACN,kCAAkC,EAClC,mCAAmC,CACtC,CAAC;QAEF,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAExB,MAAM,MAAM,GAAG,IAAI,qDAAyB,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC7E,MAAM,OAAO,GAAG,IAAI,mEAAgC,CAAC;YACjD,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,IAAI,CAAC,GAAG;SAChB,CAAC,CAAC;QAEH,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,KAAK,GAAG,KAAK,IAAI,EAAE,CAAC;QAEpB,MAAM,WAAW,GAAG,OAAO,CAAC,2BAA2B,CAAC,MAAM,EAAE;YAC5D,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE;YACjD,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE;YACzB,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,IAAI;SAClB,CAAC,CAAC;QAEH,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;QAC9B,WAAW,CAAC,KAAK,GAAG,KAAK,CAAC;QAC1B,WAAW,CAAC,QAAQ,GAAG,QAAQ,IAAI,MAAM,CAAC,qCAAyB,CAAC,CAAC;QAErE,OAAO,WAAW,CAAC;IACvB,CAAC;IAED,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAkB;QACrD,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAExB,OAAO,IAAI,aAAK,CAAC;YACb,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;YAC1B,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACjB,CAAC,CAAC;IACP,CAAC;IAEO,gBAAgB;QACpB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE;YAC/B,MAAM,IAAI,gCAAuB,EAAE,CAAC;SACvC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,CAAC,KAAc,EAAE,KAAa;QAC/C,MAAM,eAAe,GAAG,IAAI,yBAAe,EAAE,CAAC;QAC9C,OAAO,eAAe,CAAC,sBAAsB,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAClF,CAAC;CACJ;AAvQD,sCAuQC"}

package/out/abi/typeFormula.d.ts

@@ -0,0 +1,7 @@
+export declare class TypeFormula {
+    name: string;
+    metadata: any;
+    typeParameters: TypeFormula[];
+    constructor(name: string, typeParameters: TypeFormula[], metadata?: any);
+    toString(): string;
+}

package/out/abi/typeFormula.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeFormula = void 0;
+class TypeFormula {
+    constructor(name, typeParameters, metadata) {
+        this.name = name;
+        this.typeParameters = typeParameters;
+        this.metadata = metadata;
+    }
+    toString() {
+        const hasTypeParameters = this.typeParameters.length > 0;
+        const typeParameters = hasTypeParameters
+            ? `<${this.typeParameters.map((tp) => tp.toString()).join(", ")}>`
+            : "";
+        const baseName = `${this.name}${typeParameters}`;
+        return this.metadata !== undefined ? `${baseName}*${this.metadata}*` : baseName;
+    }
+}
+exports.TypeFormula = TypeFormula;
+//# sourceMappingURL=typeFormula.js.map

package/out/abi/typeFormula.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeFormula.js","sourceRoot":"","sources":["../../src/abi/typeFormula.ts"],"names":[],"mappings":";;;AAAA,MAAa,WAAW;IAKpB,YAAY,IAAY,EAAE,cAA6B,EAAE,QAAc;QACnE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED,QAAQ;QACJ,MAAM,iBAAiB,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;QACzD,MAAM,cAAc,GAAG,iBAAiB;YACpC,CAAC,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;YAClE,CAAC,CAAC,EAAE,CAAC;QACT,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,IAAI,GAAG,cAAc,EAAE,CAAC;QAEjD,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC;IACpF,CAAC;CACJ;AApBD,kCAoBC"}

package/out/abi/typeFormulaParser.d.ts

@@ -0,0 +1,14 @@
+import { TypeFormula } from "./typeFormula";
+export declare class TypeFormulaParser {
+    static BEGIN_TYPE_PARAMETERS: string;
+    static END_TYPE_PARAMETERS: string;
+    static COMMA: string;
+    static PUNCTUATION: string[];
+    parseExpression(expression: string): TypeFormula;
+    private tokenizeExpression;
+    private acquireTypeWithParameters;
+    private acquireTypeParameters;
+    private isPunctuation;
+    private isEndOfTypeParameters;
+    private isBeginningOfTypeParameters;
+}

package/out/abi/typeFormulaParser.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeFormulaParser = void 0;
+const typeFormula_1 = require("./typeFormula");
+class TypeFormulaParser {
+    parseExpression(expression) {
+        expression = expression.trim();
+        const tokens = this.tokenizeExpression(expression).filter((token) => token !== TypeFormulaParser.COMMA);
+        const stack = [];
+        for (const token of tokens) {
+            if (this.isPunctuation(token)) {
+                if (this.isEndOfTypeParameters(token)) {
+                    const typeFormula = this.acquireTypeWithParameters(stack);
+                    stack.push(typeFormula);
+                }
+                else if (this.isBeginningOfTypeParameters(token)) {
+                    // This symbol is pushed as a simple string.
+                    stack.push(token);
+                }
+                else {
+                    throw new Error(`Unexpected token (punctuation): ${token}`);
+                }
+            }
+            else {
+                // It's a type name. We push it as a simple string.
+                stack.push(token);
+            }
+        }
+        if (stack.length !== 1) {
+            throw new Error(`Unexpected stack length at end of parsing: ${stack.length}`);
+        }
+        if (TypeFormulaParser.PUNCTUATION.includes(stack[0])) {
+            throw new Error("Unexpected root element.");
+        }
+        const item = stack[0];
+        if (item instanceof typeFormula_1.TypeFormula) {
+            return item;
+        }
+        else if (typeof item === "string") {
+            // Expression contained a simple, non-generic type.
+            return new typeFormula_1.TypeFormula(item, []);
+        }
+        else {
+            throw new Error(`Unexpected item on stack: ${item}`);
+        }
+    }
+    tokenizeExpression(expression) {
+        const tokens = [];
+        let currentToken = "";
+        for (const character of expression) {
+            if (this.isPunctuation(character)) {
+                if (currentToken) {
+                    // Retain current token
+                    tokens.push(currentToken.trim());
+                    // Reset current token
+                    currentToken = "";
+                }
+                // Punctuation character
+                tokens.push(character);
+            }
+            else {
+                currentToken += character;
+            }
+        }
+        if (currentToken) {
+            // Retain the last token (if any).
+            tokens.push(currentToken.trim());
+        }
+        return tokens;
+    }
+    acquireTypeWithParameters(stack) {
+        const typeParameters = this.acquireTypeParameters(stack);
+        const typeName = stack.pop();
+        if (typeName === "ManagedDecimal" || typeName === "ManagedDecimalSigned") {
+            const metadata = typeParameters[0].name;
+            const typeFormula = new typeFormula_1.TypeFormula(typeName, [], metadata);
+            return typeFormula;
+        }
+        const typeFormula = new typeFormula_1.TypeFormula(typeName, typeParameters.reverse());
+        return typeFormula;
+    }
+    acquireTypeParameters(stack) {
+        const typeParameters = [];
+        while (true) {
+            const item = stack.pop();
+            if (item === undefined) {
+                throw new Error("Badly specified type parameters");
+            }
+            if (this.isBeginningOfTypeParameters(item)) {
+                // We've acquired all type parameters.
+                break;
+            }
+            if (item instanceof typeFormula_1.TypeFormula) {
+                // Type parameter is a previously-acquired type.
+                typeParameters.push(item);
+            }
+            else if (typeof item === "string") {
+                // Type parameter is a simple, non-generic type.
+                typeParameters.push(new typeFormula_1.TypeFormula(item, []));
+            }
+            else {
+                throw new Error(`Unexpected type parameter object in stack: ${item}`);
+            }
+        }
+        return typeParameters;
+    }
+    isPunctuation(token) {
+        return TypeFormulaParser.PUNCTUATION.includes(token);
+    }
+    isEndOfTypeParameters(token) {
+        return token === TypeFormulaParser.END_TYPE_PARAMETERS;
+    }
+    isBeginningOfTypeParameters(token) {
+        return token === TypeFormulaParser.BEGIN_TYPE_PARAMETERS;
+    }
+}
+exports.TypeFormulaParser = TypeFormulaParser;
+TypeFormulaParser.BEGIN_TYPE_PARAMETERS = "<";
+TypeFormulaParser.END_TYPE_PARAMETERS = ">";
+TypeFormulaParser.COMMA = ",";
+TypeFormulaParser.PUNCTUATION = [
+    TypeFormulaParser.COMMA,
+    TypeFormulaParser.BEGIN_TYPE_PARAMETERS,
+    TypeFormulaParser.END_TYPE_PARAMETERS,
+];
+//# sourceMappingURL=typeFormulaParser.js.map

package/out/abi/typeFormulaParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeFormulaParser.js","sourceRoot":"","sources":["../../src/abi/typeFormulaParser.ts"],"names":[],"mappings":";;;AAAA,+CAA4C;AAE5C,MAAa,iBAAiB;IAU1B,eAAe,CAAC,UAAkB;QAC9B,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACxG,MAAM,KAAK,GAAU,EAAE,CAAC;QAExB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YACxB,IAAI,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;gBAC3B,IAAI,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE;oBACnC,MAAM,WAAW,GAAG,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;oBAC1D,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;iBAC3B;qBAAM,IAAI,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,EAAE;oBAChD,4CAA4C;oBAC5C,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACrB;qBAAM;oBACH,MAAM,IAAI,KAAK,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;iBAC/D;aACJ;iBAAM;gBACH,mDAAmD;gBACnD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACJ;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,8CAA8C,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;SACjF;QACD,IAAI,iBAAiB,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;YAClD,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC/C;QAED,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAEtB,IAAI,IAAI,YAAY,yBAAW,EAAE;YAC7B,OAAO,IAAI,CAAC;SACf;aAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YACjC,mDAAmD;YACnD,OAAO,IAAI,yBAAW,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;SACpC;aAAM;YACH,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;SACxD;IACL,CAAC;IAEO,kBAAkB,CAAC,UAAkB;QACzC,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,IAAI,YAAY,GAAG,EAAE,CAAC;QAEtB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;YAChC,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE;gBAC/B,IAAI,YAAY,EAAE;oBACd,uBAAuB;oBACvB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;oBACjC,sBAAsB;oBACtB,YAAY,GAAG,EAAE,CAAC;iBACrB;gBAED,wBAAwB;gBACxB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC1B;iBAAM;gBACH,YAAY,IAAI,SAAS,CAAC;aAC7B;SACJ;QAED,IAAI,YAAY,EAAE;YACd,kCAAkC;YAClC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;SACpC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,yBAAyB,CAAC,KAAY;QAC1C,MAAM,cAAc,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;QAE7B,IAAI,QAAQ,KAAK,gBAAgB,IAAI,QAAQ,KAAK,sBAAsB,EAAE;YACtE,MAAM,QAAQ,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,MAAM,WAAW,GAAG,IAAI,yBAAW,CAAC,QAAQ,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;YAC5D,OAAO,WAAW,CAAC;SACtB;QACD,MAAM,WAAW,GAAG,IAAI,yBAAW,CAAC,QAAQ,EAAE,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC;QACxE,OAAO,WAAW,CAAC;IACvB,CAAC;IAEO,qBAAqB,CAAC,KAAY;QACtC,MAAM,cAAc,GAAkB,EAAE,CAAC;QAEzC,OAAO,IAAI,EAAE;YACT,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;YACzB,IAAI,IAAI,KAAK,SAAS,EAAE;gBACpB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;aACtD;YAED,IAAI,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,EAAE;gBACxC,sCAAsC;gBACtC,MAAM;aACT;YAED,IAAI,IAAI,YAAY,yBAAW,EAAE;gBAC7B,gDAAgD;gBAChD,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC7B;iBAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBACjC,gDAAgD;gBAChD,cAAc,CAAC,IAAI,CAAC,IAAI,yBAAW,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;aAClD;iBAAM;gBACH,MAAM,IAAI,KAAK,CAAC,8CAA8C,IAAI,EAAE,CAAC,CAAC;aACzE;SACJ;QAED,OAAO,cAAc,CAAC;IAC1B,CAAC;IAEO,aAAa,CAAC,KAAa;QAC/B,OAAO,iBAAiB,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;IAEO,qBAAqB,CAAC,KAAa;QACvC,OAAO,KAAK,KAAK,iBAAiB,CAAC,mBAAmB,CAAC;IAC3D,CAAC;IAEO,2BAA2B,CAAC,KAAa;QAC7C,OAAO,KAAK,KAAK,iBAAiB,CAAC,qBAAqB,CAAC;IAC7D,CAAC;;AAjIL,8CAkIC;AAjIU,uCAAqB,GAAG,GAAG,CAAC;AAC5B,qCAAmB,GAAG,GAAG,CAAC;AAC1B,uBAAK,GAAG,GAAG,CAAC;AACZ,6BAAW,GAAG;IACjB,iBAAiB,CAAC,KAAK;IACvB,iBAAiB,CAAC,qBAAqB;IACvC,iBAAiB,CAAC,mBAAmB;CACxC,CAAC"}

package/out/abi/typesystem/abi.d.ts

@@ -0,0 +1,64 @@
+import { EndpointDefinition } from "./endpoint";
+import { EnumType } from "./enum";
+import { EventDefinition } from "./event";
+import { ExplicitEnumType } from "./explicit-enum";
+import { StructType } from "./struct";
+import { CustomType } from "./types";
+export declare class AbiRegistry {
+    readonly name: string;
+    readonly constructorDefinition: EndpointDefinition;
+    readonly upgradeConstructorDefinition?: EndpointDefinition;
+    readonly endpoints: EndpointDefinition[];
+    readonly customTypes: CustomType[];
+    readonly events: EventDefinition[];
+    protected constructor(options: {
+        name: string;
+        constructorDefinition: EndpointDefinition;
+        upgradeConstructorDefinition?: EndpointDefinition;
+        endpoints: EndpointDefinition[];
+        customTypes: CustomType[];
+        events?: EventDefinition[];
+    });
+    static create(options: {
+        name?: string;
+        constructor?: any;
+        upgradeConstructor?: any;
+        endpoints?: any[];
+        types?: Record<string, any>;
+        events?: any[];
+    }): AbiRegistry;
+    getCustomType(name: string): CustomType;
+    getStruct(name: string): StructType;
+    getStructs(names: string[]): StructType[];
+    getEnum(name: string): EnumType;
+    getExplicitEnum(name: string): ExplicitEnumType;
+    getEnums(names: string[]): EnumType[];
+    getEndpoints(): EndpointDefinition[];
+    getEndpoint(name: string): EndpointDefinition;
+    getEvent(name: string): EventDefinition;
+    /**
+     * Right after loading ABI definitions into a registry, the endpoints and the custom types (structs, enums)
+     * use raw types for their I/O parameters (in the case of endpoints), or for their fields (in the case of structs).
+     *
+     * A raw type is merely an instance of {@link Type}, with a given name and type parameters (if it's a generic type).
+     *
+     * Though, for most (development) purposes, we'd like to operate using known, specific types (e.g. {@link List}, {@link U8Type} etc.).
+     * This function increases the specificity of the types used by parameter / field definitions within a registry (on best-efforts basis).
+     * The result is an equivalent, more explicit ABI registry.
+     */
+    remapToKnownTypes(): AbiRegistry;
+    private mapCustomTypeDepthFirst;
+}
+export declare class Abi extends AbiRegistry {
+    /**
+     *
+     */
+    constructor(options: {
+        name: string;
+        constructorDefinition: EndpointDefinition;
+        upgradeConstructorDefinition?: EndpointDefinition;
+        endpoints: EndpointDefinition[];
+        customTypes: CustomType[];
+        events?: EventDefinition[];
+    });
+}