@tableland/evm

Tableland Tables EVM contracts and client components

Table of Contents

• Background
• Development
• Contributing
• License

Background

This is the Tableland Tables EVM contracts and client components.

Currently supported chains

Chain	Chain ID	Contract
Ethereum	1	0x012969f7e3439a9B04025b5a049EB9BAD82A8C12
Optimism	10	0xfad44BF5B843dE943a09D4f3E84949A11d3aa3e6
Polygon	137	0x5c4e6A9e5C1e1BF445A062006faF19EA6c49aFeA
Goerli	5	0xDA8EA22d092307874f30A1F277D1388dca0BA97a
Optimism Kovan	69	0xf2C9Fc73884A9c6e6Db58778176Ab67989139D06
Optimism Goerli	420	0xC72E8a7Be04f2469f8C2dB3F1BdF69A7D516aBbA
Arbitrum Goerli	421613	0x033f69e8d119205089Ab15D340F5b797732f646b
Polygon Mumbai	80001	0x4b48841d4b32C4650E4ABc117A03FE8B51f38F68

Development

Building the client

You can build the Typescript client locally:

npm install
npx hardhat compile
npm run build

Testing

Run the test suite:

npm test

Test with gas reporting:

REPORT_GAS=true npx hardhat test

Deploying

Deployments are handled on a per-network basis:

npx hardhat run scripts/deploy.ts --network optimism

Network names may include context for the target Tableland network:

npx hardhat run scripts/deploy.ts --network optimism-kovan-staging

Where optimism-kovan-staging indicates a deployment to the Optimism Kovan testnet for the Tableland staging network.

Refer to the proxies entry in hardhat.config.js for the list of current deployments.

Upgrading

The Tableland contracts are currently upgradeable at this early stage of development. Upgrades are handled much like deployments:

npx hardhat run scripts/upgrade.ts --network optimism

Upgrading on a network only works if a previous deployment already exists, referenced by a corresponding proxy address in the proxies entry in hardhat.config.js.

Extacting the ABI and Bytecode

You can you grab the assets you need by compiling and then using some jq magic:

ABI

cat artifacts/contracts/TablelandTables.sol/TablelandTables.json | jq '.abi' > abi.json

Bytecode

cat artifacts/contracts/TablelandTables.sol/TablelandTables.json | jq -r '.bytecode' > bytecode.bin

Generate the Go client!

You can use the above abi.json to build the Go client:

mkdir gobuild
abigen --abi ./abi.json --bin ./bytecode.bin --pkg contracts --out gobuild/Registry.go

Etherscan verification

To perform Etherscan verification, you first need to deploy a contract to an Ethereum network that's supported by Etherscan, such as Goerli:

npx hardhat run scripts/deploy.ts --network ethereum-goerli

Then, copy the deployment address and paste it in to replace DEPLOYED_CONTRACT_ADDRESS in this command:

npx hardhat verify DEPLOYED_CONTRACT_ADDRESS --network ethereum-goerli

Speedier tests

For faster runs of your tests and scripts, consider skipping ts-node's type checking by setting the environment variable TS_NODE_TRANSPILE_ONLY to 1 in hardhat's environment. For more details see the documentation.

Contributing

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT AND Apache-2.0, © 2021-2022 Tableland Network Contributors