@muritavo/testing-toolkit 0.3.0 → 0.3.1

package/dist/src/types/contract.d.ts

@@ -0,0 +1,79 @@
+import { Contract, ContractOptions, EventData, PastEventOptions } from "web3-eth-contract";
+export type AllABIs = readonly any[];
+type ExtractMethods<A extends AllABIs[number]> = A extends {
+    type: "function";
+} ? A["name"] : never;
+type ExtractEvents<A extends AllABIs[number]> = A extends {
+    type: "event";
+} ? A["name"] : never;
+type TypeOrInternalType<T> = T['internalType'] extends unknown ? T['type'] : T['internalType'];
+export type MapTypeToJS<L, C> = L extends "tuple[]" ? TuplifyUnion<C[number], C[number]['name']>[] : L extends "address" | "uint256" | "uint128" | "uint8" | "string" | "bytes32" ? string : L extends "uint256[]" | "string[]" ? string[] : L extends "bool" ? boolean : L extends 'tuple' ? TuplifyUnion<C[number], C[number]['name']> : unknown;
+type ExtractFromObj<R extends (AllABIs[number] & {
+    type: "function";
+})> = {
+    [K in R["outputs"][number]["name"]]: MapTypeToJS<TypeOrInternalType<(R["outputs"][number] & {
+        name: K;
+    })>, (R["outputs"][number] & {
+        name: K;
+    })["components"]>;
+};
+export type ExtractMethodDefinition<A extends AllABIs, N extends (AllABIs[number] & {
+    type: "function";
+})["name"], R = A[number] & {
+    type: "function";
+    name: N;
+}> = (...args: TuplifyUnion<(A[number] & {
+    type: "function";
+    name: N;
+})["inputs"][number], (A[number] & {
+    type: "function";
+    name: N;
+})["inputs"][number]["name"]>) => {
+    call: () => Promise<R extends {
+        outputs: {
+            length: 1;
+        };
+    } ? MapTypeToJS<TypeOrInternalType<R["outputs"][0]>, R["outputs"][0]['components']> : R extends {
+        outputs: any;
+    } ? ExtractFromObj<R> : void>;
+    send: (prop: {
+        from: string;
+        maxPriorityFeePerGas?: number;
+        gas?: number;
+        gasPrice?: string;
+    }) => Promise<void>;
+};
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+type LastOf<T> = UnionToIntersection<T extends any ? () => T : never> extends () => infer R ? R : never;
+type Push<T extends any[], V> = [...T, V];
+export type TuplifyUnion<FUNCS, T, L = LastOf<T>, N = [T] extends [never] ? true : false> = true extends N ? [] : Push<TuplifyUnion<FUNCS, Exclude<T, L>>, MapTypeToJS<TypeOrInternalType<(FUNCS & {
+    name: L;
+})>, (FUNCS & {
+    name: L;
+})['components']>>;
+export default class GenericContract<A extends AllABIs = AllABIs, E extends string = ExtractEvents<A[number]> | "allEvents"> extends Contract {
+    events: Exclude<E, "allEvents">;
+    constructor(jsonInterface: A, address?: string, options?: ContractOptions);
+    methods: {
+        [k in ExtractMethods<A[number]>]: ExtractMethodDefinition<A, k>;
+    };
+    getPastEvents(event: E): Promise<GenericEventData<A>[]>;
+    getPastEvents(event: E, options: PastEventOptions, callback: (error: Error, event: EventData) => void): Promise<GenericEventData<A>[]>;
+    getPastEvents(event: E, options: PastEventOptions): Promise<GenericEventData<A>[]>;
+    getPastEvents(event: E, callback: (error: Error, event: EventData) => void): Promise<GenericEventData<A>[]>;
+}
+export type GenericEventData<E extends AllABIs> = EventData & GenericEvent<E>;
+type ABIEvent = AllABIs[number] & {
+    type: "event";
+};
+type GenericEvent<ABI extends AllABIs, E extends string = ExtractEvents<ABI[number]>> = {
+    event: E;
+    returnValues: ExtractReturnValues<ABIEvent & {
+        name: E;
+    }>;
+};
+type ExtractReturnValues<E extends ABIEvent> = ExtractInputType<E["inputs"][number]>;
+type ExtractInputType<I extends ABIEvent["inputs"][number]> = {
+    [k in I["name"]]: MapTypeToJS<TypeOrInternalType<I>, I['components']>;
+};
+export {};

