tornado-packages/ethers.js
1
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
ethers-v5-beta
ethers.js/packages/tests/lib/test-utils.js

444 lines
22 KiB
JavaScript
Raw Permalink Normal View History

Updated dist files.
2019-05-14 18:48:48 -04:00
'use strict';
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
result["default"] = mod;
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
var assert_1 = __importDefault(require("assert"));
var ethers_1 = require("ethers");
var testcases_1 = require("@ethersproject/testcases");
var utils = __importStar(require("./utils"));
function equals(a, b) {
if (Array.isArray(a)) {
if (!Array.isArray(b) || a.length !== b.length) {
return false;
}
for (var i = 0; i < a.length; i++) {
if (!equals(a[i], b[i])) {
return false;
}
}
return true;
}
return a === b;
}
describe('Test Contract Address Generation', function () {
// @TODO: Mine a large collection of these from the blockchain
var getContractAddress = ethers_1.ethers.utils.getContractAddress;
var Tests = [
Updated dist files.
2019-09-08 02:46:53 -04:00
// Transaction: 0x939aa17985bc2a52a0c1cba9497ef09e092355a805a8150e30e24b753bac6864
Updated dist files.
2019-05-14 18:48:48 -04:00
{
address: '0x3474627D4F63A678266BC17171D87f8570936622',
Updated dist files.
2019-09-08 02:46:53 -04:00
name: 'tx-0x939aa179 (number)',
Updated dist files.
2019-05-14 18:48:48 -04:00
tx: {
from: '0xb2682160c482eb985ec9f3e364eec0a904c44c23',
nonce: 10,
}
},
Updated dist files.
2019-09-08 02:46:53 -04:00
{
address: '0x3474627D4F63A678266BC17171D87f8570936622',
name: 'tx-0x939aa179 (odd-zero-hex)',
tx: {
from: '0xb2682160c482eb985ec9f3e364eec0a904c44c23',
nonce: "0xa",
}
},
{
address: '0x3474627D4F63A678266BC17171D87f8570936622',
name: 'tx-0x939aa179 (even-zero-hex)',
tx: {
from: '0xb2682160c482eb985ec9f3e364eec0a904c44c23',
nonce: "0x0a",
}
},
// Ropsten: https://etherscan.io/tx/0x78d17f8ab31fb6ad688340634a9a29d8726feb6d588338a9b9b21a44159bc916
{
address: '0x271300790813f82638A8A6A8a86d65df6dF33c17',
name: 'tx-0x78d17f8a (odd-long-hex)',
tx: {
from: '0x8ba1f109551bd432803012645ac136ddd64dba72',
nonce: "0x200",
}
},
{
address: '0x271300790813f82638A8A6A8a86d65df6dF33c17',
name: 'tx-0x78d17f8a (even-long-hex)',
tx: {
from: '0x8ba1f109551bd432803012645ac136ddd64dba72',
nonce: "0x0200",
}
},
// https://ropsten.etherscan.io/tx/0x444ea8ae9890ac0ee5fd249512726abf9d23f44a378d5f45f727b65dc1b899c2
{
address: '0x995C25706C407a1F1E84b3777775e3e619764933',
name: 'tx-0x444ea8ae (even-long-hex)',
tx: {
from: '0x8ba1f109551bd432803012645ac136ddd64dba72',
nonce: "0x1d",
}
},
{
address: '0x995C25706C407a1F1E84b3777775e3e619764933',
name: 'tx-0x444ea8ae (padded-long-hex)',
tx: {
from: '0x8ba1f109551bd432803012645ac136ddd64dba72',
nonce: "0x001d",
}
},
{
address: '0x995C25706C407a1F1E84b3777775e3e619764933',
name: 'tx-0x444ea8ae (number)',
tx: {
from: '0x8ba1f109551bd432803012645ac136ddd64dba72',
nonce: 29,
}
},
Updated dist files.
2019-05-14 18:48:48 -04:00
// Ropsten: 0x5bdfd14fcc917abc2f02a30721d152a6f147f09e8cbaad4e0d5405d646c5c3e1
{
address: '0x0CcCC7507aEDf9FEaF8C8D731421746e16b4d39D',
name: 'zero-nonce',
tx: {
from: '0xc6af6e1a78a6752c7f8cd63877eb789a2adb776c',
nonce: 0
}
},
];
Tests.forEach(function (test) {
it(('Computes the transaction address - ' + test.name), function () {
this.timeout(120000);
assert_1.default.equal(getContractAddress(test.tx), test.address, 'computes the transaction address');
});
});
});
describe('Test RLP Coder', function () {
var tests = testcases_1.loadTests('rlp-coder');
tests.forEach(function (test) {
it(('RLP coder encoded - ' + test.name), function () {
this.timeout(120000);
assert_1.default.equal(ethers_1.ethers.utils.RLP.encode(test.decoded), test.encoded, 'RLP encoded - ' + test.name);
});
});
tests.forEach(function (test) {
it(('RLP coder decoded - ' + test.name), function () {
this.timeout(120000);
assert_1.default.ok(equals(ethers_1.ethers.utils.RLP.decode(test.encoded), test.decoded), 'RLP decoded - ' + test.name);
});
});
});
describe('Test Unit Conversion', function () {
var tests = testcases_1.loadTests('units');
tests.forEach(function (test) {
var wei = ethers_1.ethers.BigNumber.from(test.wei);
it(('parses ' + test.ether + ' ether'), function () {
assert_1.default.ok(ethers_1.ethers.utils.parseEther(test.ether.replace(/,/g, '')).eq(wei), 'parsing ether failed - ' + test.name);
});
it(('formats ' + wei.toString() + ' wei to ether'), function () {
var actual = ethers_1.ethers.utils.formatEther(wei);
assert_1.default.equal(actual, test.ether_format, 'formatting wei failed - ' + test.name);
});
});
tests.forEach(function (test) {
var wei = ethers_1.ethers.BigNumber.from(test.wei);
['kwei', 'mwei', 'gwei', 'szabo', 'finney', 'satoshi'].forEach(function (name) {
var unitName = name;
if (name === 'satoshi') {
unitName = 8;
}
if (test[name]) {
it(('parses ' + test[name] + ' ' + name), function () {
this.timeout(120000);
assert_1.default.ok(ethers_1.ethers.utils.parseUnits(test[name].replace(/,/g, ''), unitName).eq(wei), ('parsing ' + name + ' failed - ' + test.name));
});
}
var expectedKey = (name + '_format');
if (test[expectedKey]) {
it(('formats ' + wei.toString() + ' wei to ' + name + ')'), function () {
var actual = ethers_1.ethers.utils.formatUnits(wei, unitName);
var expected = test[expectedKey];
assert_1.default.equal(actual, expected, ('formats ' + name + ' - ' + test.name));
});
}
});
});
});
describe('Test Namehash', function () {
var tests = testcases_1.loadTests('namehash');
tests.forEach(function (test) {
it(('computes namehash - "' + test.name + '"'), function () {
this.timeout(120000);
assert_1.default.equal(ethers_1.ethers.utils.namehash(test.name), test.expected, 'computes namehash(' + test.name + ')');
});
});
});
Updated dist files.
2020-04-23 23:35:39 -04:00
describe('Test ID Hash Functions', function () {
Updated dist files.
2019-05-14 18:48:48 -04:00
var tests = [
{
name: 'setAddr signature hash',
text: 'setAddr(bytes32,address)',
expected: '0xd5fa2b00b0756613052388dd576d941ba16904757996b8bb03a737ef4fd1f9ce'
}
];
tests.forEach(function (test) {
it(('computes id - ' + test.name), function () {
this.timeout(120000);
var actual = ethers_1.ethers.utils.id(test.text);
assert_1.default.equal(actual, test.expected, 'computes id(' + test.text + ')');
});
});
});
describe('Test Solidity Hash Functions', function () {
var tests = testcases_1.loadTests('solidity-hashes');
function test(funcName, testKey) {
it(('computes ' + funcName + ' correctly'), function () {
this.timeout(120000);
tests.forEach(function (test, index) {
var actual = (ethers_1.ethers.utils)['solidity' + funcName](test.types, test.values);
var expected = test[testKey];
assert_1.default.equal(actual, expected, ('computes solidity-' + funcName + '(' + JSON.stringify(test.values) + ') - ' + test.types));
});
});
}
test('Keccak256', 'keccak256');
test('Sha256', 'sha256');
});
describe('Test Hash Functions', function () {
var tests = testcases_1.loadTests('hashes');
it('computes keccak256 correctly', function () {
this.timeout(120000);
tests.forEach(function (test) {
assert_1.default.equal(ethers_1.ethers.utils.keccak256(test.data), test.keccak256, ('Keccak256 - ' + test.data));
});
});
it('computes sha2566 correctly', function () {
this.timeout(120000);
tests.forEach(function (test) {
assert_1.default.equal(ethers_1.ethers.utils.sha256(test.data), test.sha256, ('SHA256 - ' + test.data));
});
});
});
describe('Test Solidity splitSignature', function () {
it('splits a canonical signature', function () {
this.timeout(120000);
var r = '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef';
var s = '0xcafe1a7ecafe1a7ecafe1a7ecafe1a7ecafe1a7ecafe1a7ecafe1a7ecafe1a7e';
for (var v = 27; v <= 28; v++) {
var signature = ethers_1.ethers.utils.concat([r, s, [v]]);
var sig = ethers_1.ethers.utils.splitSignature(signature);
assert_1.default.equal(sig.r, r, 'split r correctly');
assert_1.default.equal(sig.s, s, 'split s correctly');
assert_1.default.equal(sig.v, v, 'split v correctly');
}
});
it('splits a legacy signature', function () {
this.timeout(120000);
var r = '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef';
var s = '0xcafe1a7ecafe1a7ecafe1a7ecafe1a7ecafe1a7ecafe1a7ecafe1a7ecafe1a7e';
for (var v = 27; v <= 28; v++) {
var signature = ethers_1.ethers.utils.concat([r, s, [v - 27]]);
var sig = ethers_1.ethers.utils.splitSignature(signature);
assert_1.default.equal(sig.r, r, 'split r correctly');
assert_1.default.equal(sig.s, s, 'split s correctly');
assert_1.default.equal(sig.v, v, 'split v correctly');
}
});
});
describe('Test Base64 coder', function () {
// https://en.wikipedia.org/wiki/Base64#Examples
it('encodes and decodes the example from wikipedia', function () {
this.timeout(120000);
var decodedText = 'Man is distinguished, not only by his reason, but by this singular passion from other animals, which is a lust of the mind, that by a perseverance of delight in the continued and indefatigable generation of knowledge, exceeds the short vehemence of any carnal pleasure.';
var decoded = ethers_1.ethers.utils.toUtf8Bytes(decodedText);
var encoded = 'TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlzIHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2YgdGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGludWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=';
assert_1.default.equal(ethers_1.ethers.utils.base64.encode(decoded), encoded, 'encodes to base64 string');
Updated dist files.
2020-04-23 23:35:39 -04:00
assert_1.default.equal(ethers_1.ethers.utils.toUtf8String(ethers_1.ethers.utils.base64.decode(encoded)), decodedText, 'decodes from base64 string');
Updated dist files.
2019-05-14 18:48:48 -04:00
});
});
describe('Test UTF-8 coder', function () {
Updated dist files.
2020-01-20 19:43:50 -05:00
var overlong = ethers_1.ethers.utils.Utf8ErrorReason.OVERLONG;
var utf16Surrogate = ethers_1.ethers.utils.Utf8ErrorReason.UTF16_SURROGATE;
var overrun = ethers_1.ethers.utils.Utf8ErrorReason.OVERRUN;
var missingContinue = ethers_1.ethers.utils.Utf8ErrorReason.MISSING_CONTINUE;
var unexpectedContinue = ethers_1.ethers.utils.Utf8ErrorReason.UNEXPECTED_CONTINUE;
var outOfRange = ethers_1.ethers.utils.Utf8ErrorReason.OUT_OF_RANGE;
Updated dist files.
2019-05-14 18:48:48 -04:00
var BadUTF = [
// See: https://en.wikipedia.org/wiki/UTF-8#Overlong_encodings
Updated dist files.
2020-01-20 19:43:50 -05:00
{ bytes: [0xF0, 0x82, 0x82, 0xAC], reason: overlong, ignored: "", replaced: "\u20ac", name: 'wikipedia overlong encoded Euro sign' },
{ bytes: [0xc0, 0x80], reason: overlong, ignored: "", replaced: "\u0000", name: '2-byte overlong - 0xc080' },
{ bytes: [0xc0, 0xbf], reason: overlong, ignored: "", replaced: "?", name: '2-byte overlong - 0xc0bf' },
{ bytes: [0xc1, 0x80], reason: overlong, ignored: "", replaced: "@", name: '2-byte overlong - 0xc180' },
{ bytes: [0xc1, 0xbf], reason: overlong, ignored: "", replaced: "\u007f", name: '2-byte overlong - 0xc1bf' },
Updated dist files.
2019-05-14 18:48:48 -04:00
// Reserved UTF-16 Surrogate halves
Updated dist files.
2020-01-20 19:43:50 -05:00
{ bytes: [0xed, 0xa0, 0x80], reason: utf16Surrogate, ignored: "", replaced: "\ufffd", name: 'utf-16 surrogate - U+d800' },
{ bytes: [0xed, 0xbf, 0xbf], reason: utf16Surrogate, ignored: "", replaced: "\ufffd", name: 'utf-16 surrogate - U+dfff' },
Updated dist files.
2019-05-14 18:48:48 -04:00
// a leading byte not followed by enough continuation bytes
Updated dist files.
2020-01-20 19:43:50 -05:00
{ bytes: [0xdf], reason: overrun, ignored: "", replaced: "\ufffd", name: 'too short - 2-bytes - 0x00' },
{ bytes: [0xe0], reason: overrun, ignored: "", replaced: "\ufffd", name: 'too short - 3-bytes' },
{ bytes: [0xe0, 0x80], reason: overrun, ignored: "", replaced: "\ufffd", name: 'too short - 3-bytes with 1' },
{ bytes: [0x80], reason: unexpectedContinue, ignored: "", replaced: "\ufffd", name: 'unexpected continuation byte' },
{ bytes: [0xc2, 0x00], reason: missingContinue, ignored: "\u0000", replaced: "\ufffd\u0000", name: 'invalid continuation byte - 0xc200' },
{ bytes: [0xc2, 0x40], reason: missingContinue, ignored: "@", replaced: "\ufffd@", name: 'invalid continuation byte - 0xc240' },
{ bytes: [0xc2, 0xc0], reason: missingContinue, ignored: "", replaced: "\ufffd\ufffd", name: 'invalid continuation byte - 0xc2c0' },
Updated dist files.
2019-05-14 18:48:48 -04:00
// Out of range
Updated dist files.
2020-01-20 19:43:50 -05:00
{ bytes: [0xf4, 0x90, 0x80, 0x80], reason: outOfRange, ignored: "", replaced: "\ufffd", name: 'out of range' },
Updated dist files.
2019-05-14 18:48:48 -04:00
];
BadUTF.forEach(function (test) {
it('toUtf8String - ' + test.name, function () {
Updated dist files.
2020-01-20 19:43:50 -05:00
// Check the string using the ignoreErrors conversion
var ignored = ethers_1.ethers.utils.toUtf8String(test.bytes, ethers_1.ethers.utils.Utf8ErrorFuncs.ignore);
assert_1.default.equal(ignored, test.ignored, "ignoring errors matches");
// Check the string using the replaceErrors conversion
var replaced = ethers_1.ethers.utils.toUtf8String(test.bytes, ethers_1.ethers.utils.Utf8ErrorFuncs.replace);
assert_1.default.equal(replaced, test.replaced, "replaced errors matches");
// Check the string throws the correct error during conversion
Updated dist files.
2019-05-14 18:48:48 -04:00
assert_1.default.throws(function () {
var result = ethers_1.ethers.utils.toUtf8String(test.bytes);
console.log('Result', result);
}, function (error) {
Updated dist files.
2020-01-20 19:43:50 -05:00
return (error.message.split(";").pop().split("(")[0].trim() === test.reason);
Updated dist files.
2019-05-14 18:48:48 -04:00
}, test.name);
});
});
it('toUtf8String - random conversions', function () {
this.timeout(200000);
function randomChar(seed) {
switch (utils.randomNumber(seed + '-range', 0, 4)) {
case 0:
return String.fromCharCode(utils.randomNumber(seed + '-value', 0, 0x100));
case 1:
return String.fromCharCode(utils.randomNumber(seed + '-value', 0, 0xd800));
case 2:
return String.fromCharCode(utils.randomNumber(seed + '-value', 0xdfff + 1, 0xffff));
case 3:
var left = utils.randomNumber(seed + '-value', 0xd800, 0xdbff + 1);
var right = utils.randomNumber(seed + '-value', 0xdc00, 0xdfff + 1);
return String.fromCharCode(left, right);
}
throw new Error('this should not happen');
}
function randomString(seed) {
var length = utils.randomNumber(seed + '-length', 1, 5);
var str = '';
for (var i = 0; i < length; i++) {
str += randomChar(seed + '-char-' + i);
}
return str;
}
for (var i = 0; i < 100000; i++) {
var seed = 'test-' + String(i);
var str = randomString(seed);
var bytes = ethers_1.ethers.utils.toUtf8Bytes(str);
var str2 = ethers_1.ethers.utils.toUtf8String(bytes);
Updated dist files.
2019-07-23 01:04:32 -03:00
var escaped = JSON.parse(ethers_1.ethers.utils._toEscapedUtf8String(bytes));
Updated dist files.
2019-05-14 18:48:48 -04:00
assert_1.default.ok(Buffer.from(str).equals(Buffer.from(bytes)), 'bytes not generated correctly - ' + bytes);
assert_1.default.equal(str2, str, 'conversion not reflexive - ' + bytes);
Updated dist files.
2019-07-23 01:04:32 -03:00
assert_1.default.equal(escaped, str, 'conversion not reflexive - ' + bytes);
Updated dist files.
2019-05-14 18:48:48 -04:00
}
});
});
describe('Test Bytes32String coder', function () {
// @TODO: a LOT more test cases; generated from Solidity
it("encodes an ens name", function () {
var str = "ricmoo.firefly.eth";
var bytes32 = ethers_1.ethers.utils.formatBytes32String(str);
var str2 = ethers_1.ethers.utils.parseBytes32String(bytes32);
assert_1.default.equal(bytes32, '0x7269636d6f6f2e66697265666c792e6574680000000000000000000000000000', 'formatted correctly');
assert_1.default.equal(str2, str, "parsed correctly");
});
});
describe('Test BigNumber', function () {
Updated dist files.
2020-04-23 23:35:39 -04:00
it("computes absolute values", function () {
Updated dist files.
2019-05-14 18:48:48 -04:00
function testAbs(test) {
var value = ethers_1.ethers.BigNumber.from(test.value);
var expected = ethers_1.ethers.BigNumber.from(test.expected);
assert_1.default.ok(value.abs().eq(expected), 'BigNumber.abs - ' + test.value);
}
[
{ value: "0x0", expected: "0x0" },
{ value: "-0x0", expected: "0x0" },
{ value: "0x5", expected: "0x5" },
{ value: "-0x5", expected: "0x5" },
{ value: "0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff", expected: "0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" },
{ value: "-0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff", expected: "0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" },
{ value: "0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff", expected: "0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" },
{ value: "-0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff", expected: "0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" },
].forEach(testAbs);
});
});
Updated dist files.
2019-08-02 02:10:58 -04:00
function getHex(value) {
return "0x" + Buffer.from(value).toString("hex");
}
describe("Test nameprep", function () {
var Tests = testcases_1.loadTests("nameprep");
Tests.forEach(function (test) {
Updated dist files.
2019-11-20 18:57:38 +09:00
// No RTL support yet... These will always fail
if ([
"Surrogate code U+DF42",
"Left-to-right mark U+200E",
"Deprecated U+202A",
"Language tagging character U+E0001",
"Bidi: RandALCat character U+05BE and LCat characters",
"Bidi: RandALCat character U+FD50 and LCat characters",
"Bidi: RandALCat without trailing RandALCat U+0627 U+0031"
].indexOf(test.comment) >= 0) {
return;
}
Updated dist files.
2019-08-02 02:10:58 -04:00
it(test.comment, function () {
var input = ethers_1.ethers.utils.toUtf8String(test.input);
if (test.output) {
var expected = ethers_1.ethers.utils.toUtf8String(test.output);
var actual = ethers_1.ethers.utils.nameprep(input);
assert_1.default.equal(actual, expected, "actual(\"" + getHex(actual) + "\") !== expected(\"" + getHex(expected) + "\")");
}
else {
var ok = true;
var reason = "";
try {
var actual = ethers_1.ethers.utils.nameprep(input);
console.log(actual);
reason = "should has thrown " + test.rc + " - actual(\"" + getHex(actual) + "\")";
ok = false;
}
catch (error) {
}
assert_1.default.ok(ok, reason);
}
});
});
});
Updated dist files.
2020-01-11 04:18:28 -05:00
describe("Test Signature Manipulation", function () {
var tests = testcases_1.loadTests("transactions");
tests.forEach(function (test) {
it("autofills partial signatures - " + test.name, function () {
var address = ethers_1.ethers.utils.getAddress(test.accountAddress);
var hash = ethers_1.ethers.utils.keccak256(test.unsignedTransaction);
var data = ethers_1.ethers.utils.RLP.decode(test.signedTransaction);
var s = data.pop(), r = data.pop(), v = parseInt(data.pop().substring(2), 16);
var sig = ethers_1.ethers.utils.splitSignature({ r: r, s: s, v: v });
{
var addr = ethers_1.ethers.utils.recoverAddress(hash, {
r: r, s: s, v: v
});
assert_1.default.equal(addr, address, "Using r, s and v");
}
{
var addr = ethers_1.ethers.utils.recoverAddress(hash, {
r: sig.r, _vs: sig._vs
});
assert_1.default.equal(addr, address, "Using r, _vs");
}
{
var addr = ethers_1.ethers.utils.recoverAddress(hash, {
r: sig.r, s: sig.s, recoveryParam: sig.recoveryParam
});
assert_1.default.equal(addr, address, "Using r, s and recoveryParam");
}
});
});
});
Reference in New Issue Copy Permalink