koilib 2.4.1 → 2.6.1

package/lib/browser/Contract.d.ts

@@ -0,0 +1,202 @@
+import { Signer, SignerInterface } from "./Signer";
+import { Provider } from "./Provider";
+import { Serializer } from "./Serializer";
+import { CallContractOperationNested, UploadContractOperationNested, TransactionJson, Abi, TransactionOptions, DecodedOperationJson, SendTransactionResponse } from "./interface";
+/**
+ * The contract class contains the contract ID and contract entries
+ * definition needed to encode/decode operations during the
+ * interaction with the user and the communication with the RPC node.
+ *
+ * @example
+ *
+ * ```ts
+ * const { Contract, Provider, Signer, utils } = require("koilib");
+ * const rpcNodes = ["http://api.koinos.io:8080"];
+ * const privateKey = "f186a5de49797bfd52dc42505c33d75a46822ed5b60046e09d7c336242e20200";
+ * const provider = new Provider(rpcNodes);
+ * const signer = new Signer({ privateKey, provider });
+ * const koinContract = new Contract({
+ *   id: "19JntSm8pSNETT9aHTwAUHC5RMoaSmgZPJ",
+ *   abi: utils.Krc20Abi,
+ *   provider,
+ *   signer,
+ * });
+ * const koin = koinContract.functions;
+ *
+ * // optional: preformat input/output
+ * koinContract.abi.methods.balanceOf.preformatInput = (owner) =>
+ *   ({ owner });
+ * koinContract.abi.methods.balanceOf.preformatOutput = (res) =>
+ *   utils.formatUnits(res.value, 8);
+ * koinContract.abi.methods.transfer.preformatInput = (input) => ({
+ *   from: signer.getAddress(),
+ *   to: input.to,
+ *   value: utils.parseUnits(input.value, 8),
+ * });
+ *
+ * async funtion main() {
+ *   // Get balance
+ *   const { result } = await koin.balanceOf("12fN2CQnuJM8cMnWZ1hPtM4knjLME8E4PD");
+ *   console.log(result)
+ *
+ *   // Transfer
+ *   const { transaction, transactionResponse } = await koin.transfer({
+ *     to: "172AB1FgCsYrRAW5cwQ8KjadgxofvgPFd6",
+ *     value: "10.0001",
+ *   });
+ *   console.log(`Transaction id ${transaction.id} submitted`);
+ *
+ *   // wait to be mined
+ *   const blockId = await transactionResponse.wait();
+ *   console.log(`Transaction mined. Block id: ${blockId}`);
+ * }
+ *
+ * main();
+ * ```
+ */
+export declare class Contract {
+    /**
+     * Contract ID
+     */
+    id?: Uint8Array;
+    /**
+     * Set of functions to interact with the smart
+     * contract. These functions are automatically generated
+     * in the constructor of the class
+     *
+     * @example
+     * ```ts
+     * const owner = "1Gvqdo9if6v6tFomEuTuMWP1D7H7U9yksb";
+     * await koinContract.functions.balanceOf({ owner });
+     * ```
+     */
+    functions: {
+        [x: string]: <T = Record<string, unknown>>(args?: unknown, opts?: TransactionOptions) => Promise<{
+            operation: CallContractOperationNested;
+            transaction?: TransactionJson;
+            transactionResponse?: SendTransactionResponse;
+            result?: T;
+        }>;
+    };
+    /**
+     * Application Binary Interface
+     */
+    abi?: Abi;
+    /**
+     * Signer interacting with the smart contract
+     */
+    signer?: SignerInterface;
+    /**
+     * Provider to connect with the blockchain
+     */
+    provider?: Provider;
+    /**
+     * Serializer to serialize/deserialize data types
+     */
+    serializer?: Serializer;
+    /**
+     * Bytecode. Needed to deploy the smart contract.
+     */
+    bytecode?: Uint8Array;
+    /**
+     * Options to apply when creating transactions.
+     * By default it set rc_limit to 1e8, sendTransaction true,
+     * sendAbis true, and nonce undefined (to get it from the blockchain)
+     */
+    options: TransactionOptions;
+    constructor(c: {
+        id?: string;
+        abi?: Abi;
+        bytecode?: Uint8Array;
+        options?: TransactionOptions;
+        signer?: Signer;
+        provider?: Provider;
+        /**
+         * Set this option if you can not use _eval_ functions
+         * in the current environment. In such cases, the
+         * serializer must come from an environment where it
+         * is able to use those functions.
+         */
+        serializer?: Serializer;
+    });
+    /**
+     * Compute contract Id
+     */
+    static computeContractId(address: string): Uint8Array;
+    /**
+     * Get contract Id
+     */
+    getId(): string;
+    /**
+     * Function to deploy a new smart contract.
+     * The Bytecode must be defined in the constructor of the class
+     * @example
+     * ```ts
+     * const privateKey = "f186a5de49797bfd52dc42505c33d75a46822ed5b60046e09d7c336242e20200";
+     * const provider = new Provider(["http://api.koinos.io:8080"]);
+     * const signer = new Signer({ privateKey, provider });
+     * const bytecode = new Uint8Array([1, 2, 3, 4]);
+     * const contract = new Contract({ signer, provider, bytecode });
+     * const { transactionResponse } = await contract.deploy();
+     * // wait to be mined
+     * const blockId = await transactionResponse.wait();
+     * console.log(`Contract uploaded in block id ${blockId}`);
+     * ```
+     */
+    deploy(options?: TransactionOptions): Promise<{
+        operation: UploadContractOperationNested;
+        transaction?: TransactionJson;
+        transactionResponse?: SendTransactionResponse;
+    }>;
+    /**
+     * Encondes a contract operation using Koinos serialization
+     * and taking the contract entries as reference to build it
+     * @param op - Operation to encode
+     * @returns Operation encoded
+     * @example
+     * ```ts
+     * const opEncoded = contract.encodeOperation({
+     *   name: "transfer",
+     *   args: {
+     *     from: "12fN2CQnuJM8cMnWZ1hPtM4knjLME8E4PD",
+     *     to: "172AB1FgCsYrRAW5cwQ8KjadgxofvgPFd6",
+     *     value: "1000",
+     *   }
+     * });
+     *
+     * console.log(opEncoded);
+     * // {
+     * //   call_contract: {
+     * //     contract_id: "19JntSm8pSNETT9aHTwAUHC5RMoaSmgZPJ",
+     * //     entry_point: 0x62efa292,
+     * //     args: "MBWFsaWNlA2JvYgAAAAAAAAPo",
+     * //   }
+     * // }
+     * ```
+     */
+    encodeOperation(op: DecodedOperationJson): Promise<CallContractOperationNested>;
+    /**
+     * Decodes a contract operation to be human readable
+     * @example
+     * ```ts
+     * const opDecoded = contract.decodeOperation({
+     *   call_contract: {
+     *     contract_id: "19JntSm8pSNETT9aHTwAUHC5RMoaSmgZPJ",
+     *     entry_point: 0x62efa292,
+     *     args: "MBWFsaWNlA2JvYgAAAAAAAAPo",
+     *   }
+     * });
+     * console.log(opDecoded);
+     * // {
+     * //   name: "transfer",
+     * //   args: {
+     * //     from: "12fN2CQnuJM8cMnWZ1hPtM4knjLME8E4PD",
+     * //     to: "172AB1FgCsYrRAW5cwQ8KjadgxofvgPFd6",
+     * //     value: "1000",
+     * //   },
+     * // }
+     * ```
+     */
+    decodeOperation(op: CallContractOperationNested): Promise<DecodedOperationJson>;
+}
+export default Contract;