package/dist/src/types/contract.js

@@ -0,0 +1,31 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
+var web3_eth_contract_1 = require("web3-eth-contract");
+var GenericContract = /** @class */ (function (_super) {
+    __extends(GenericContract, _super);
+    function GenericContract(jsonInterface, address, options) {
+        return _super.call(this, jsonInterface, address, options) || this;
+    }
+    GenericContract.prototype.getPastEvents = function (event, options, callback) {
+        return _super.prototype.getPastEvents.call(this, event, options, callback);
+    };
+    return GenericContract;
+}(web3_eth_contract_1.Contract));
+exports.default = GenericContract;
+//# sourceMappingURL=contract.js.map

package/dist/src/types/contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../../../src/types/contract.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,cAAc;AACd,uDAK2B;AAyG3B;IAGY,mCAAQ;IAElB,yBAAY,aAAgB,EAAE,OAAgB,EAAE,OAAyB;QACvE,OAAA,MAAK,YAAC,aAAqC,EAAE,OAAO,EAAE,OAAO,CAAC,SAAC;IACjE,CAAC;IAkBQ,uCAAa,GAAtB,UACE,KAAU,EACV,OAAa,EACb,QAAc;QAEd,OAAO,gBAAK,CAAC,aAAa,YAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAQ,CAAC;IAC9D,CAAC;IACH,sBAAC;AAAD,CAAC,AAhCD,CAGY,4BAAQ,GA6BnB"}

package/dist/test/blockchain.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/blockchain.test.js

@@ -0,0 +1,97 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var path_1 = require("path");
+var blockchain_1 = require("../src/native/blockchain");
+var zero_x_abi_1 = require("./fixtures/zero_x_abi");
+var blockchain_2 = require("../src/client/blockchain");
+jest.mock("web3", function () { return require("web3v4"); });
+it("Should be able to spin up blockchain server forking a preexisting network", function () { return __awaiter(void 0, void 0, void 0, function () {
+    var mod, Web3, p, w, c;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, Promise.resolve().then(function () { return __importStar(require("web3")); })];
+            case 1:
+                mod = _a.sent();
+                Web3 = mod.default;
+                return [4 /*yield*/, (0, blockchain_1.startBlockchain)({
+                        projectRootFolder: (0, path_1.resolve)(__dirname),
+                        port: 19000,
+                    })];
+            case 2:
+                _a.sent();
+                p = new Web3.providers.HttpProvider("http://127.0.0.1:19000");
+                p.send({ method: "eth_chainId", jsonrpc: "2.0", id: 1, params: [] }, function (e, r) {
+                    console.log("Response", e, r);
+                });
+                w = new Web3(p);
+                c = new w.eth.Contract(zero_x_abi_1.ZERO_X_ABI, "0xdef1c0ded9bec7f1a1670819833240f027b25eff");
+                c.methods.getTransformWallet().call();
+                return [4 /*yield*/, (0, blockchain_2.invokeContract)("s", c, "getTransformWallet").then(function (r) {
+                        return console.log("Invoke return", r);
+                    })];
+            case 3:
+                _a.sent();
+                return [2 /*return*/];
+        }
+    });
+}); });
+//# sourceMappingURL=blockchain.test.js.map

