koilib 9.1.1 → 9.2.0

package/lib/browser/index2.js

@@ -30,10 +30,12 @@ const Signer_1 = require("./Signer");
 const Provider_1 = require("./Provider");
 const Transaction_1 = require("./Transaction");
 const Serializer_1 = require("./Serializer");
+const Multicall_1 = require("./Multicall");
 window.utils = utils;
 window.Contract = Contract_1.Contract;
 window.Signer = Signer_1.Signer;
 window.Provider = Provider_1.Provider;
 window.Transaction = Transaction_1.Transaction;
 window.Serializer = Serializer_1.Serializer;
+window.Multicall = Multicall_1.Multicall;
 //# sourceMappingURL=index2.js.map

package/lib/browser/index2.js.map

@@ -1 +1 @@
-{"version":3,"file":"index2.js","sourceRoot":"","sources":["../../src/index2.ts"],"names":[],"mappings":";AAAA,wEAAwE;;;;;;;;;;;;;;;;;;;;;;;;;AAExE,+CAAiC;AACjC,yCAAsC;AACtC,qCAAkC;AAClC,yCAAsC;AACtC,+CAA4C;AAC5C,6CAA0C;AAI1C,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;AACrB,MAAM,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC3B,MAAM,CAAC,MAAM,GAAG,eAAM,CAAC;AACvB,MAAM,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC3B,MAAM,CAAC,WAAW,GAAG,yBAAW,CAAC;AACjC,MAAM,CAAC,UAAU,GAAG,uBAAU,CAAC"}
+{"version":3,"file":"index2.js","sourceRoot":"","sources":["../../src/index2.ts"],"names":[],"mappings":";AAAA,wEAAwE;;;;;;;;;;;;;;;;;;;;;;;;;AAExE,+CAAiC;AACjC,yCAAsC;AACtC,qCAAkC;AAClC,yCAAsC;AACtC,+CAA4C;AAC5C,6CAA0C;AAC1C,2CAAwC;AAIxC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;AACrB,MAAM,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC3B,MAAM,CAAC,MAAM,GAAG,eAAM,CAAC;AACvB,MAAM,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC3B,MAAM,CAAC,WAAW,GAAG,yBAAW,CAAC;AACjC,MAAM,CAAC,UAAU,GAAG,uBAAU,CAAC;AAC/B,MAAM,CAAC,SAAS,GAAG,qBAAS,CAAC"}

package/lib/index.d.ts

@@ -6,3 +6,4 @@ export * from "./Signer";
 export * from "./Provider";
 export * from "./Transaction";
 export * from "./Serializer";
+export * from "./Multicall";

package/lib/index.js

@@ -36,4 +36,5 @@ __exportStar(require("./Signer"), exports);
 __exportStar(require("./Provider"), exports);
 __exportStar(require("./Transaction"), exports);
 __exportStar(require("./Serializer"), exports);