package/lib/browser/Contract.js

@@ -0,0 +1,298 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Contract = void 0;
+const Serializer_1 = require("./Serializer");
+const utils_1 = require("./utils");
+/**
+ * The contract class contains the contract ID and contract entries
+ * definition needed to encode/decode operations during the
+ * interaction with the user and the communication with the RPC node.
+ *
+ * @example
+ *
+ * ```ts
+ * const { Contract, Provider, Signer, utils } = require("koilib");
+ * const rpcNodes = ["http://api.koinos.io:8080"];
+ * const privateKey = "f186a5de49797bfd52dc42505c33d75a46822ed5b60046e09d7c336242e20200";
+ * const provider = new Provider(rpcNodes);
+ * const signer = new Signer({ privateKey, provider });
+ * const koinContract = new Contract({
+ *   id: "19JntSm8pSNETT9aHTwAUHC5RMoaSmgZPJ",
+ *   abi: utils.Krc20Abi,
+ *   provider,
+ *   signer,
+ * });
+ * const koin = koinContract.functions;
+ *
+ * // optional: preformat input/output
+ * koinContract.abi.methods.balanceOf.preformatInput = (owner) =>
+ *   ({ owner });
+ * koinContract.abi.methods.balanceOf.preformatOutput = (res) =>
+ *   utils.formatUnits(res.value, 8);
+ * koinContract.abi.methods.transfer.preformatInput = (input) => ({
+ *   from: signer.getAddress(),
+ *   to: input.to,
+ *   value: utils.parseUnits(input.value, 8),
+ * });
+ *
+ * async funtion main() {
+ *   // Get balance
+ *   const { result } = await koin.balanceOf("12fN2CQnuJM8cMnWZ1hPtM4knjLME8E4PD");
+ *   console.log(result)
+ *
+ *   // Transfer
+ *   const { transaction, transactionResponse } = await koin.transfer({
+ *     to: "172AB1FgCsYrRAW5cwQ8KjadgxofvgPFd6",
+ *     value: "10.0001",
+ *   });
+ *   console.log(`Transaction id ${transaction.id} submitted`);
+ *
+ *   // wait to be mined
+ *   const blockId = await transactionResponse.wait();
+ *   console.log(`Transaction mined. Block id: ${blockId}`);
+ * }
+ *
+ * main();
+ * ```
+ */
+class Contract {
+    constructor(c) {
+        var _a;
+        if (c.id)
+            this.id = (0, utils_1.decodeBase58)(c.id);
+        this.signer = c.signer;
+        this.provider = c.provider || ((_a = c.signer) === null || _a === void 0 ? void 0 : _a.provider);
+        this.abi = c.abi;
+        this.bytecode = c.bytecode;
+        if (c.serializer) {
+            this.serializer = c.serializer;
+        }
+        else if (c.abi && c.abi.types) {
+            this.serializer = new Serializer_1.Serializer(c.abi.types);
+        }
+        this.options = {
+            rc_limit: 1e8,
+            sendTransaction: true,
+            sendAbis: true,
+            ...c.options,
+        };
+        this.functions = {};
+        if (this.signer &&
+            this.provider &&
+            this.abi &&
+            this.abi.methods &&
+            this.serializer) {
+            Object.keys(this.abi.methods).forEach((name) => {
+                this.functions[name] = async (argu = {}, options) => {
+                    if (!this.provider)
+                        throw new Error("provider not found");
+                    if (!this.abi || !this.abi.methods)
+                        throw new Error("Methods are not defined");
+                    if (!this.abi.methods[name])
+                        throw new Error(`Method ${name} not defined in the ABI`);
+                    const opts = {
+                        ...this.options,
+                        ...options,
+                    };
+                    const { readOnly, output, defaultOutput, preformatInput, preformatOutput, } = this.abi.methods[name];
+                    let args;
+                    if (typeof preformatInput === "function") {
+                        args = preformatInput(argu);
+                    }
+                    else {
+                        args = argu;
+                    }
+                    const operation = await this.encodeOperation({ name, args });
+                    if (readOnly) {
+                        if (!output)
+                            throw new Error(`No output defined for ${name}`);
+                        // read contract
+                        const { result: resultEncoded } = await this.provider.readContract({
+                            contract_id: (0, utils_1.encodeBase58)(operation.call_contract.contract_id),
+                            entry_point: operation.call_contract.entry_point,
+                            args: (0, utils_1.encodeBase64)(operation.call_contract.args),
+                        });
+                        let result = defaultOutput;
+                        if (resultEncoded) {
+                            result = await this.serializer.deserialize(resultEncoded, output);
+                        }
+                        if (typeof preformatOutput === "function") {
+                            result = preformatOutput(result);
+                        }
+                        return { operation, result };
+                    }
+                    // return operation if send is false
+                    if (!(opts === null || opts === void 0 ? void 0 : opts.sendTransaction))
+                        return { operation };
+                    // write contract (sign and send)
+                    if (!this.signer)
+                        throw new Error("signer not found");
+                    const transaction = await this.signer.encodeTransaction({
+                        ...opts,
+                        operations: [operation],
+                    });
+                    const abis = {};
+                    if (opts === null || opts === void 0 ? void 0 : opts.sendAbis) {
+                        const contractId = (0, utils_1.encodeBase58)(this.id);
+                        abis[contractId] = this.abi;
+                    }
+                    const transactionResponse = await this.signer.sendTransaction(transaction, abis);
+                    return { operation, transaction, transactionResponse };
+                };
+            });
+        }
+    }
+    /**
+     * Compute contract Id
+     */
+    static computeContractId(address) {
+        return (0, utils_1.decodeBase58)(address);
+    }
+    /**
+     * Get contract Id
+     */
+    getId() {
+        if (!this.id)
+            throw new Error("id is not defined");
+        return (0, utils_1.encodeBase58)(this.id);
+    }
+    /**
+     * Function to deploy a new smart contract.
+     * The Bytecode must be defined in the constructor of the class
+     * @example
+     * ```ts
+     * const privateKey = "f186a5de49797bfd52dc42505c33d75a46822ed5b60046e09d7c336242e20200";
+     * const provider = new Provider(["http://api.koinos.io:8080"]);
+     * const signer = new Signer({ privateKey, provider });
+     * const bytecode = new Uint8Array([1, 2, 3, 4]);
+     * const contract = new Contract({ signer, provider, bytecode });
+     * const { transactionResponse } = await contract.deploy();
+     * // wait to be mined
+     * const blockId = await transactionResponse.wait();
+     * console.log(`Contract uploaded in block id ${blockId}`);
+     * ```
+     */
+    async deploy(options) {
+        if (!this.signer)
+            throw new Error("signer not found");
+        if (!this.bytecode)
+            throw new Error("bytecode not found");
+        const opts = {
+            ...this.options,
+            ...options,
+        };
+        const operation = {
+            upload_contract: {
+                contract_id: Contract.computeContractId(this.signer.getAddress()),
+                bytecode: this.bytecode,
+            },
+        };
+        // return operation if send is false
+        if (!(opts === null || opts === void 0 ? void 0 : opts.sendTransaction))
+            return { operation };
+        const transaction = await this.signer.encodeTransaction({
+            ...opts,
+            operations: [operation],
+        });
+        const transactionResponse = await this.signer.sendTransaction(transaction);
+        return { operation, transaction, transactionResponse };
+    }
+    /**
+     * Encondes a contract operation using Koinos serialization
+     * and taking the contract entries as reference to build it
+     * @param op - Operation to encode
+     * @returns Operation encoded
+     * @example
+     * ```ts
+     * const opEncoded = contract.encodeOperation({
+     *   name: "transfer",
+     *   args: {
+     *     from: "12fN2CQnuJM8cMnWZ1hPtM4knjLME8E4PD",
+     *     to: "172AB1FgCsYrRAW5cwQ8KjadgxofvgPFd6",
+     *     value: "1000",
+     *   }
+     * });
+     *
+     * console.log(opEncoded);
+     * // {
+     * //   call_contract: {
+     * //     contract_id: "19JntSm8pSNETT9aHTwAUHC5RMoaSmgZPJ",
+     * //     entry_point: 0x62efa292,
+     * //     args: "MBWFsaWNlA2JvYgAAAAAAAAPo",
+     * //   }
+     * // }
+     * ```
+     */
+    async encodeOperation(op) {
+        if (!this.abi || !this.abi.methods || !this.abi.methods[op.name])
+            throw new Error(`Operation ${op.name} unknown`);
+        if (!this.serializer)
+            throw new Error("Serializer is not defined");
+        if (!this.id)
+            throw new Error("Contract id is not defined");
+        const method = this.abi.methods[op.name];
+        let bufferInputs = new Uint8Array(0);
+        if (method.input) {
+            if (!op.args)
+                throw new Error(`No arguments defined for type '${method.input}'`);
+            bufferInputs = await this.serializer.serialize(op.args, method.input);
+        }
+        return {
+            call_contract: {
+                contract_id: this.id,
+                entry_point: method.entryPoint,
+                args: bufferInputs,
+            },
+        };
+    }
+    /**
+     * Decodes a contract operation to be human readable
+     * @example
+     * ```ts
+     * const opDecoded = contract.decodeOperation({
+     *   call_contract: {
+     *     contract_id: "19JntSm8pSNETT9aHTwAUHC5RMoaSmgZPJ",
+     *     entry_point: 0x62efa292,
+     *     args: "MBWFsaWNlA2JvYgAAAAAAAAPo",
+     *   }
+     * });
+     * console.log(opDecoded);
+     * // {
+     * //   name: "transfer",
+     * //   args: {
+     * //     from: "12fN2CQnuJM8cMnWZ1hPtM4knjLME8E4PD",
+     * //     to: "172AB1FgCsYrRAW5cwQ8KjadgxofvgPFd6",
+     * //     value: "1000",
+     * //   },
+     * // }
+     * ```
+     */
+    async decodeOperation(op) {
+        if (!this.id)
+            throw new Error("Contract id is not defined");
+        if (!this.abi || !this.abi.methods)
+            throw new Error("Methods are not defined");
+        if (!this.serializer)
+            throw new Error("Serializer is not defined");
+        if (!op.call_contract)
+            throw new Error("Operation is not CallContractOperation");
+        if ((0, utils_1.encodeBase58)(op.call_contract.contract_id) !== (0, utils_1.encodeBase58)(this.id))
+            throw new Error(`Invalid contract id. Expected: ${(0, utils_1.encodeBase58)(this.id)}. Received: ${(0, utils_1.encodeBase58)(op.call_contract.contract_id)}`);
+        for (let i = 0; i < Object.keys(this.abi.methods).length; i += 1) {
+            const opName = Object.keys(this.abi.methods)[i];
+            const method = this.abi.methods[opName];
+            if (op.call_contract.entry_point === method.entryPoint) {
+                if (!method.input)
+                    return { name: opName };
+                return {
+                    name: opName,
+                    args: await this.serializer.deserialize(op.call_contract.args, method.input),
+                };
+            }
+        }
+        throw new Error(`Unknown method id ${op.call_contract.entry_point}`);
+    }
+}
+exports.Contract = Contract;
+exports.default = Contract;
+//# sourceMappingURL=Contract.js.map

