koilib 2.6.0 → 2.6.1

package/lib/browser/Provider.js

@@ -0,0 +1,244 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Provider = void 0;
+async function sleep(ms) {
+    return new Promise((r) => setTimeout(r, ms));
+}
+/**
+ * Class to connect with the RPC node
+ */
+class Provider {
+    /**
+     *
+     * @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) {
+        if (Array.isArray(rpcNodes))
+            this.rpcNodes = rpcNodes;
+        else
+            this.rpcNodes = [rpcNodes];
+        this.currentNodeId = 0;
+        this.onError = () => false;
+    }
+    /**
+     * Function to make jsonrpc requests to the RPC node
+     * @param method - jsonrpc method
+     * @param params - jsonrpc params
+     * @returns Result of jsonrpc response
+     */
+    async call(method, params) {
+        /* eslint-disable no-await-in-loop */
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+            try {
+                const data = {
+                    id: Math.round(Math.random() * 1000),
+                    jsonrpc: "2.0",
+                    method,
+                    params,
+                };
+                const url = this.rpcNodes[this.currentNodeId];
+                const response = await fetch(url, {
+                    method: "POST",
+                    body: JSON.stringify(data),
+                });
+                const json = (await response.json());
+                if (json.error && json.error.message) {
+                    const error = new Error(json.error.message);
+                    error.request = {
+                        method,
+                        params,
+                    };
+                    throw error;
+                }
+                return json.result;
+            }
+            catch (e) {
+                const currentNode = this.rpcNodes[this.currentNodeId];
+                this.currentNodeId = (this.currentNodeId + 1) % this.rpcNodes.length;
+                const newNode = this.rpcNodes[this.currentNodeId];
+                const abort = this.onError(e, currentNode, newNode);
+                if (abort)
+                    throw e;
+            }
+        }
+    }
+    /**
+     * 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
+     */
+    async getNonce(account) {
+        const { nonce } = await this.call("chain.get_account_nonce", { account });
+        if (!nonce)
+            return 0;
+        return Number(nonce);
+    }
+    async getAccountRc(account) {
+        const { rc } = await this.call("chain.get_account_rc", {
+            account,
+        });
+        if (!rc)
+            return "0";
+        return rc;
+    }
+    /**
+     * Get transactions by id and their corresponding block ids
+     */
+    async getTransactionsById(transactionIds) {
+        return this.call("transaction_store.get_transactions_by_id", {
+            transaction_ids: transactionIds,
+        });
+    }
+    async getBlocksById(blockIds) {
+        return this.call("block_store.get_blocks_by_id", {
+            block_id: blockIds,
+            return_block: true,
+            return_receipt: false,
+        });
+    }
+    /**
+     * Function to get info from the head block in the blockchain
+     */
+    async getHeadInfo() {
+        return this.call("chain.get_head_info", {});
+    }
+    /**
+     * 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.
+     */
+    async getBlocks(height, numBlocks = 1, idRef) {
+        let blockIdRef = idRef;
+        if (!blockIdRef) {
+            const head = await this.getHeadInfo();
+            blockIdRef = head.head_topology.id;
+        }
+        return (await this.call("block_store.get_blocks_by_height", {
+            head_block_id: blockIdRef,
+            ancestor_start_height: height,
+            num_blocks: numBlocks,
+            return_block: true,
+            return_receipt: false,
+        })).block_items;
+    }
+    /**
+     * Function to get a block by its height
+     */
+    async getBlock(height) {
+        return (await this.getBlocks(height, 1))[0];
+    }
+    /**
+     * 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")
+     * ```
+     */
+    async sendTransaction(transaction) {
+        await this.call("chain.submit_transaction", { transaction });
+        return {
+            wait: async (type = "byBlock", timeout = 30000) => {
+                const iniTime = Date.now();
+                if (type === "byTransactionId") {
+                    while (Date.now() < iniTime + timeout) {
+                        await sleep(1000);
+                        const { transactions } = await this.getTransactionsById([
+                            transaction.id,
+                        ]);
+                        if (transactions &&
+                            transactions[0] &&
+                            transactions[0].containing_blocks)
+                            return transactions[0].containing_blocks[0];
+                    }
+                    throw new Error(`Transaction not mined after ${timeout} ms`);
+                }
+                // byBlock
+                const findTxInBlocks = async (ini, numBlocks, idRef) => {
+                    const blocks = await this.getBlocks(ini, numBlocks, idRef);
+                    let bNum = 0;
+                    blocks.forEach((block) => {
+                        if (!block ||
+                            !block.block ||
+                            !block.block_id ||
+                            !block.block.transactions)
+                            return;
+                        const tx = block.block.transactions.find((t) => t.id === transaction.id);
+                        if (tx)
+                            bNum = Number(block.block_height);
+                    });
+                    const lastId = blocks[blocks.length - 1].block_id;
+                    return [bNum, lastId];
+                };
+                let blockNumber = 0;
+                let iniBlock = 0;
+                let previousId = "";
+                while (Date.now() < iniTime + timeout) {
+                    await sleep(1000);
+                    const { head_topology: headTopology } = await this.getHeadInfo();
+                    if (blockNumber === 0) {
+                        blockNumber = Number(headTopology.height);
+                        iniBlock = blockNumber;
+                    }
+                    if (Number(headTopology.height) === blockNumber - 1 &&
+                        previousId &&
+                        previousId !== headTopology.id) {
+                        const [bNum, lastId] = await findTxInBlocks(iniBlock, Number(headTopology.height) - iniBlock + 1, headTopology.id);
+                        if (bNum)
+                            return bNum;
+                        previousId = lastId;
+                        blockNumber = Number(headTopology.height) + 1;
+                    }
+                    // eslint-disable-next-line no-continue
+                    if (blockNumber > Number(headTopology.height))
+                        continue;
+                    const [bNum, lastId] = await findTxInBlocks(blockNumber, 1, headTopology.id);
+                    if (bNum)
+                        return bNum;
+                    if (!previousId)
+                        previousId = lastId;
+                    blockNumber += 1;
+                }
+                throw new Error(`Transaction not mined after ${timeout} ms. Blocks checked from ${iniBlock} to ${blockNumber}`);
+            },
+        };
+    }
+    /**
+     * Function to call "chain.read_contract" to read a contract.
+     * This function is used by [[Contract]] class when read methods
+     * are invoked.
+     */
+    async readContract(operation) {
+        return this.call("chain.read_contract", operation);
+    }
+}
+exports.Provider = Provider;
+exports.default = Provider;
+//# sourceMappingURL=Provider.js.map

