koilib 1.5.0 → 2.3.0

package/lib/Provider.js

@@ -4,8 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Provider = void 0;
-const multibase_1 = __importDefault(require("multibase"));
 const axios_1 = __importDefault(require("axios"));
+async function sleep(ms) {
+    return new Promise((r) => setTimeout(r, ms));
+}
 /**
  * Class to connect with the RPC node
  */
@@ -76,23 +78,44 @@ class Provider {
             }
         }
         if (response.data.error)
-            throw new Error(response.data.error.message);
+            throw new Error(JSON.stringify(response.data.error));
         return response.data.result;
     }
     /**
      * 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 address - account address
+     * @param account - account address
      * @returns Nonce
      */
-    async getNonce(address) {
-        const bufferAddress = new TextEncoder().encode(address);
-        const encBase64 = new TextDecoder().decode(multibase_1.default.encode("M", bufferAddress));
-        const result = await this.call("chain.get_account_nonce", {
-            account: encBase64,
+    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,
         });
-        return Number(result.nonce);
     }
     /**
      * Function to get info from the head block in the blockchain
@@ -130,24 +153,51 @@ class Provider {
     }
     /**
      * Function to call "chain.submit_transaction" to send a signed
-     * transaction to the blockchain
+     * 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.
      * @param transaction - Signed transaction
-     * @returns
+     * @example
+     * ```ts
+     * const { transactionResponse } = await provider.sendTransaction({
+     *   id: "1220...",
+     *   active: "...",
+     *   signatureData: "...",
+     * });
+     * console.log("Transaction submitted to the mempool");
+     * // wait to be mined
+     * const blockId = await transactionResponse.wait();
+     * console.log("Transaction mined")
+     * ```
      */
     async sendTransaction(transaction) {
-        return this.call("chain.submit_transaction", { transaction });
+        await this.call("chain.submit_transaction", { transaction });
+        const startTime = Date.now() + 10000;
+        return {
+            wait: async () => {
+                // sleep some seconds before it gets mined
+                await sleep(startTime - Date.now() - 1000);
+                for (let i = 0; i < 30; i += 1) {
+                    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 40 seconds`);
+            },
+        };
     }
     /**
      * Function to call "chain.read_contract" to read a contract.
-     * The operation must be encoded (see [[EncodedOperation]]).
-     * See also [[Wallet.readContract]] which, apart from the Provider,
-     * uses the contract definition and it is prepared to receive
-     * the operation decoded and return the result decoded as well.
-     * @param operation - Encoded operation
-     * @returns Encoded result
+     * This function is used by [[Contract]] class when read methods
+     * are invoked.
      */
     async readContract(operation) {
-        return this.call("chain.read_contract", operation.value);
+        return this.call("chain.read_contract", operation);
     }
 }
 exports.Provider = Provider;

package/lib/Provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"Provider.js","sourceRoot":"","sources":["../src/Provider.ts"],"names":[],"mappings":";;;;;;AAAA,0DAAkC;AAClC,kDAA6C;AAI7C;;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,IAAI,QAAQ,GAGP;YACH,IAAI,EAAE,EAAE;YACR,MAAM,EAAE,CAAC;YACT,UAAU,EAAE,EAAE;YACd,OAAO,EAAE,EAAE;YACX,MAAM,EAAE,EAAE;SACX,CAAC;QAEF,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,qCAAqC;QACrC,OAAO,CAAC,OAAO,EAAE;YACf,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,uDAAuD;gBACvD;;;;;;sCAMsB;gBAEtB,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAGxB,GAAG,EAAE,IAAI,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;gBAClD,OAAO,GAAG,IAAI,CAAC;aAChB;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,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;gBACpD,IAAI,KAAK;oBAAE,MAAM,CAAC,CAAC;aACpB;SACF;QAED,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtE,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAW,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC5B,MAAM,aAAa,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,SAAS,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CACxC,mBAAS,CAAC,MAAM,CAAC,GAAG,EAAE,aAAa,CAAC,CACrC,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAC5B,yBAAyB,EACzB;YACE,OAAO,EAAE,SAAS;SACnB,CACF,CAAC;QACF,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,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;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,WAAwB;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY,CAAC,SAA2B;QAI5C,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;IAC3D,CAAC;CACF;AAtPD,4BAsPC;AAED,kBAAe,QAAQ,CAAC"}
+{"version":3,"file":"Provider.js","sourceRoot":"","sources":["../src/Provider.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA6C;AAQ7C,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,IAAI,QAAQ,GAGP;YACH,IAAI,EAAE,EAAE;YACR,MAAM,EAAE,CAAC;YACT,UAAU,EAAE,EAAE;YACd,OAAO,EAAE,EAAE;YACX,MAAM,EAAE,EAAE;SACX,CAAC;QAEF,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,qCAAqC;QACrC,OAAO,CAAC,OAAO,EAAE;YACf,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,uDAAuD;gBACvD;;;;;;sCAMsB;gBAEtB,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAGxB,GAAG,EAAE,IAAI,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;gBAClD,OAAO,GAAG,IAAI,CAAC;aAChB;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;QACD,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK;YACrB,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACvD,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAW,CAAC;IACnC,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;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,eAAe,CACnB,WAA4B;QAE5B,MAAM,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;QACrC,OAAO;YACL,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,0CAA0C;gBAC1C,MAAM,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;gBAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE;oBAC9B,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;oBAClB,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC;wBACtD,WAAW,CAAC,EAAY;qBACzB,CAAC,CAAC;oBACH,IACE,YAAY;wBACZ,YAAY,CAAC,CAAC,CAAC;wBACf,YAAY,CAAC,CAAC,CAAC,CAAC,iBAAiB;wBAEjC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;iBAC/C;gBACD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;YAC5D,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;AAzTD,4BAyTC;AAED,kBAAe,QAAQ,CAAC"}

package/lib/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/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] = utils_1.decodeBase64(valueDecoded[name]);
+                    return;
+                }
+                // Specific byte conversion
+                switch (options[OP_BYTES]) {
+                    case "BASE58":
+                    case "CONTRACT_ID":
+                    case "ADDRESS":
+                        object[name] = utils_1.decodeBase58(valueDecoded[name]);
+                        break;
+                    case "BASE64":
+                        object[name] = utils_1.decodeBase64(valueDecoded[name]);
+                        break;
+                    case "HEX":
+                    case "BLOCK_ID":
+                    case "TRANSACTION_ID":
+                        object[name] = 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"
+            ? 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] = utils_1.encodeBase64(object[name]);
+                return;
+            }
+            // Specific byte conversion
+            switch (options[OP_BYTES]) {
+                case "BASE58":
+                case "CONTRACT_ID":
+                case "ADDRESS":
+                    object[name] = utils_1.encodeBase58(object[name]);
+                    break;
+                case "BASE64":
+                    object[name] = utils_1.encodeBase64(object[name]);
+                    break;
+                case "HEX":
+                case "BLOCK_ID":
+                case "TRANSACTION_ID":
+                    object[name] = `0x${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/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,oBAAY,CAAC,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,oBAAY,CAAC,YAAY,CAAC,IAAI,CAAW,CAAC,CAAC;wBAC1D,MAAM;oBACR,KAAK,QAAQ;wBACX,MAAM,CAAC,IAAI,CAAC,GAAG,oBAAY,CAAC,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,oBAAY,CACxB,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,oBAAY,CAAC,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,oBAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC1C,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,oBAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;oBAC1C,MAAM;gBACR,KAAK,QAAQ;oBACX,MAAM,CAAC,IAAI,CAAC,GAAG,oBAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;oBAC1C,MAAM;gBACR,KAAK,KAAK,CAAC;gBACX,KAAK,UAAU,CAAC;gBAChB,KAAK,gBAAgB;oBACnB,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,mBAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;oBAChD,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"}

package/lib/Signer.d.ts

@@ -1,4 +1,16 @@
-import { Transaction } from "./interface";
+import { Provider } from "./Provider";
+import { TransactionJson, ActiveTransactionData, Abi, SendTransactionResponse, RecoverPublicKeyOptions, BlockJson } from "./interface";
+import { Serializer } from "./Serializer";
+export interface SignerInterface {
+    provider?: Provider;
+    serializer?: Serializer;
+    getAddress(compressed?: boolean): string;
+    getPrivateKey(format: "wif" | "hex", compressed?: boolean): string;
+    signTransaction(tx: TransactionJson): Promise<TransactionJson>;
+    sendTransaction(tx: TransactionJson, abis?: Record<string, Abi>): Promise<SendTransactionResponse>;
+    encodeTransaction(activeData: ActiveTransactionData): Promise<TransactionJson>;
+    decodeTransaction(tx: TransactionJson): Promise<ActiveTransactionData>;
+}
 /**
  * The Signer Class contains the private key needed to sign transactions.
  * It can be created using the seed, wif, or private key
@@ -6,7 +18,8 @@ import { Transaction } from "./interface";
  * @example
  * using private key as hex string
  * ```ts
- * var signer = new Signer("ec8601a24f81decd57f4b611b5ac6eb801cb3780bb02c0f9cdfe9d09daaddf9c");
+ * var privateKey = "ec8601a24f81decd57f4b611b5ac6eb801cb3780bb02c0f9cdfe9d09daaddf9c";
+ * var signer = new Signer({ privateKey });
  * ```
  * <br>
  *
@@ -18,14 +31,15 @@ import { Transaction } from "./interface";
  *     1, 203,  55, 128, 187,   2, 192, 249,
  *   205, 254, 157,   9, 218, 173, 223, 156
  * ]);
- * var signer = new Signer(buffer);
+ * var signer = new Signer({ privateKey: buffer });
  * ```
  *
  * <br>
  *
  * using private key as bigint
  * ```ts
- * var signer = new Signer(106982601049961974618234078204952280507266494766432547312316920283818886029212n);
+ * var privateKey = 106982601049961974618234078204952280507266494766432547312316920283818886029212n;
+ * var signer = new Signer({ privateKey });
  * ```
  *
  * <br>
@@ -41,8 +55,17 @@ import { Transaction } from "./interface";
  * ```ts
  * var signer = Signer.fromWif("L59UtJcTdNBnrH2QSBA5beSUhRufRu3g6tScDTite6Msuj7U93tM");
  * ```
+ *
+ * <br>
+ *
+ * defining a provider
+ * ```ts
+ * var provider = new Provider(["https://example.com/jsonrpc"]);
+ * var privateKey = "ec8601a24f81decd57f4b611b5ac6eb801cb3780bb02c0f9cdfe9d09daaddf9c";
+ * var signer = new Signer({ privateKey, provider });
+ * ```
  */
-export declare class Signer {
+export declare class Signer implements SignerInterface {
     /**
      * Boolean determining if the public/private key
      * is using the compressed format
@@ -54,6 +77,14 @@ export declare class Signer {
      * Account address
      */
     address: string;
+    /**
+     * Provider to connect with the blockchain
+     */
+    provider?: Provider;
+    /**
+     * Serializer to serialize/deserialize data types
+     */
+    serializer?: Serializer;
     /**
      * The constructor receives de private key as hexstring, bigint or Uint8Array.
      * See also the functions [[Signer.fromWif]] and [[Signer.fromSeed]]
@@ -61,14 +92,27 @@ export declare class Signer {
      *
      * @param privateKey - Private key as hexstring, bigint or Uint8Array
      * @param compressed - compressed format is true by default
+     * @param provider - provider to connect with the blockchain
      * @example
      * ```ts
-     * cons signer = new Signer("ec8601a24f81decd57f4b611b5ac6eb801cb3780bb02c0f9cdfe9d09daaddf9c");
+     * const privateKey = "ec8601a24f81decd57f4b611b5ac6eb801cb3780bb02c0f9cdfe9d09daaddf9c";
+     * cons signer = new Signer({ privateKey });
      * console.log(signer.getAddress());
      * // 1MbL6mG8ASAvSYdoMnGUfG3ZXkmQ2dpL5b
      * ```
      */
-    constructor(privateKey: string | number | bigint | Uint8Array, compressed?: boolean);
+    constructor(c: {
+        privateKey: string | number | bigint | Uint8Array;
+        compressed?: boolean;
+        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;
+    });
     /**
      * Function to import a private key from the WIF
      * @param wif  - Private key in WIF format
@@ -125,20 +169,128 @@ export declare class Signer {
      * @param tx - Unsigned transaction
      * @returns
      */
-    signTransaction(tx: Transaction): Promise<Transaction>;
+    signTransaction(tx: TransactionJson): Promise<TransactionJson>;
+    /**
+     * Function to sign and send a transaction. It internally uses
+     * [[Provider.sendTransaction]]
+     * @param tx - Transaction to send. It will be signed inside this function
+     * if it is not signed yet
+     * @param _abis - Collection of Abis to parse the operations in the
+     * transaction. This parameter is optional.
+     * @returns
+     */
+    sendTransaction(tx: TransactionJson, _abis?: Record<string, Abi>): Promise<SendTransactionResponse>;
+    /**
+     * Function to recover the public key from a signed
+     * transaction or block.
+     * The output format can be compressed (default) or uncompressed.
+     *
+     * @example
+     * ```ts
+     * const publicKey = await Signer.recoverPublicKey(tx);
+     * ```
+     *
+     * If the signature data contains more data, like in the
+     * blocks for PoW consensus, use the "transformSignature"
+     * function to extract the signature.
+     *
+     * @example
+     * ```ts
+     *  const powDescriptorJson = {
+     *    nested: {
+     *      mypackage: {
+     *        nested: {
+     *          pow_signature_data: {
+     *            fields: {
+     *              nonce: {
+     *                type: "bytes",
+     *                id: 1,
+     *              },
+     *              recoverable_signature: {
+     *                type: "bytes",
+     *                id: 2,
+     *              },
+     *            },
+     *          },
+     *        },
+     *      },
+     *    },
+     *  };
+     *
+     *  const serializer = new Serializer(powDescriptorJson, {
+     *   defaultTypeName: "pow_signature_data",
+     *  });
+     *
+     *  const signer = await Signer.recoverPublicKey(block, {
+     *    transformSignature: async (signatureData) => {
+     *      const powSignatureData = await serializer.deserialize(signatureData);
+     *      return powSignatureData.recoverable_signature;
+     *    },
+     *  });
+     * ```
+     */
+    static recoverPublicKey(txOrBlock: TransactionJson | BlockJson, opts?: RecoverPublicKeyOptions): Promise<string>;
+    /**
+     * Function to recover the signer address from a signed
+     * transaction or block.
+     * The output format can be compressed (default) or uncompressed.
+     * @example
+     * ```ts
+     * const publicKey = await Signer.recoverAddress(tx);
+     * ```
+     *
+     * If the signature data contains more data, like in the
+     * blocks for PoW consensus, use the "transformSignature"
+     * function to extract the signature.
+     *
+     * @example
+     * ```ts
+     *  const powDescriptorJson = {
+     *    nested: {
+     *      mypackage: {
+     *        nested: {
+     *          pow_signature_data: {
+     *            fields: {
+     *              nonce: {
+     *                type: "bytes",
+     *                id: 1,
+     *              },
+     *              recoverable_signature: {
+     *                type: "bytes",
+     *                id: 2,
+     *              },
+     *            },
+     *          },
+     *        },
+     *      },
+     *    },
+     *  };
+     *
+     *  const serializer = new Serializer(powDescriptorJson, {
+     *   defaultTypeName: "pow_signature_data",
+     *  });
+     *
+     *  const signer = await Signer.recoverAddress(block, {
+     *    transformSignature: async (signatureData) => {
+     *      const powSignatureData = await serializer.deserialize(signatureData);
+     *      return powSignatureData.recoverable_signature;
+     *    },
+     *  });
+     * ```
+     */
+    static recoverAddress(txOrBlock: TransactionJson | BlockJson, opts?: RecoverPublicKeyOptions): Promise<string>;
     /**
-     * Function to recover the public key from a signed transaction.
-     * The output format can be compressed or uncompressed.
-     * @param tx - signed transaction
-     * @param compressed - output format (compressed by default)
+     * Function to encode a transaction
+     * @param activeData - Active data consists of nonce, rc_limit, and
+     * operations. Do not set the nonce to get it from the blockchain
+     * using the provider. The rc_limit is 1000000 by default.
+     * @returns A transaction encoded. The active field is encoded in
+     * base64url
      */
-    static recoverPublicKey(tx: Transaction, compressed?: boolean): string;
+    encodeTransaction(activeData: ActiveTransactionData): Promise<TransactionJson>;
     /**
-     * Function to recover the signer address from a signed transaction.
-     * The output format can be compressed or uncompressed.
-     * @param tx - signed transaction
-     * @param compressed - output format (compressed by default)
+     * Function to decode a transaction
      */
-    static recoverAddress(tx: Transaction, compressed?: boolean): string;
+    decodeTransaction(tx: TransactionJson): Promise<ActiveTransactionData>;
 }
 export default Signer;