difftreelog
test(evm) add contract helpers
in: master
3 files changed
tests/src/eth/util/contractHelpersAbi.jsondiffbeforeafterboth--- /dev/null
+++ b/tests/src/eth/util/contractHelpersAbi.json
@@ -0,0 +1,142 @@
+[
+ {
+ "inputs": [
+ {
+ "internalType": "address",
+ "name": "contract",
+ "type": "address"
+ }
+ ],
+ "name": "allowlistEnabled",
+ "outputs": [
+ {
+ "internalType": "bool",
+ "name": "",
+ "type": "bool"
+ }
+ ],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
+ "inputs": [
+ {
+ "internalType": "address",
+ "name": "target",
+ "type": "address"
+ },
+ {
+ "internalType": "address",
+ "name": "caller",
+ "type": "address"
+ }
+ ],
+ "name": "allowed",
+ "outputs": [
+ {
+ "internalType": "bool",
+ "name": "",
+ "type": "bool"
+ }
+ ],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
+ "inputs": [
+ {
+ "internalType": "address",
+ "name": "target",
+ "type": "address"
+ }
+ ],
+ "name": "contractOwner",
+ "outputs": [
+ {
+ "internalType": "address",
+ "name": "",
+ "type": "address"
+ }
+ ],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
+ "inputs": [
+ {
+ "internalType": "address",
+ "name": "target",
+ "type": "address"
+ }
+ ],
+ "name": "sponsoringEnabled",
+ "outputs": [
+ {
+ "internalType": "bool",
+ "name": "",
+ "type": "bool"
+ }
+ ],
+ "stateMutability": "view",
+ "type": "function"
+ },
+ {
+ "inputs": [
+ {
+ "internalType": "address",
+ "name": "target",
+ "type": "address"
+ },
+ {
+ "internalType": "address",
+ "name": "user",
+ "type": "address"
+ },
+ {
+ "internalType": "bool",
+ "name": "isAllowed",
+ "type": "bool"
+ }
+ ],
+ "name": "toggleAllowed",
+ "outputs": [],
+ "stateMutability": "nonpayable",
+ "type": "function"
+ },
+ {
+ "inputs": [
+ {
+ "internalType": "address",
+ "name": "target",
+ "type": "address"
+ },
+ {
+ "internalType": "bool",
+ "name": "enabled",
+ "type": "bool"
+ }
+ ],
+ "name": "toggleAllowlist",
+ "outputs": [],
+ "stateMutability": "nonpayable",
+ "type": "function"
+ },
+ {
+ "inputs": [
+ {
+ "internalType": "address",
+ "name": "target",
+ "type": "address"
+ },
+ {
+ "internalType": "bool",
+ "name": "enabled",
+ "type": "bool"
+ }
+ ],
+ "name": "toggleSponsoring",
+ "outputs": [],
+ "stateMutability": "nonpayable",
+ "type": "function"
+ }
+]
\ No newline at end of file
tests/src/eth/util/helpers.d.tsdiffbeforeafterboth--- /dev/null
+++ b/tests/src/eth/util/helpers.d.ts
@@ -0,0 +1 @@
+declare module 'solc';
\ No newline at end of file
tests/src/eth/util/helpers.tsdiffbeforeafterboth1//2// This file is subject to the terms and conditions defined in3// file 'LICENSE', which is part of this source code package.4//56import { ApiPromise } from '@polkadot/api';7import { addressToEvm, evmToAddress } from '@polkadot/util-crypto';8import Web3 from 'web3';9import usingApi, { submitTransactionAsync } from '../../substrate/substrate-api';10import { IKeyringPair } from '@polkadot/types/types';11import { expect } from 'chai';12import { getGenericResult } from '../../util/helpers';1314let web3Connected = false;15export async function usingWeb3<T>(cb: (web3: Web3) => Promise<T> | T): Promise<T> {16 if (web3Connected) throw new Error('do not nest usingWeb3 calls');17 web3Connected = true;1819 const provider = new Web3.providers.WebsocketProvider(config.substrateUrl);20 const web3 = new Web3(provider);2122 try {23 return await cb(web3);24 } finally {25 // provider.disconnect(3000, 'normal disconnect');26 provider.connection.close();27 web3Connected = false;28 }29}3031export function collectionIdToAddress(address: number): string {32 if (address >= 0xffffffff || address < 0) throw new Error('id overflow');33 const buf = Buffer.from([0x17, 0xc4, 0xe6, 0x45, 0x3c, 0xc4, 0x9a, 0xaa, 0xae, 0xac, 0xa8, 0x94, 0xe6, 0xd9, 0x68, 0x3e,34 address >> 24,35 (address >> 16) & 0xff,36 (address >> 8) & 0xff,37 address & 0xff,38 ]);39 return Web3.utils.toChecksumAddress('0x' + buf.toString('hex'));40}4142export function createEthAccount(web3: Web3) {43 const account = web3.eth.accounts.create();44 web3.eth.accounts.wallet.add(account.privateKey);45 return account.address;46}4748export async function createEthAccountWithBalance(api: ApiPromise, web3: Web3) {49 const alice = privateKey('//Alice');50 const account = createEthAccount(web3);51 await transferBalanceToEth(api, alice, account);5253 return account;54}5556export async function transferBalanceToEth(api: ApiPromise, source: IKeyringPair, target: string, amount = 999999999999999) {57 const tx = api.tx.balances.transfer(evmToAddress(target), amount);58 const events = await submitTransactionAsync(source, tx);59 const result = getGenericResult(events);60 expect(result.success).to.be.true;61}6263export async function itWeb3(name: string, cb: (apis: { web3: Web3, api: ApiPromise }) => any, opts: { only?: boolean, skip?: boolean } = {}) {64 let i: any = it;65 if (opts.only) i = i.only;66 else if (opts.skip) i = i.skip;67 i(name, async () => {68 await usingApi(async api => {69 await usingWeb3(async web3 => {70 await cb({ api, web3 });71 });72 });73 });74}75itWeb3.only = (name: string, cb: (apis: { web3: Web3, api: ApiPromise }) => any) => itWeb3(name, cb, { only: true });76itWeb3.skip = (name: string, cb: (apis: { web3: Web3, api: ApiPromise }) => any) => itWeb3(name, cb, { skip: true });7778export async function generateSubstrateEthPair(web3: Web3) {79 const account = web3.eth.accounts.create();80 evmToAddress(account.address);81}8283type NormalizedEvent = {84 address: string,85 event: string,86 args: { [key: string]: string }87};8889export function normalizeEvents(events: any): NormalizedEvent[] {90 const output = [];91 for (const key of Object.keys(events)) {92 if (key.match(/^[0-9]+$/)) {93 output.push(events[key]);94 } else if (Array.isArray(events[key])) {95 output.push(...events[key]);96 } else {97 output.push(events[key]);98 }99 }100 output.sort((a, b) => a.logIndex - b.logIndex);101 return output.map(({ address, event, returnValues }) => {102 const args: { [key: string]: string } = {};103 for (const key of Object.keys(returnValues)) {104 if (!key.match(/^[0-9]+$/)) {105 args[key] = returnValues[key];106 }107 }108 return {109 address,110 event,111 args,112 };113 });114}115116export async function recordEvents(contract: any, action: () => Promise<void>): Promise<NormalizedEvent[]> {117 const out: any = [];118 contract.events.allEvents((_: any, event: any) => {119 out.push(event);120 });121 await action();122 return normalizeEvents(out);123}124125export function subToEth(eth: string): string {126 const bytes = addressToEvm(eth);127 const string = '0x' + Buffer.from(bytes).toString('hex');128 return Web3.utils.toChecksumAddress(string);129}1//2// This file is subject to the terms and conditions defined in3// file 'LICENSE', which is part of this source code package.4//56// eslint-disable-next-line @typescript-eslint/triple-slash-reference7/// <reference path="helpers.d.ts" />89import { ApiPromise } from '@polkadot/api';10import { addressToEvm, evmToAddress } from '@polkadot/util-crypto';11import Web3 from 'web3';12import usingApi, { submitTransactionAsync } from '../../substrate/substrate-api';13import { IKeyringPair } from '@polkadot/types/types';14import { expect } from 'chai';15import { getGenericResult } from '../../util/helpers';16import * as solc from 'solc';17import config from '../../config';18import privateKey from '../../substrate/privateKey';19import contractHelpersAbi from './contractHelpersAbi.json';2021export const GAS_ARGS = { gas: 0x10000000, gasPrice: '0x01' };2223let web3Connected = false;24export async function usingWeb3<T>(cb: (web3: Web3) => Promise<T> | T): Promise<T> {25 if (web3Connected) throw new Error('do not nest usingWeb3 calls');26 web3Connected = true;2728 const provider = new Web3.providers.WebsocketProvider(config.substrateUrl);29 const web3 = new Web3(provider);3031 try {32 return await cb(web3);33 } finally {34 // provider.disconnect(3000, 'normal disconnect');35 provider.connection.close();36 web3Connected = false;37 }38}3940type Web3HttpMarker = {web3Http: true};4142export async function usingWeb3Http<T>(cb: (web3: Web3 & Web3HttpMarker) => Promise<T> | T): Promise<T> {43 const provider = new Web3.providers.HttpProvider(config.frontierUrl);44 const web3: Web3 & Web3HttpMarker = new Web3(provider) as any;45 web3.web3Http = true;4647 return await cb(web3);48}4950export function collectionIdToAddress(address: number): string {51 if (address >= 0xffffffff || address < 0) throw new Error('id overflow');52 const buf = Buffer.from([0x17, 0xc4, 0xe6, 0x45, 0x3c, 0xc4, 0x9a, 0xaa, 0xae, 0xac, 0xa8, 0x94, 0xe6, 0xd9, 0x68, 0x3e,53 address >> 24,54 (address >> 16) & 0xff,55 (address >> 8) & 0xff,56 address & 0xff,57 ]);58 return Web3.utils.toChecksumAddress('0x' + buf.toString('hex'));59}6061export function createEthAccount(web3: Web3) {62 const account = web3.eth.accounts.create();63 web3.eth.accounts.wallet.add(account.privateKey);64 return account.address;65}6667export async function createEthAccountWithBalance(api: ApiPromise, web3: Web3) {68 const alice = privateKey('//Alice');69 const account = createEthAccount(web3);70 await transferBalanceToEth(api, alice, account);7172 return account;73}7475export async function transferBalanceToEth(api: ApiPromise, source: IKeyringPair, target: string, amount = 999999999999999) {76 const tx = api.tx.balances.transfer(evmToAddress(target), amount);77 const events = await submitTransactionAsync(source, tx);78 const result = getGenericResult(events);79 expect(result.success).to.be.true;80}8182export async function itWeb3(name: string, cb: (apis: { web3: Web3, api: ApiPromise }) => any, opts: { only?: boolean, skip?: boolean } = {}) {83 let i: any = it;84 if (opts.only) i = i.only;85 else if (opts.skip) i = i.skip;86 i(name, async () => {87 await usingApi(async api => {88 await usingWeb3(async web3 => {89 await cb({ api, web3 });90 });91 });92 });93}94itWeb3.only = (name: string, cb: (apis: { web3: Web3, api: ApiPromise }) => any) => itWeb3(name, cb, { only: true });95itWeb3.skip = (name: string, cb: (apis: { web3: Web3, api: ApiPromise }) => any) => itWeb3(name, cb, { skip: true });9697export async function generateSubstrateEthPair(web3: Web3) {98 const account = web3.eth.accounts.create();99 evmToAddress(account.address);100}101102type NormalizedEvent = {103 address: string,104 event: string,105 args: { [key: string]: string }106};107108export function normalizeEvents(events: any): NormalizedEvent[] {109 const output = [];110 for (const key of Object.keys(events)) {111 if (key.match(/^[0-9]+$/)) {112 output.push(events[key]);113 } else if (Array.isArray(events[key])) {114 output.push(...events[key]);115 } else {116 output.push(events[key]);117 }118 }119 output.sort((a, b) => a.logIndex - b.logIndex);120 return output.map(({ address, event, returnValues }) => {121 const args: { [key: string]: string } = {};122 for (const key of Object.keys(returnValues)) {123 if (!key.match(/^[0-9]+$/)) {124 args[key] = returnValues[key];125 }126 }127 return {128 address,129 event,130 args,131 };132 });133}134135export async function recordEvents(contract: any, action: () => Promise<void>): Promise<NormalizedEvent[]> {136 const out: any = [];137 contract.events.allEvents((_: any, event: any) => {138 out.push(event);139 });140 await action();141 return normalizeEvents(out);142}143144export function subToEth(eth: string): string {145 const bytes = addressToEvm(eth);146 const string = '0x' + Buffer.from(bytes).toString('hex');147 return Web3.utils.toChecksumAddress(string);148}149150export function compileContract(name: string, src: string) {151 const out = JSON.parse(solc.compile(JSON.stringify({152 language: 'Solidity',153 sources: {154 [`${name}.sol`]: {155 content: `156 // SPDX-License-Identifier: UNLICENSED157 pragma solidity ^0.8.6;158159 ${src}160 `,161 },162 },163 settings: {164 outputSelection: {165 '*': {166 '*': ['*'],167 },168 },169 },170 }))).contracts[`${name}.sol`][name];171172 return {173 abi: out.abi,174 object: '0x' + out.evm.bytecode.object,175 };176}177178export async function deployFlipper(web3: Web3 & Web3HttpMarker, deployer: string) {179 const compiled = compileContract('Flipper', `180 contract Flipper {181 bool value = false;182 function flip() public {183 value = !value;184 }185 function getValue() public view returns (bool) {186 return value;187 }188 }189 `);190 const Flipper = new web3.eth.Contract(compiled.abi, undefined, {191 data: compiled.object,192 from: deployer,193 ...GAS_ARGS,194 });195 const flipper = await Flipper.deploy({ data: compiled.object }).send({from: deployer});196197 return flipper;198}199200export async function deployCollector(web3: Web3 & Web3HttpMarker, deployer: string) {201 const compiled = compileContract('Collector', `202 contract Collector {203 uint256 collected;204 function giveMoney() public payable {205 collected += msg.value;206 }207 function getCollected() public view returns (uint256) {208 return collected;209 }210 }211 `);212 const Collector = new web3.eth.Contract(compiled.abi, undefined, {213 data: compiled.object,214 from: deployer,215 ...GAS_ARGS,216 });217 const collector = await Collector.deploy({ data: compiled.object }).send({ from: deployer });218219 return collector;220}221222export function contractHelpers(web3: Web3, caller: string) {223 return new web3.eth.Contract(contractHelpersAbi as any, '0x842899ECF380553E8a4de75bF534cdf6fBF64049', {from: caller, ...GAS_ARGS});224}