package/lib/browser/Provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Provider.js","sourceRoot":"","sources":["../../src/Provider.ts"],"names":[],"mappings":";;;AAOA,KAAK,UAAU,KAAK,CAAC,EAAU;IAC7B,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED;;GAEG;AACH,MAAa,QAAQ;IAwCnB;;;;;;;;;;;OAWG;IACH,YAAY,QAA2B;QACrC,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;YAAE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;;YACjD,IAAI,CAAC,QAAQ,GAAG,CAAC,QAAQ,CAAC,CAAC;QAChC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAc,MAAc,EAAE,MAAe;QACrD,qCAAqC;QACrC,iDAAiD;QACjD,OAAO,IAAI,EAAE;YACX,IAAI;gBACF,MAAM,IAAI,GAAG;oBACX,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC;oBACpC,OAAO,EAAE,KAAK;oBACd,MAAM;oBACN,MAAM;iBACP,CAAC;gBAEF,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAE9C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;oBAChC,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;iBAC3B,CAAC,CAAC;gBACH,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAKlC,CAAC;gBACF,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;oBACpC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAC3C,KAAyC,CAAC,OAAO,GAAG;wBACnD,MAAM;wBACN,MAAM;qBACP,CAAC;oBACF,MAAM,KAAK,CAAC;iBACb;gBACD,OAAO,IAAI,CAAC,MAAM,CAAC;aACpB;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBACtD,IAAI,CAAC,aAAa,GAAG,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACrE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAClD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;gBAC7D,IAAI,KAAK;oBAAE,MAAM,CAAC,CAAC;aACpB;SACF;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC5B,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAC/B,yBAAyB,EACzB,EAAE,OAAO,EAAE,CACZ,CAAC;QACF,IAAI,CAAC,KAAK;YAAE,OAAO,CAAC,CAAC;QACrB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,OAAe;QAChC,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAiB,sBAAsB,EAAE;YACrE,OAAO;SACR,CAAC,CAAC;QACH,IAAI,CAAC,EAAE;YAAE,OAAO,GAAG,CAAC;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CAAC,cAAwB;QAMhD,OAAO,IAAI,CAAC,IAAI,CAKb,0CAA0C,EAAE;YAC7C,eAAe,EAAE,cAAc;SAChC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,QAAkB;QAOpC,OAAO,IAAI,CAAC,IAAI,CAAC,8BAA8B,EAAE;YAC/C,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,IAAI;YAClB,cAAc,EAAE,KAAK;SACtB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW;QAQf,OAAO,IAAI,CAAC,IAAI,CAOb,qBAAqB,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,CACb,MAAc,EACd,SAAS,GAAG,CAAC,EACb,KAAc;QAWd,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YACtC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;SACpC;QACD,OAAO,CACL,MAAM,IAAI,CAAC,IAAI,CASZ,kCAAkC,EAAE;YACrC,aAAa,EAAE,UAAU;YACzB,qBAAqB,EAAE,MAAM;YAC7B,UAAU,EAAE,SAAS;YACrB,YAAY,EAAE,IAAI;YAClB,cAAc,EAAE,KAAK;SACtB,CAAC,CACH,CAAC,WAAW,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,MAAc;QAQ3B,OAAO,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,eAAe,CACnB,WAA4B;QAE5B,MAAM,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QAC7D,OAAO;YACL,IAAI,EAAE,KAAK,EACT,OAAsC,SAAS,EAC/C,OAAO,GAAG,KAAK,EACf,EAAE;gBACF,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAC3B,IAAI,IAAI,KAAK,iBAAiB,EAAE;oBAC9B,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,GAAG,OAAO,EAAE;wBACrC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;wBAClB,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC;4BACtD,WAAW,CAAC,EAAY;yBACzB,CAAC,CAAC;wBACH,IACE,YAAY;4BACZ,YAAY,CAAC,CAAC,CAAC;4BACf,YAAY,CAAC,CAAC,CAAC,CAAC,iBAAiB;4BAEjC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;qBAC/C;oBACD,MAAM,IAAI,KAAK,CAAC,+BAA+B,OAAO,KAAK,CAAC,CAAC;iBAC9D;gBAED,UAAU;gBACV,MAAM,cAAc,GAAG,KAAK,EAC1B,GAAW,EACX,SAAiB,EACjB,KAAa,EACc,EAAE;oBAC7B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;oBAC3D,IAAI,IAAI,GAAG,CAAC,CAAC;oBACb,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;wBACvB,IACE,CAAC,KAAK;4BACN,CAAC,KAAK,CAAC,KAAK;4BACZ,CAAC,KAAK,CAAC,QAAQ;4BACf,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY;4BAEzB,OAAO;wBACT,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CACtC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,WAAW,CAAC,EAAE,CAC/B,CAAC;wBACF,IAAI,EAAE;4BAAE,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;oBAC5C,CAAC,CAAC,CAAC;oBACH,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC;oBAClD,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBACxB,CAAC,CAAC;gBAEF,IAAI,WAAW,GAAG,CAAC,CAAC;gBACpB,IAAI,QAAQ,GAAG,CAAC,CAAC;gBACjB,IAAI,UAAU,GAAG,EAAE,CAAC;gBAEpB,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,GAAG,OAAO,EAAE;oBACrC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;oBAClB,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjE,IAAI,WAAW,KAAK,CAAC,EAAE;wBACrB,WAAW,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;wBAC1C,QAAQ,GAAG,WAAW,CAAC;qBACxB;oBACD,IACE,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,WAAW,GAAG,CAAC;wBAC/C,UAAU;wBACV,UAAU,KAAK,YAAY,CAAC,EAAE,EAC9B;wBACA,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,MAAM,cAAc,CACzC,QAAQ,EACR,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,QAAQ,GAAG,CAAC,EAC1C,YAAY,CAAC,EAAE,CAChB,CAAC;wBACF,IAAI,IAAI;4BAAE,OAAO,IAAI,CAAC;wBACtB,UAAU,GAAG,MAAM,CAAC;wBACpB,WAAW,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;qBAC/C;oBACD,uCAAuC;oBACvC,IAAI,WAAW,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC;wBAAE,SAAS;oBACxD,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,MAAM,cAAc,CACzC,WAAW,EACX,CAAC,EACD,YAAY,CAAC,EAAE,CAChB,CAAC;oBACF,IAAI,IAAI;wBAAE,OAAO,IAAI,CAAC;oBACtB,IAAI,CAAC,UAAU;wBAAE,UAAU,GAAG,MAAM,CAAC;oBACrC,WAAW,IAAI,CAAC,CAAC;iBAClB;gBACD,MAAM,IAAI,KAAK,CACb,+BAA+B,OAAO,4BAA4B,QAAQ,OAAO,WAAW,EAAE,CAC/F,CAAC;YACJ,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,SAAoC;QAIrD,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAC;IACrD,CAAC;CACF;AArXD,4BAqXC;AAED,kBAAe,QAAQ,CAAC"}