+__exportStar(require("./Multicall"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wEAAwE;AACxE,iCAAiC;AACjC,sDAAsC;AACtC,8CAA4B;AAC5B,6CAA2B;AAC3B,2CAAyB;AACzB,6CAA2B;AAC3B,gDAA8B;AAC9B,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wEAAwE;AACxE,iCAAiC;AACjC,sDAAsC;AACtC,8CAA4B;AAC5B,6CAA2B;AAC3B,2CAAyB;AACzB,6CAA2B;AAC3B,gDAA8B;AAC9B,+CAA6B;AAC7B,8CAA4B"}

package/lib/index2.js

@@ -30,10 +30,12 @@ const Signer_1 = require("./Signer");
 const Provider_1 = require("./Provider");
 const Transaction_1 = require("./Transaction");
 const Serializer_1 = require("./Serializer");
+const Multicall_1 = require("./Multicall");
 window.utils = utils;
 window.Contract = Contract_1.Contract;
 window.Signer = Signer_1.Signer;
 window.Provider = Provider_1.Provider;
 window.Transaction = Transaction_1.Transaction;
 window.Serializer = Serializer_1.Serializer;
+window.Multicall = Multicall_1.Multicall;
 //# sourceMappingURL=index2.js.map

package/lib/index2.js.map

@@ -1 +1 @@
-{"version":3,"file":"index2.js","sourceRoot":"","sources":["../src/index2.ts"],"names":[],"mappings":";AAAA,wEAAwE;;;;;;;;;;;;;;;;;;;;;;;;;AAExE,+CAAiC;AACjC,yCAAsC;AACtC,qCAAkC;AAClC,yCAAsC;AACtC,+CAA4C;AAC5C,6CAA0C;AAI1C,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;AACrB,MAAM,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC3B,MAAM,CAAC,MAAM,GAAG,eAAM,CAAC;AACvB,MAAM,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC3B,MAAM,CAAC,WAAW,GAAG,yBAAW,CAAC;AACjC,MAAM,CAAC,UAAU,GAAG,uBAAU,CAAC"}
+{"version":3,"file":"index2.js","sourceRoot":"","sources":["../src/index2.ts"],"names":[],"mappings":";AAAA,wEAAwE;;;;;;;;;;;;;;;;;;;;;;;;;AAExE,+CAAiC;AACjC,yCAAsC;AACtC,qCAAkC;AAClC,yCAAsC;AACtC,+CAA4C;AAC5C,6CAA0C;AAC1C,2CAAwC;AAIxC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;AACrB,MAAM,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC3B,MAAM,CAAC,MAAM,GAAG,eAAM,CAAC;AACvB,MAAM,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC3B,MAAM,CAAC,WAAW,GAAG,yBAAW,CAAC;AACjC,MAAM,CAAC,UAAU,GAAG,uBAAU,CAAC;AAC/B,MAAM,CAAC,SAAS,GAAG,qBAAS,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koilib",
-  "version": "9.1.1",
+  "version": "9.2.0",
   "description": "JS Koinos Library",
   "author": "Julian Gonzalez",
   "repository": {

package/src/Multicall.ts

@@ -0,0 +1,139 @@
+import { Contract } from "./Contract";
+import { OperationJson } from "./interface";
+import { ProviderInterface } from "./Provider";
+import { Transaction } from "./Transaction";
+import { multicallAbi } from "./abis/multicallAbi";
+
+export class Multicall {
+  /**
+   * Multicall contract address
+   */
+  id: string;
+
+  transaction: Transaction;
+
+  contracts: Contract[];
+
+  /**
+   * @example
+   * ```ts
+   * const tokens = [
+   *   "19GYjDBVXU7keLbYvMLazsGQn3GTWHjHkK", // koin
+   *   "12Y5vW6gk8GceH53YfRkRre2Rrcsgw7Naq", // vhp
+   *   "12VoHz41a4HtfiyhTWbg9RXqGMRbYk6pXh", // vortex usdt
+   *   "1Tf1QKv3gVYLjq34yURSHw5ErTYbFjqTG", // vortex eth
+   * ];
+   * 
+   * const provider = new Provider("https://api.koinos.io");
+   * 
+   * // create an array of the different contracts
+   * // used in the multicall
+   * const contracts = [];
+   * for (const token of tokens) {
+   *   contracts.push(
+   *     new Contract({
+   *       id: token,
+   *       provider,
+   *       abi: utils.tokenAbi,
+   *     })
+   *   );
+   * }
+   * 
+   * // create the multicall instance
+   * const multicall = new Multicall({
+   *   provider,
+   *   contracts
+   * });
+   * 
+   * // add operations to the multicall
+   * for (const contract of contracts) {
+   *   await multicall.add(contract.functions.balanceOf, {
+   *     owner: "1MdqwaSBy6rbasPJ9vmg2pZFJSVZ29GFpZ",
+   *   });
+   * }
+   * 
+   * // call the multicall
+   * const results = await multicall.call();
+   * console.log(results);
+   * ```
+   *
+   * For testnet set the id to the multicall contract address for testnet
+   * ```ts
+   * const multicall = new Multicall({
+   *   id: "1MM9ydA8SdgXvCTH3LdQ5FS8JvHijCmGSg",
+   *   provider: new Provider("https://testnet-api.koinos.io"),
+   *   contracts: [ koinContract, fogataPoolContract ],
+   * });
+   * ```
+   */
+  constructor(c: {
+    /**
+     * Multicall contract address. Leave it undefined 
+     * to use the mainnet multicall contract address.
+     */
+    id?: string;
+    provider?: ProviderInterface;
+    contracts?: Contract[];
+  }) {
+    if (c.id) this.id = c.id;
+    else this.id = "18dVCqPG3gwgL7DWQAciKYNuXfzEg5LW7"; // multicontract address mainnet
+    this.transaction = new Transaction({ provider: c.provider });
+    this.contracts = c.contracts || [];
+  }
+
+  async add(
+    input:
+      | OperationJson
+      | { operation: OperationJson }
+      | Promise<{ operation: OperationJson }>
+      | Contract["functions"]["x"],
+    args?: unknown
+  ): Promise<void> {
+    await this.transaction.pushOperation(input, args);
+  }
+
+  async call<T = Record<string, unknown>>(): Promise<(T | Error)[]> {
+    const multicallContract = new Contract({
+      id: this.id,
+      provider: this.transaction.provider,
+      abi: multicallAbi,
+    });
+
+    const calls = this.transaction.transaction.operations!.map(
+      (op) => op.call_contract!
+    );
+    const { result: multicallResult } = await multicallContract.functions.get({
+      calls,
+    });
+
+    const results: (T | Error)[] = [];
+
+    for (let i = 0; i < calls.length; i += 1) {
+      const contract = this.contracts.find(
+        (c) => c.getId() === calls[i].contract_id
+      );
+      if (contract && contract.abi) {
+        const method = Object.values(contract.abi.methods).find((method) => {
+          return method.entry_point === calls[i].entry_point;
+        });
+        if (method) {
+          const decoded = (await contract!.serializer!.deserialize(
+            multicallResult!.results[i]!.res.object,
+            method.return
+          )) as T;
+          results.push(decoded as T);
+        } else {
+          results.push(
+            new Error(
+              `Method ${calls[i].entry_point} not found in contract ${calls[i].contract_id}`
+            )
+          );
+        }
+      } else {
+        results.push(new Error(`Contract ${calls[i].contract_id} not found`));
+      }
+    }
+
+    return results;
+  }
+}

package/src/abis/multicallAbi.ts

@@ -0,0 +1,127 @@
+import { AnyNestedObject } from "protobufjs";
+import { Abi } from "../interface";
+
+export const multicallAbi: Abi = {
+  methods: {
+    get: {
+      argument: "multicall.get_args",
+      return: "multicall.get_return",
+      description: "Get the result of a multicall",
+      entry_point: 697873187,
+      read_only: true,
+    },
+  },
+  types:
+    "CvEDCg9tdWx0aWNhbGwucHJvdG8SCW11bHRpY2FsbBoUa29pbm9zL29wdGlvbnMucHJvdG8ibAoOY2FsbF9hcmd1bWVudHMSJQoLY29udHJhY3RfaWQYASABKAxCBIC1GAVSCmNvbnRyYWN0SWQSHwoLZW50cnlfcG9pbnQYAiABKA1SCmVudHJ5UG9pbnQSEgoEYXJncxgDIAEoDFIEYXJncyJaCgZyZXN1bHQSGAoGb2JqZWN0GAEgASgMSABSBm9iamVjdBItCgVlcnJvchgCIAEoCzIVLm11bHRpY2FsbC5lcnJvcl9kYXRhSABSBWVycm9yQgcKBXZhbHVlIiYKCmVycm9yX2RhdGESGAoHbWVzc2FnZRgBIAEoCVIHbWVzc2FnZSI7CghnZXRfYXJncxIvCgVjYWxscxgBIAMoCzIZLm11bHRpY2FsbC5jYWxsX2FyZ3VtZW50c1IFY2FsbHMiRgoLY2FsbF9yZXR1cm4SEgoEY29kZRgBIAEoBVIEY29kZRIjCgNyZXMYAiABKAsyES5tdWx0aWNhbGwucmVzdWx0UgNyZXMiPgoKZ2V0X3JldHVybhIwCgdyZXN1bHRzGAEgAygLMhYubXVsdGljYWxsLmNhbGxfcmV0dXJuUgdyZXN1bHRzYgZwcm90bzM=",
+  koilib_types: {
+    nested: {
+      multicall: {
+        nested: {
+          call_arguments: {
+            fields: {
+              contract_id: {
+                type: "bytes",
+                id: 1,
+                options: {
+                  "(koinos.btype)": "CONTRACT_ID",
+                },
+              },
+              entry_point: {
+                type: "uint32",
+                id: 2,
+              },
+              args: {
+                type: "bytes",
+                id: 3,
+              },
+            },
+          },
+          result: {
+            oneofs: {
+              value: {
+                oneof: ["object", "error"],
+              },
+            },
+            fields: {
+              object: {
+                type: "bytes",
+                id: 1,
+              },
+              error: {
+                type: "error_data",
+                id: 2,
+              },
+            },
+          },
+          error_data: {
+            fields: {
+              message: {
+                type: "string",
+                id: 1,
+              },
+            },
+          },
+          get_args: {
+            fields: {
+              calls: {
+                rule: "repeated",
+                type: "call_arguments",
+                id: 1,
+              },
+            },
+          },
+          call_return: {
+            fields: {
+              code: {
+                type: "int32",
+                id: 1,
+              },
+              res: {
+                type: "result",
+                id: 2,
+              },
+            },
+          },
+          get_return: {
+            fields: {
+              results: {
+                rule: "repeated",
+                type: "call_return",
+                id: 1,
+              },
+            },
+          },
+        },
+      },
+      koinos: {
+        options: {
+          go_package: "github.com/koinos/koinos-proto-golang/koinos",
+        },
+        nested: {
+          bytes_type: {
+            values: {
+              BASE64: 0,
+              BASE58: 1,
+              HEX: 2,
+              BLOCK_ID: 3,
+              TRANSACTION_ID: 4,
+              CONTRACT_ID: 5,
+              ADDRESS: 6,
+            },
+          },
+          _btype: {
+            oneof: ["btype"],
+          } as AnyNestedObject,
+          btype: {
+            type: "bytes_type",
+            id: 50000,
+            extend: "google.protobuf.FieldOptions",
+            options: {
+              proto3_optional: true,
+            },
+          },
+        },
+      },
+    },
+  },
+};

package/src/index.ts

@@ -7,3 +7,4 @@ export * from "./Signer";
 export * from "./Provider";
 export * from "./Transaction";
 export * from "./Serializer";
+export * from "./Multicall";

package/src/index2.ts

@@ -6,6 +6,7 @@ import { Signer } from "./Signer";
 import { Provider } from "./Provider";
 import { Transaction } from "./Transaction";
 import { Serializer } from "./Serializer";
+import { Multicall } from "./Multicall";
 
 declare const window: { [x: string]: unknown };
 
@@ -15,3 +16,4 @@ window.Signer = Signer;
 window.Provider = Provider;
 window.Transaction = Transaction;
 window.Serializer = Serializer;
+window.Multicall = Multicall;