aave-protocol-v2/helpers/contracts-helpers.ts

215 lines
6.4 KiB
TypeScript
Raw Normal View History

2020-07-13 08:54:08 +00:00
import {Contract, Signer, utils, ethers} from 'ethers';
import {signTypedData_v4} from 'eth-sig-util';
import {fromRpcSig, ECDSASignature} from 'ethereumjs-util';
import BigNumber from 'bignumber.js';
2020-10-21 09:42:27 +00:00
import {getDb, BRE, waitForTx} from './misc-utils';
import {
tEthereumAddress,
eContractid,
tStringTokenSmallUnits,
eEthereumNetwork,
AavePools,
iParamsPerNetwork,
iParamsPerPool,
2020-07-13 08:54:08 +00:00
} from './types';
import {MintableErc20 as MintableERC20} from '../types/MintableErc20';
2020-07-13 08:54:08 +00:00
import {Artifact} from '@nomiclabs/buidler/types';
2020-08-20 15:38:57 +00:00
import {verifyContract} from './etherscan-verification';
import {getIErc20Detailed} from './contracts-getters';
2020-08-25 12:15:35 +00:00
export type MockTokenMap = {[symbol: string]: MintableERC20};
2020-07-13 08:54:08 +00:00
export const registerContractInJsonDb = async (contractId: string, contractInstance: Contract) => {
2020-05-29 14:55:31 +00:00
const currentNetwork = BRE.network.name;
if (currentNetwork !== 'buidlerevm' && !currentNetwork.includes('coverage')) {
2020-05-29 14:55:31 +00:00
console.log(`*** ${contractId} ***\n`);
console.log(`Network: ${currentNetwork}`);
console.log(`tx: ${contractInstance.deployTransaction.hash}`);
console.log(`contract address: ${contractInstance.address}`);
console.log(`deployer address: ${contractInstance.deployTransaction.from}`);
console.log(`gas price: ${contractInstance.deployTransaction.gasPrice}`);
console.log(`gas used: ${contractInstance.deployTransaction.gasLimit}`);
console.log(`\n******`);
console.log();
}
await getDb()
.set(`${contractId}.${currentNetwork}`, {
address: contractInstance.address,
deployer: contractInstance.deployTransaction.from,
})
.write();
};
2020-07-13 08:54:08 +00:00
export const insertContractAddressInDb = async (id: eContractid, address: tEthereumAddress) =>
await getDb()
.set(`${id}.${BRE.network.name}`, {
address,
})
.write();
2020-05-29 14:55:31 +00:00
export const getEthersSigners = async (): Promise<Signer[]> =>
2020-08-19 12:23:41 +00:00
await Promise.all(await BRE.ethers.getSigners());
2020-05-29 14:55:31 +00:00
2020-07-13 08:54:08 +00:00
export const getEthersSignersAddresses = async (): Promise<tEthereumAddress[]> =>
2020-08-19 12:23:41 +00:00
await Promise.all((await BRE.ethers.getSigners()).map((signer) => signer.getAddress()));
2020-05-29 14:55:31 +00:00
export const getCurrentBlock = async () => {
return BRE.ethers.provider.getBlockNumber();
};
export const decodeAbiNumber = (data: string): number =>
2020-07-13 08:54:08 +00:00
parseInt(utils.defaultAbiCoder.decode(['uint256'], data).toString());
2020-05-29 14:55:31 +00:00
2020-08-10 18:20:08 +00:00
export const deployContract = async <ContractType extends Contract>(
2020-05-29 14:55:31 +00:00
contractName: string,
args: any[]
): Promise<ContractType> => {
2020-08-19 12:23:41 +00:00
const contract = (await (await BRE.ethers.getContractFactory(contractName)).deploy(
2020-05-29 14:55:31 +00:00
...args
)) as ContractType;
2020-10-21 09:42:27 +00:00
await waitForTx(contract.deployTransaction);
await registerContractInJsonDb(<eContractid>contractName, contract);
return contract;
};
export const withSaveAndVerify = async <ContractType extends Contract>(
instance: ContractType,
2020-10-15 17:19:02 +00:00
id: string,
args: (string | string[])[],
verify?: boolean
): Promise<ContractType> => {
2020-10-23 13:18:01 +00:00
await waitForTx(instance.deployTransaction);
2020-10-15 17:19:02 +00:00
await registerContractInJsonDb(id, instance);
if (verify) {
await verifyContract(id, instance.address, args);
}
return instance;
};
export const getContract = async <ContractType extends Contract>(
2020-05-29 14:55:31 +00:00
contractName: string,
address: string
2020-07-13 08:54:08 +00:00
): Promise<ContractType> => (await BRE.ethers.getContractAt(contractName, address)) as ContractType;
2020-05-29 14:55:31 +00:00
export const linkBytecode = (artifact: Artifact, libraries: any) => {
let bytecode = artifact.bytecode;
2020-07-13 08:54:08 +00:00
for (const [fileName, fileReferences] of Object.entries(artifact.linkReferences)) {
for (const [libName, fixups] of Object.entries(fileReferences)) {
const addr = libraries[libName];
if (addr === undefined) {
continue;
}
for (const fixup of fixups) {
bytecode =
bytecode.substr(0, 2 + fixup.start * 2) +
addr.substr(2) +
bytecode.substr(2 + (fixup.start + fixup.length) * 2);
}
}
}
return bytecode;
};
export const getParamPerNetwork = <T>(
2020-09-14 13:57:11 +00:00
{kovan, ropsten, main, buidlerevm, coverage}: iParamsPerNetwork<T>,
network: eEthereumNetwork
) => {
switch (network) {
2020-09-14 13:57:11 +00:00
case eEthereumNetwork.coverage:
return coverage;
case eEthereumNetwork.buidlerevm:
return buidlerevm;
case eEthereumNetwork.kovan:
return kovan;
case eEthereumNetwork.ropsten:
return ropsten;
case eEthereumNetwork.main:
return main;
default:
return main;
}
};
2020-07-13 08:54:08 +00:00
export const getParamPerPool = <T>({proto, secondary}: iParamsPerPool<T>, pool: AavePools) => {
switch (pool) {
case AavePools.proto:
return proto;
case AavePools.secondary:
return secondary;
default:
return proto;
}
};
2020-07-13 08:54:08 +00:00
export const convertToCurrencyDecimals = async (tokenAddress: tEthereumAddress, amount: string) => {
const token = await getIErc20Detailed(tokenAddress);
let decimals = (await token.decimals()).toString();
return ethers.utils.parseUnits(amount, decimals);
};
2020-07-13 08:54:08 +00:00
export const convertToCurrencyUnits = async (tokenAddress: string, amount: string) => {
const token = await getIErc20Detailed(tokenAddress);
let decimals = new BigNumber(await token.decimals());
const currencyUnit = new BigNumber(10).pow(decimals);
const amountInCurrencyUnits = new BigNumber(amount).div(currencyUnit);
return amountInCurrencyUnits.toFixed();
};
2020-09-14 13:57:11 +00:00
export const buildPermitParams = (
chainId: number,
token: tEthereumAddress,
revision: string,
tokenName: string,
owner: tEthereumAddress,
spender: tEthereumAddress,
nonce: number,
deadline: string,
value: tStringTokenSmallUnits
) => ({
types: {
EIP712Domain: [
2020-09-15 14:02:21 +00:00
{name: 'name', type: 'string'},
{name: 'version', type: 'string'},
{name: 'chainId', type: 'uint256'},
{name: 'verifyingContract', type: 'address'},
2020-09-14 13:57:11 +00:00
],
Permit: [
2020-09-15 14:02:21 +00:00
{name: 'owner', type: 'address'},
{name: 'spender', type: 'address'},
{name: 'value', type: 'uint256'},
{name: 'nonce', type: 'uint256'},
{name: 'deadline', type: 'uint256'},
2020-09-14 13:57:11 +00:00
],
},
2020-09-15 14:02:21 +00:00
primaryType: 'Permit' as const,
2020-09-14 13:57:11 +00:00
domain: {
name: tokenName,
version: revision,
chainId: chainId,
verifyingContract: token,
},
message: {
owner,
spender,
value,
nonce,
deadline,
},
});
export const getSignatureFromTypedData = (
privateKey: string,
typedData: any // TODO: should be TypedData, from eth-sig-utils, but TS doesn't accept it
): ECDSASignature => {
2020-09-15 14:02:21 +00:00
const signature = signTypedData_v4(Buffer.from(privateKey.substring(2, 66), 'hex'), {
data: typedData,
});
2020-09-14 13:57:11 +00:00
return fromRpcSig(signature);
2020-09-15 14:02:21 +00:00
};