package/lib/browser/Contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Contract.js","sourceRoot":"","sources":["../../src/Contract.ts"],"names":[],"mappings":";;;AAGA,6CAA0C;AAU1C,mCAAmE;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAa,QAAQ;IA6DnB,YAAY,CAcX;;QACC,IAAI,CAAC,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,GAAG,IAAA,oBAAY,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,KAAI,MAAA,CAAC,CAAC,MAAM,0CAAE,QAAQ,CAAA,CAAC;QACjD,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;QAC3B,IAAI,CAAC,CAAC,UAAU,EAAE;YAChB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;SAChC;aAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE;YAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;SAC/C;QACD,IAAI,CAAC,OAAO,GAAG;YACb,QAAQ,EAAE,GAAG;YACb,eAAe,EAAE,IAAI;YACrB,QAAQ,EAAE,IAAI;YACd,GAAG,CAAC,CAAC,OAAO;SACb,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IACE,IAAI,CAAC,MAAM;YACX,IAAI,CAAC,QAAQ;YACb,IAAI,CAAC,GAAG;YACR,IAAI,CAAC,GAAG,CAAC,OAAO;YAChB,IAAI,CAAC,UAAU,EACf;YACA,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC7C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,KAAK,EAC1B,OAAgB,EAAE,EAClB,OAA4B,EAM3B,EAAE;oBACH,IAAI,CAAC,IAAI,CAAC,QAAQ;wBAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;oBAC1D,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO;wBAChC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;oBAC7C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;wBACzB,MAAM,IAAI,KAAK,CAAC,UAAU,IAAI,yBAAyB,CAAC,CAAC;oBAC3D,MAAM,IAAI,GAAG;wBACX,GAAG,IAAI,CAAC,OAAO;wBACf,GAAG,OAAO;qBACX,CAAC;oBAEF,MAAM,EACJ,QAAQ,EACR,MAAM,EACN,aAAa,EACb,cAAc,EACd,eAAe,GAChB,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBAC3B,IAAI,IAA6B,CAAC;oBAClC,IAAI,OAAO,cAAc,KAAK,UAAU,EAAE;wBACxC,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;qBAC7B;yBAAM;wBACL,IAAI,GAAG,IAA+B,CAAC;qBACxC;oBAED,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;oBAE7D,IAAI,QAAQ,EAAE;wBACZ,IAAI,CAAC,MAAM;4BAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,EAAE,CAAC,CAAC;wBAC9D,gBAAgB;wBAChB,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;4BACjE,WAAW,EAAE,IAAA,oBAAY,EAAC,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC;4BAC9D,WAAW,EAAE,SAAS,CAAC,aAAa,CAAC,WAAW;4BAChD,IAAI,EAAE,IAAA,oBAAY,EAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC;yBACjD,CAAC,CAAC;wBACH,IAAI,MAAM,GAAG,aAAkB,CAAC;wBAChC,IAAI,aAAa,EAAE;4BACjB,MAAM,GAAG,MAAM,IAAI,CAAC,UAAW,CAAC,WAAW,CACzC,aAAa,EACb,MAAM,CACP,CAAC;yBACH;wBACD,IAAI,OAAO,eAAe,KAAK,UAAU,EAAE;4BACzC,MAAM,GAAG,eAAe,CAAC,MAAiC,CAAM,CAAC;yBAClE;wBACD,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;qBAC9B;oBAED,oCAAoC;oBACpC,IAAI,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,eAAe,CAAA;wBAAE,OAAO,EAAE,SAAS,EAAE,CAAC;oBAEjD,iCAAiC;oBACjC,IAAI,CAAC,IAAI,CAAC,MAAM;wBAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;oBACtD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;wBACtD,GAAG,IAAI;wBACP,UAAU,EAAE,CAAC,SAAS,CAAC;qBACxB,CAAC,CAAC;oBAEH,MAAM,IAAI,GAAwB,EAAE,CAAC;oBACrC,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE;wBAClB,MAAM,UAAU,GAAG,IAAA,oBAAY,EAAC,IAAI,CAAC,EAAgB,CAAC,CAAC;wBACvD,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;qBAC7B;oBACD,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAC3D,WAAW,EACX,IAAI,CACL,CAAC;oBACF,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC;gBACzD,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,iBAAiB,CAAC,OAAe;QACtC,OAAO,IAAA,oBAAY,EAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACnD,OAAO,IAAA,oBAAY,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,MAAM,CAAC,OAA4B;QAKvC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAG;YACX,GAAG,IAAI,CAAC,OAAO;YACf,GAAG,OAAO;SACX,CAAC;QACF,MAAM,SAAS,GAAkC;YAC/C,eAAe,EAAE;gBACf,WAAW,EAAE,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;gBACjE,QAAQ,EAAE,IAAI,CAAC,QAAQ;aACxB;SACF,CAAC;QAEF,oCAAoC;QACpC,IAAI,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,eAAe,CAAA;YAAE,OAAO,EAAE,SAAS,EAAE,CAAC;QAEjD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;YACtD,GAAG,IAAI;YACP,UAAU,EAAE,CAAC,SAAS,CAAC;SACxB,CAAC,CAAC;QACH,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC3E,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,eAAe,CACnB,EAAwB;QAExB,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC;YAC9D,MAAM,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC,IAAI,UAAU,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACnE,IAAI,CAAC,IAAI,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAEzC,IAAI,YAAY,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;QACrC,IAAI,MAAM,CAAC,KAAK,EAAE;YAChB,IAAI,CAAC,EAAE,CAAC,IAAI;gBACV,MAAM,IAAI,KAAK,CAAC,kCAAkC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC;YACrE,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;SACvE;QAED,OAAO;YACL,aAAa,EAAE;gBACb,WAAW,EAAE,IAAI,CAAC,EAAE;gBACpB,WAAW,EAAE,MAAM,CAAC,UAAU;gBAC9B,IAAI,EAAE,YAAY;aACnB;SACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,eAAe,CACnB,EAA+B;QAE/B,IAAI,CAAC,IAAI,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAC5D,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO;YAChC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACnE,IAAI,CAAC,EAAE,CAAC,aAAa;YACnB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,IAAI,IAAA,oBAAY,EAAC,EAAE,CAAC,aAAa,CAAC,WAAW,CAAC,KAAK,IAAA,oBAAY,EAAC,IAAI,CAAC,EAAE,CAAC;YACtE,MAAM,IAAI,KAAK,CACb,kCAAkC,IAAA,oBAAY,EAC5C,IAAI,CAAC,EAAE,CACR,eAAe,IAAA,oBAAY,EAAC,EAAE,CAAC,aAAa,CAAC,WAAW,CAAC,EAAE,CAC7D,CAAC;QACJ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;YAChE,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACxC,IAAI,EAAE,CAAC,aAAa,CAAC,WAAW,KAAK,MAAM,CAAC,UAAU,EAAE;gBACtD,IAAI,CAAC,MAAM,CAAC,KAAK;oBAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;gBAC3C,OAAO;oBACL,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CACrC,EAAE,CAAC,aAAa,CAAC,IAAI,EACrB,MAAM,CAAC,KAAK,CACb;iBACF,CAAC;aACH;SACF;QACD,MAAM,IAAI,KAAK,CAAC,qBAAqB,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AA3VD,4BA2VC;AAED,kBAAe,QAAQ,CAAC"}

