ethers.js/packages/tests/lib.esm/test-contract.js

'use strict';
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());
    });
};
import assert from "assert";
import { ethers } from "ethers";
import contractData from "./test-contract.json";
const provider = new ethers.providers.InfuraProvider("rinkeby", "49a0efa3aaee4fd99797bfa94d8ce2f1");
//const provider = ethers.getDefaultProvider("rinkeby");
const TIMEOUT_PERIOD = 120000;
const contract = (function () {
    return new ethers.Contract(contractData.contractAddress, contractData.interface, provider);
})();
function equals(name, actual, expected) {
    if (Array.isArray(expected)) {
        assert.equal(actual.length, expected.length, 'array length mismatch - ' + name);
        expected.forEach(function (expected, index) {
            equals(name + ':' + index, actual[index], expected);
        });
        return;
    }
    if (typeof (actual) === 'object') {
        if (expected.indexed) {
            assert.ok(ethers.Contract.isIndexed(actual), 'index property has index - ' + name);
            if (expected.hash) {
                assert.equal(actual.hash, expected.hash, 'index property with known hash matches - ' + name);
            }
            return;
        }
        if (actual.eq) {
            assert.ok(actual.eq(expected), 'numeric value matches - ' + name);
        }
    }
    assert.equal(actual, expected, 'value matches - ' + name);
}
function TestContractEvents() {
    return __awaiter(this, void 0, void 0, function* () {
        function waitForEvent(eventName, expected) {
            return new Promise(function (resolve, reject) {
                let done = false;
                contract.on("error", (error) => {
                    if (done) {
                        return;
                    }
                    done = true;
                    contract.removeAllListeners();
                    reject(error);
                });
                contract.on(eventName, function () {
                    if (done) {
                        return;
                    }
                    done = true;
                    let args = Array.prototype.slice.call(arguments);
                    let event = args[args.length - 1];
                    event.removeListener();
                    equals(event.event, args.slice(0, args.length - 1), expected);
                    resolve();
                });
                const timer = setTimeout(() => {
                    if (done) {
                        return;
                    }
                    done = true;
                    contract.removeAllListeners();
                    reject(new Error("timeout"));
                }, TIMEOUT_PERIOD);
                if (timer.unref) {
                    timer.unref();
                }
            });
        }
        const running = new Promise(function (resolve, reject) {
            let p0 = '0x06B5955A67D827CDF91823E3bB8F069e6c89c1D6';
            let p0_1 = '0x06b5955A67d827CdF91823e3Bb8F069e6C89C1d7';
            let p1 = 0x42;
            let p1_1 = 0x43;
            return Promise.all([
                waitForEvent('Test', [p0, p1]),
                waitForEvent('TestP0', [p0, p1]),
                waitForEvent('TestP0P1', [p0, p1]),
                waitForEvent('TestIndexedString', [{ indexed: true, hash: '0x7c5ea36004851c764c44143b1dcb59679b11c9a68e5f41497f6cf3d480715331' }, p1]),
                waitForEvent('TestV2', [{ indexed: true }, [p0, p1]]),
                waitForEvent('TestV2Nested', [{ indexed: true }, [p0_1, p1_1, [p0, p1]]]),
            ]).then(function (result) {
                resolve(result);
            });
        });
        const data = yield ethers.utils.fetchJson('https://api.ethers.io/api/v1/?action=triggerTest&address=' + contract.address);
        console.log('*** Triggered Transaction Hash: ' + data.hash);
        return running;
    });
}
describe('Test Contract Objects', function () {
    it('parses events', function () {
        this.timeout(TIMEOUT_PERIOD);
        return TestContractEvents();
    });
    it('ABIv2 parameters and return types work', function () {
        this.timeout(TIMEOUT_PERIOD);
        let p0 = '0x06B5955A67D827CDF91823E3bB8F069e6c89c1D6';
        let p0_0f = '0x06B5955a67d827cDF91823e3bB8F069E6c89c1e5';
        let p0_f0 = '0x06b5955a67D827CDF91823e3Bb8F069E6C89c2C6';
        let p1 = 0x42;
        let p1_0f = 0x42 + 0x0f;
        let p1_f0 = 0x42 + 0xf0;
        let expectedPosStruct = [p0_f0, p1_f0, [p0_0f, p1_0f]];
        let seq = Promise.resolve();
        [
            [p0, p1, [p0, p1]],
            { p0: p0, p1: p1, child: [p0, p1] },
            [p0, p1, { p0: p0, p1: p1 }],
            { p0: p0, p1: p1, child: { p0: p0, p1: p1 } }
        ].forEach(function (struct) {
            seq = seq.then(function () {
                return contract.testV2(struct).then((result) => {
                    equals('position input', result, expectedPosStruct);
                    equals('keyword input p0', result.p0, expectedPosStruct[0]);
                    equals('keyword input p1', result.p1, expectedPosStruct[1]);
                    equals('keyword input child.p0', result.child.p0, expectedPosStruct[2][0]);
                    equals('keyword input child.p1', result.child.p1, expectedPosStruct[2][1]);
                });
            });
        });
        return seq;
    });
    it('collapses single argument solidity methods', function () {
        this.timeout(TIMEOUT_PERIOD);
        return contract.testSingleResult(4).then((result) => {
            assert.equal(result, 5, 'single value returned');
        });
    });
    it('does not collapses multi argument solidity methods', function () {
        this.timeout(TIMEOUT_PERIOD);
        return contract.testMultiResult(6).then((result) => {
            assert.equal(result[0], 7, 'multi value [0] returned');
            assert.equal(result[1], 8, 'multi value [1] returned');
            assert.equal(result.r0, 7, 'multi value [r0] returned');
            assert.equal(result.r1, 8, 'multi value [r1] returned');
        });
    });
});
// @TODO: Exapnd this
describe("Test Contract Transaction Population", function () {
    const abi = [
        "function transfer(address to, uint amount)",
        "function unstake() nonpayable",
        "function mint() payable",
        "function balanceOf(address owner) view returns (uint)"
    ];
    const testAddress = "0xdeadbeef00deadbeef01deadbeef02deadbeef03";
    const testAddressCheck = "0xDEAdbeeF00deAdbeEF01DeAdBEEF02DeADBEEF03";
    const fireflyAddress = "0x8ba1f109551bD432803012645Ac136ddd64DBA72";
    const contract = new ethers.Contract(testAddress, abi);
    const contractConnected = contract.connect(ethers.getDefaultProvider());
    it("standard population", function () {
        return __awaiter(this, void 0, void 0, function* () {
            const tx = yield contract.populateTransaction.balanceOf(testAddress);
            //console.log(tx);
            assert.equal(Object.keys(tx).length, 2, "correct number of keys");
            assert.equal(tx.data, "0x70a08231000000000000000000000000deadbeef00deadbeef01deadbeef02deadbeef03", "data matches");
            assert.equal(tx.to, testAddressCheck, "to address matches");
        });
    });
    it("allows 'from' overrides", function () {
        return __awaiter(this, void 0, void 0, function* () {
            const tx = yield contract.populateTransaction.balanceOf(testAddress, {
                from: testAddress
            });
            //console.log(tx);
            assert.equal(Object.keys(tx).length, 3, "correct number of keys");
            assert.equal(tx.data, "0x70a08231000000000000000000000000deadbeef00deadbeef01deadbeef02deadbeef03", "data matches");
            assert.equal(tx.to, testAddressCheck, "to address matches");
            assert.equal(tx.from, testAddressCheck, "from address matches");
        });
    });
    it("allows ENS 'from' overrides", function () {
        return __awaiter(this, void 0, void 0, function* () {
            this.timeout(20000);
            const tx = yield contractConnected.populateTransaction.balanceOf(testAddress, {
                from: "ricmoo.firefly.eth"
            });
            //console.log(tx);
            assert.equal(Object.keys(tx).length, 3, "correct number of keys");
            assert.equal(tx.data, "0x70a08231000000000000000000000000deadbeef00deadbeef01deadbeef02deadbeef03", "data matches");
            assert.equal(tx.to, testAddressCheck, "to address matches");
            assert.equal(tx.from, fireflyAddress, "from address matches");
        });
    });
    it("allows send overrides", function () {
        return __awaiter(this, void 0, void 0, function* () {
            const tx = yield contract.populateTransaction.mint({
                gasLimit: 150000,
                gasPrice: 1900000000,
                nonce: 5,
                value: 1234,
                from: testAddress
            });
            //console.log(tx);
            assert.equal(Object.keys(tx).length, 7, "correct number of keys");
            assert.equal(tx.data, "0x1249c58b", "data matches");
            assert.equal(tx.to, testAddressCheck, "to address matches");
            assert.equal(tx.nonce, 5, "nonce address matches");
            assert.ok(tx.gasLimit.eq(150000), "gasLimit matches");
            assert.ok(tx.gasPrice.eq(1900000000), "gasPrice matches");
            assert.ok(tx.value.eq(1234), "value matches");
            assert.equal(tx.from, testAddressCheck, "from address matches");
        });
    });
    it("allows zero 'value' to non-payable", function () {
        return __awaiter(this, void 0, void 0, function* () {
            const tx = yield contract.populateTransaction.unstake({
                from: testAddress,
                value: 0
            });
            //console.log(tx);
            assert.equal(Object.keys(tx).length, 3, "correct number of keys");
            assert.equal(tx.data, "0x2def6620", "data matches");
            assert.equal(tx.to, testAddressCheck, "to address matches");
            assert.equal(tx.from, testAddressCheck, "from address matches");
        });
    });
    // @TODO: Add test cases to check for fault cases
    // - cannot send non-zero value to non-payable
    // - using the wrong from for a Signer-connected contract
    it("forbids non-zero 'value' to non-payable", function () {
        return __awaiter(this, void 0, void 0, function* () {
            try {
                const tx = yield contract.populateTransaction.unstake({
                    value: 1
                });
                console.log("Tx", tx);
                assert.ok(false, "throws on non-zero value to non-payable");
            }
            catch (error) {
                assert.ok(error.operation === "overrides.value");
            }
        });
    });
    it("allows overriding same 'from' with a Signer", function () {
        return __awaiter(this, void 0, void 0, function* () {
            const contractSigner = contract.connect(testAddress);
            const tx = yield contractSigner.populateTransaction.unstake({
                from: testAddress
            });
            //console.log(tx);
            assert.equal(Object.keys(tx).length, 3, "correct number of keys");
            assert.equal(tx.data, "0x2def6620", "data matches");
            assert.equal(tx.to, testAddressCheck, "to address matches");
            assert.equal(tx.from, testAddressCheck, "from address matches");
        });
    });
    it("forbids overriding 'from' with a Signer", function () {
        return __awaiter(this, void 0, void 0, function* () {
            const contractSigner = contract.connect(testAddress);
            try {
                const tx = yield contractSigner.populateTransaction.unstake({
                    from: fireflyAddress
                });
                console.log("Tx", tx);
                assert.ok(false, "throws on non-zero value to non-payable");
            }
            catch (error) {
                assert.ok(error.operation === "overrides.from");
            }
        });
    });
    it("allows overriding with invalid, but nullish values", function () {
        return __awaiter(this, void 0, void 0, function* () {
            const contractSigner = contract.connect(testAddress);
            const tx = yield contractSigner.populateTransaction.unstake({
                blockTag: null,
                from: null
            });
            //console.log("Tx", tx);
            assert.equal(Object.keys(tx).length, 3, "correct number of keys");
            assert.equal(tx.data, "0x2def6620", "data matches");
            assert.equal(tx.to, testAddressCheck, "to address matches");
            assert.equal(tx.from, testAddressCheck.toLowerCase(), "from address matches");
        });
    });
});
//# sourceMappingURL=test-contract.js.map