package/lib/browser/Serializer.d.ts

@@ -0,0 +1,81 @@
+import { Root, Type, INamespace } from "protobufjs/light";
+/**
+ * The serializer class serialize and deserialize data using
+ * protocol buffers.
+ *
+ * NOTE: This class uses the [protobufjs/light](https://www.npmjs.com/package/protobufjs)
+ * library internally, which uses reflection (use of _eval_
+ * and _new Function_) for the construction of the types.
+ * This could cause issues in environments where _eval_ is not
+ * allowed, like in browser extensions. In such cases, this class
+ * must be confined in a [sandbox environment](https://developer.chrome.com/docs/apps/app_external/#sandboxing)
+ * where _eval_ is allowed. This is the principal reason of
+ * having the serializer in a separate class.
+ *
+ * @example
+ *
+ * ```ts
+ * const descriptorJson = {
+ *   nested: {
+ *     awesomepackage: {
+ *       nested: {
+ *         AwesomeMessage: {
+ *           fields: {
+ *             awesomeField: {
+ *               type: "string",
+ *               id: 1
+ *             }
+ *           }
+ *         }
+ *       }
+ *     }
+ *   }
+ * }
+ * const serializer = new Serializer(descriptorJson)
+ * ```
+ */
+export declare class Serializer {
+    /**
+     * Protobuffers descriptor in JSON format.
+     * See https://www.npmjs.com/package/protobufjs#using-json-descriptors
+     */
+    types: INamespace;
+    /**
+     * Protobuffer definitions
+     */
+    root: Root;
+    /**
+     * Default type for all serializations
+     */
+    defaultType?: Type;
+    /**
+     * Preformat bytes for base64, base58 or hex string
+     */
+    bytesConversion: boolean;
+    constructor(types: INamespace, opts?: {
+        /**
+         * Default type name. Use this option when you
+         * always want to serialize/deserialize the same type
+         */
+        defaultTypeName?: string;
+        /**
+         * Bytes conversion. Option to preformat bytes
+         * when "(koinos_bytes_type)" is defined in the type
+         * definitions. By default it is true.
+         */
+        bytesConversion?: boolean;
+    });
+    /**
+     * Function to encode a type using the protobuffer definitions
+     * It also prepares the bytes for special cases (base58, hex string)
+     * when bytesConversion param is true.
+     */
+    serialize(valueDecoded: Record<string, unknown>, typeName?: string): Promise<Uint8Array>;
+    /**
+     * Function to decode bytes using the protobuffer definitions
+     * It also encodes the bytes for special cases (base58, hex string)
+     * when bytesConversion param is true.
+     */
+    deserialize<T = Record<string, unknown>>(valueEncoded: string | Uint8Array, typeName?: string): Promise<T>;
+}
+export default Serializer;