package/lib/browser/Provider.d.ts

@@ -0,0 +1,153 @@
+import { BlockJson, TransactionJson, CallContractOperationJson, SendTransactionResponse } from "./interface";
+/**
+ * Class to connect with the RPC node
+ */
+export declare class Provider {
+    /**
+     * Array of URLs of RPC nodes
+     */
+    rpcNodes: string[];
+    /**
+     * Function triggered when a node is down. Returns a
+     * boolean determining if the call should be aborted.
+     *
+     * @example
+     * ```ts
+     * const provider = new Provider([
+     *   "http://45.56.104.152:8080",
+     *   "http://159.203.119.0:8080"
+     * ]);
+     *
+     * provider.onError = (error, node, newNode) => {
+     *   console.log(`Error from node ${node}: ${error.message}`);
+     *   console.log(`changing node to ${newNode}`);
+     *   const abort = false;
+     *   return abort;
+     * }
+     * ```
+     */
+    onError: (error: Error, 
+    /** node that threw the error */
+    currentNode: string, 
+    /** node used for the next iteration */
+    newNode: string) => boolean;
+    /**
+     * Index of current node in rpcNodes
+     */
+    currentNodeId: number;
+    /**
+     *
+     * @param rpcNodes - URL of the rpc node, or array of urls
+     * to switch between them when someone is down
+     * @example
+     * ```ts
+     * const provider = new Provider([
+     *   "http://45.56.104.152:8080",
+     *   "http://159.203.119.0:8080"
+     * ]);
+     * ```
+     */
+    constructor(rpcNodes: string | string[]);
+    /**
+     * Function to make jsonrpc requests to the RPC node
+     * @param method - jsonrpc method
+     * @param params - jsonrpc params
+     * @returns Result of jsonrpc response
+     */
+    call<T = unknown>(method: string, params: unknown): Promise<T>;
+    /**
+     * Function to call "chain.get_account_nonce" to return the number of
+     * transactions for a particular account. This call is used
+     * when creating new transactions.
+     * @param account - account address
+     * @returns Nonce
+     */
+    getNonce(account: string): Promise<number>;
+    getAccountRc(account: string): Promise<string>;
+    /**
+     * Get transactions by id and their corresponding block ids
+     */
+    getTransactionsById(transactionIds: string[]): Promise<{
+        transactions: {
+            transaction: TransactionJson[];
+            containing_blocks: string[];
+        }[];
+    }>;
+    getBlocksById(blockIds: string[]): Promise<{
+        block_items: {
+            block_id: string;
+            block_height: string;
+            block: BlockJson;
+        }[];
+    }>;
+    /**
+     * Function to get info from the head block in the blockchain
+     */
+    getHeadInfo(): Promise<{
+        head_topology: {
+            id: string;
+            height: string;
+            previous: string;
+        };
+        last_irreversible_block: string;
+    }>;
+    /**
+     * Function to get consecutive blocks in descending order
+     * @param height - Starting block height
+     * @param numBlocks - Number of blocks to fetch
+     * @param idRef - Block ID reference to speed up searching blocks.
+     * This ID must be from a greater block height. By default it
+     * gets the ID from the block head.
+     */
+    getBlocks(height: number, numBlocks?: number, idRef?: string): Promise<{
+        block_id: string;
+        block_height: string;
+        block: BlockJson;
+        block_receipt: {
+            [x: string]: unknown;
+        };
+    }[]>;
+    /**
+     * Function to get a block by its height
+     */
+    getBlock(height: number): Promise<{
+        block_id: string;
+        block_height: string;
+        block: BlockJson;
+        block_receipt: {
+            [x: string]: unknown;
+        };
+    }>;
+    /**
+     * Function to call "chain.submit_transaction" to send a signed
+     * transaction to the blockchain. It returns an object with the async
+     * function "wait", which can be called to wait for the
+     * transaction to be mined (see [[SendTransactionResponse]]).
+     * @param transaction - Signed transaction
+     * @example
+     * ```ts
+     * const { transactionResponse } = await provider.sendTransaction({
+     *   id: "1220...",
+     *   active: "...",
+     *   signatureData: "...",
+     * });
+     * console.log("Transaction submitted to the mempool");
+     * // wait to be mined
+     * const blockNumber = await transactionResponse.wait();
+     * // const blockNumber = await transactionResponse.wait("byBlock", 30000);
+     * // const blockId = await transactionResponse.wait("byTransactionId", 30000);
+     * console.log("Transaction mined")
+     * ```
+     */
+    sendTransaction(transaction: TransactionJson): Promise<SendTransactionResponse>;
+    /**
+     * Function to call "chain.read_contract" to read a contract.
+     * This function is used by [[Contract]] class when read methods
+     * are invoked.
+     */
+    readContract(operation: CallContractOperationJson): Promise<{
+        result: string;
+        logs: string;
+    }>;
+}
+export default Provider;