package/dist/test/blockchain.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blockchain.test.js","sourceRoot":"","sources":["../../test/blockchain.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6BAA+B;AAC/B,uDAA2D;AAC3D,oDAAmD;AACnD,uDAA0D;AAG1D,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAM,OAAA,OAAO,CAAC,QAAQ,CAAC,EAAjB,CAAiB,CAAC,CAAC;AAE3C,EAAE,CAAC,2EAA2E,EAAE;;;;oBAClE,sFAAa,MAAM,QAAC;;gBAA1B,GAAG,GAAG,SAAoB;gBACf,IAAI,GAAK,GAAG,QAAR,CAAS;gBAC9B,qBAAM,IAAA,4BAAe,EAAC;wBACpB,iBAAiB,EAAE,IAAA,cAAO,EAAC,SAAS,CAAC;wBACrC,IAAI,EAAE,KAAK;qBACZ,CAAC,EAAA;;gBAHF,SAGE,CAAC;gBAEG,CAAC,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,wBAAwB,CAAC,CAAC;gBACpE,CAAC,CAAC,IAAI,CACJ,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAC5D,UAAC,CAAC,EAAE,CAAC;oBACH,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBAChC,CAAC,CACF,CAAC;gBACI,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;gBAChB,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,CAC1B,uBAAiB,EACjB,4CAA4C,CACP,CAAC;gBACxC,CAAC,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,IAAI,EAAE,CAAC;gBACtC,qBAAM,IAAA,2BAAc,EAAC,GAAG,EAAE,CAAC,EAAE,oBAAoB,CAAC,CAAC,IAAI,CAAC,UAAC,CAAC;wBACxD,OAAA,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,CAAC;oBAA/B,CAA+B,CAChC,EAAA;;gBAFD,SAEC,CAAC;;;;KACH,CAAC,CAAC"}

package/dist/test/fixtures/zero_x_abi.d.ts

@@ -0,0 +1,31 @@
+export declare const ZERO_X_ABI: readonly [{
+    readonly inputs: readonly [];
+    readonly name: "getTransformWallet";
+    readonly outputs: readonly [{
+        readonly internalType: "contract IFlashWallet";
+        readonly name: "wallet";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "account";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "operator";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "bool";
+        readonly name: "approved";
+        readonly type: "bool";
+    }];
+    readonly name: "ApprovalForAll";
+    readonly type: "event";
+}];

package/dist/test/fixtures/zero_x_abi.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZERO_X_ABI = void 0;
+exports.ZERO_X_ABI = [
+    {
+        inputs: [],
+        name: "getTransformWallet",
+        outputs: [
+            {
+                internalType: "contract IFlashWallet",
+                name: "wallet",
+                type: "address",
+            },
+        ],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                internalType: "address",
+                name: "account",
+                type: "address",
+            },
+            {
+                indexed: true,
+                internalType: "address",
+                name: "operator",
+                type: "address",
+            },
+            {
+                indexed: false,
+                internalType: "bool",
+                name: "approved",
+                type: "bool",
+            },
+        ],
+        name: "ApprovalForAll",
+        type: "event",
+    },
+];
+//# sourceMappingURL=zero_x_abi.js.map

package/dist/test/fixtures/zero_x_abi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zero_x_abi.js","sourceRoot":"","sources":["../../../test/fixtures/zero_x_abi.ts"],"names":[],"mappings":";;;AAAa,QAAA,UAAU,GAAG;IACxB;QACE,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,oBAAoB;QAC1B,OAAO,EAAE;YACP;gBACE,YAAY,EAAE,uBAAuB;gBACrC,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,SAAS;aAChB;SACF;QACD,eAAe,EAAE,MAAM;QACvB,IAAI,EAAE,UAAU;KACjB;IACD;QACE,SAAS,EAAE,KAAK;QAChB,MAAM,EAAE;YACN;gBACE,OAAO,EAAE,IAAI;gBACb,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,OAAO,EAAE,IAAI;gBACb,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,SAAS;aAChB;YACD;gBACE,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,MAAM;aACb;SACF;QACD,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,OAAO;KACd;CACO,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@muritavo/testing-toolkit",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "A series of functions to help with testing",
   "main": "index.js",
   "files": [
@@ -31,7 +31,8 @@
     "jest": "^29.7.0",
     "text2png": "^2.3.0",
     "ts-jest": "^29.1.2",
-    "web3": "^1"
+    "web3": "^1",
+    "web3v4": "npm:web3@4.1.0"
   },
   "dependencies": {
     "@firebase/rules-unit-testing": "^2.0.4",