package/lib/browser/Serializer.js

@@ -0,0 +1,169 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Serializer = void 0;
+/* eslint-disable @typescript-eslint/require-await */
+const light_1 = require("protobufjs/light");
+const utils_1 = require("./utils");
+const OP_BYTES = "(koinos_bytes_type)";
+/**
+ * Makes a copy of a value. The returned value can be modified
+ * without altering the original one. Although this is not needed
+ * for strings or numbers and only needed for objects and arrays,
+ * all these options are covered in a single function
+ *
+ * It is assumed that the argument is number, string, or contructions
+ * of these types inside objects or arrays.
+ */
+function copyValue(value) {
+    if (typeof value === "string" || typeof value === "number") {
+        return value;
+    }
+    return JSON.parse(JSON.stringify(value));
+}
+/**
+ * The serializer class serialize and deserialize data using
+ * protocol buffers.
+ *
+ * NOTE: This class uses the [protobufjs/light](https://www.npmjs.com/package/protobufjs)
+ * library internally, which uses reflection (use of _eval_
+ * and _new Function_) for the construction of the types.
+ * This could cause issues in environments where _eval_ is not
+ * allowed, like in browser extensions. In such cases, this class
+ * must be confined in a [sandbox environment](https://developer.chrome.com/docs/apps/app_external/#sandboxing)
+ * where _eval_ is allowed. This is the principal reason of
+ * having the serializer in a separate class.
+ *
+ * @example
+ *
+ * ```ts
+ * const descriptorJson = {
+ *   nested: {
+ *     awesomepackage: {
+ *       nested: {
+ *         AwesomeMessage: {
+ *           fields: {
+ *             awesomeField: {
+ *               type: "string",
+ *               id: 1
+ *             }
+ *           }
+ *         }
+ *       }
+ *     }
+ *   }
+ * }
+ * const serializer = new Serializer(descriptorJson)
+ * ```
+ */
+class Serializer {
+    constructor(types, opts) {
+        /**
+         * Preformat bytes for base64, base58 or hex string
+         */
+        this.bytesConversion = true;
+        this.types = types;
+        this.root = light_1.Root.fromJSON(this.types);
+        if (opts === null || opts === void 0 ? void 0 : opts.defaultTypeName)
+            this.defaultType = this.root.lookupType(opts.defaultTypeName);
+        if (opts && typeof opts.bytesConversion !== "undefined")
+            this.bytesConversion = opts.bytesConversion;
+    }
+    /**
+     * Function to encode a type using the protobuffer definitions
+     * It also prepares the bytes for special cases (base58, hex string)
+     * when bytesConversion param is true.
+     */
+    async serialize(valueDecoded, typeName) {
+        const protobufType = this.defaultType || this.root.lookupType(typeName);
+        let object = {};
+        if (this.bytesConversion) {
+            // TODO: format from Buffer to base58/base64 for nested fields
+            Object.keys(protobufType.fields).forEach((fieldName) => {
+                const { options, name, type } = protobufType.fields[fieldName];
+                // No byte conversion
+                if (type !== "bytes") {
+                    object[name] = copyValue(valueDecoded[name]);
+                    return;
+                }
+                // Default byte conversion
+                if (!options || !options[OP_BYTES]) {
+                    object[name] = (0, utils_1.decodeBase64)(valueDecoded[name]);
+                    return;
+                }
+                // Specific byte conversion
+                switch (options[OP_BYTES]) {
+                    case "BASE58":
+                    case "CONTRACT_ID":
+                    case "ADDRESS":
+                        object[name] = (0, utils_1.decodeBase58)(valueDecoded[name]);
+                        break;
+                    case "BASE64":
+                        object[name] = (0, utils_1.decodeBase64)(valueDecoded[name]);
+                        break;
+                    case "HEX":
+                    case "BLOCK_ID":
+                    case "TRANSACTION_ID":
+                        object[name] = (0, utils_1.toUint8Array)(valueDecoded[name].replace("0x", ""));
+                        break;
+                    default:
+                        throw new Error(`unknown koinos_byte_type ${options[OP_BYTES]}`);
+                }
+            });
+        }
+        else {
+            object = valueDecoded;
+        }
+        const message = protobufType.create(object);
+        const buffer = protobufType.encode(message).finish();
+        return buffer;
+    }
+    /**
+     * Function to decode bytes using the protobuffer definitions
+     * It also encodes the bytes for special cases (base58, hex string)
+     * when bytesConversion param is true.
+     */
+    async deserialize(valueEncoded, typeName) {
+        const valueBuffer = typeof valueEncoded === "string"
+            ? (0, utils_1.decodeBase64)(valueEncoded)
+            : valueEncoded;
+        const protobufType = this.defaultType || this.root.lookupType(typeName);
+        const message = protobufType.decode(valueBuffer);
+        const object = protobufType.toObject(message, { longs: String });
+        if (!this.bytesConversion)
+            return object;
+        // TODO: format from Buffer to base58/base64 for nested fields
+        Object.keys(protobufType.fields).forEach((fieldName) => {
+            const { options, name, type } = protobufType.fields[fieldName];
+            // No byte conversion
+            if (type !== "bytes")
+                return;
+            // Default byte conversion
+            if (!options || !options[OP_BYTES]) {
+                object[name] = (0, utils_1.encodeBase64)(object[name]);
+                return;
+            }
+            // Specific byte conversion
+            switch (options[OP_BYTES]) {
+                case "BASE58":
+                case "CONTRACT_ID":
+                case "ADDRESS":
+                    object[name] = (0, utils_1.encodeBase58)(object[name]);
+                    break;
+                case "BASE64":
+                    object[name] = (0, utils_1.encodeBase64)(object[name]);
+                    break;
+                case "HEX":
+                case "BLOCK_ID":
+                case "TRANSACTION_ID":
+                    object[name] = `0x${(0, utils_1.toHexString)(object[name])}`;
+                    break;
+                default:
+                    throw new Error(`unknown koinos_byte_type ${options[OP_BYTES]}`);
+            }
+        });
+        return object;
+    }
+}
+exports.Serializer = Serializer;
+exports.default = Serializer;
+//# sourceMappingURL=Serializer.js.map

package/lib/browser/Serializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Serializer.js","sourceRoot":"","sources":["../../src/Serializer.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4CAA0D;AAC1D,mCAOiB;AAEjB,MAAM,QAAQ,GAAG,qBAAqB,CAAC;AAEvC;;;;;;;;GAQG;AACH,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC1D,OAAO,KAAK,CAAC;KACd;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAY,CAAC;AACtD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAa,UAAU;IAsBrB,YACE,KAAiB,EACjB,IAaC;QApBH;;WAEG;QACH,oBAAe,GAAG,IAAI,CAAC;QAmBrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,YAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,eAAe;YACvB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAChE,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,eAAe,KAAK,WAAW;YACrD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CACb,YAAqC,EACrC,QAAiB;QAEjB,MAAM,YAAY,GAChB,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAkB,CAAC,CAAC;QAC/D,IAAI,MAAM,GAA4B,EAAE,CAAC;QACzC,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,8DAA8D;YAC9D,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBACrD,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAE/D,qBAAqB;gBACrB,IAAI,IAAI,KAAK,OAAO,EAAE;oBACpB,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;oBAC7C,OAAO;iBACR;gBAED,0BAA0B;gBAC1B,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;oBAClC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAA,oBAAY,EAAC,YAAY,CAAC,IAAI,CAAW,CAAC,CAAC;oBAC1D,OAAO;iBACR;gBAED,2BAA2B;gBAC3B,QAAQ,OAAO,CAAC,QAAQ,CAAC,EAAE;oBACzB,KAAK,QAAQ,CAAC;oBACd,KAAK,aAAa,CAAC;oBACnB,KAAK,SAAS;wBACZ,MAAM,CAAC,IAAI,CAAC,GAAG,IAAA,oBAAY,EAAC,YAAY,CAAC,IAAI,CAAW,CAAC,CAAC;wBAC1D,MAAM;oBACR,KAAK,QAAQ;wBACX,MAAM,CAAC,IAAI,CAAC,GAAG,IAAA,oBAAY,EAAC,YAAY,CAAC,IAAI,CAAW,CAAC,CAAC;wBAC1D,MAAM;oBACR,KAAK,KAAK,CAAC;oBACX,KAAK,UAAU,CAAC;oBAChB,KAAK,gBAAgB;wBACnB,MAAM,CAAC,IAAI,CAAC,GAAG,IAAA,oBAAY,EACxB,YAAY,CAAC,IAAI,CAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CACjD,CAAC;wBACF,MAAM;oBACR;wBACE,MAAM,IAAI,KAAK,CACb,4BAA4B,OAAO,CAAC,QAAQ,CAAW,EAAE,CAC1D,CAAC;iBACL;YACH,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,MAAM,GAAG,YAAY,CAAC;SACvB;QACD,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;QACrD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CACf,YAAiC,EACjC,QAAiB;QAEjB,MAAM,WAAW,GACf,OAAO,YAAY,KAAK,QAAQ;YAC9B,CAAC,CAAC,IAAA,oBAAY,EAAC,YAAY,CAAC;YAC5B,CAAC,CAAC,YAAY,CAAC;QACnB,MAAM,YAAY,GAChB,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAkB,CAAC,CAAC;QAC/D,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QACjE,IAAI,CAAC,IAAI,CAAC,eAAe;YAAE,OAAO,MAAW,CAAC;QAE9C,8DAA8D;QAC9D,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YACrD,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAE/D,qBAAqB;YACrB,IAAI,IAAI,KAAK,OAAO;gBAAE,OAAO;YAE7B,0BAA0B;YAC1B,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBAClC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAA,oBAAY,EAAC,MAAM,CAAC,IAAI,CAAe,CAAC,CAAC;gBACxD,OAAO;aACR;YAED,2BAA2B;YAC3B,QAAQ,OAAO,CAAC,QAAQ,CAAC,EAAE;gBACzB,KAAK,QAAQ,CAAC;gBACd,KAAK,aAAa,CAAC;gBACnB,KAAK,SAAS;oBACZ,MAAM,CAAC,IAAI,CAAC,GAAG,IAAA,oBAAY,EAAC,MAAM,CAAC,IAAI,CAAe,CAAC,CAAC;oBACxD,MAAM;gBACR,KAAK,QAAQ;oBACX,MAAM,CAAC,IAAI,CAAC,GAAG,IAAA,oBAAY,EAAC,MAAM,CAAC,IAAI,CAAe,CAAC,CAAC;oBACxD,MAAM;gBACR,KAAK,KAAK,CAAC;gBACX,KAAK,UAAU,CAAC;gBAChB,KAAK,gBAAgB;oBACnB,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,IAAA,mBAAW,EAAC,MAAM,CAAC,IAAI,CAAe,CAAC,EAAE,CAAC;oBAC9D,MAAM;gBACR;oBACE,MAAM,IAAI,KAAK,CACb,4BAA4B,OAAO,CAAC,QAAQ,CAAW,EAAE,CAC1D,CAAC;aACL;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,MAAW,CAAC;IACrB,CAAC;CACF;AAnKD,gCAmKC;AAED,kBAAe,UAAU,CAAC"}