Copy .env.example into .env.
Update the configuration and install dependencies.
npm installDon't forget to install and apply workspace VS Code extensions and settings.
Public data about smart contract deployments is available in /deployments/<network>/<contract-name>.json files and conform to the following interface:
interface Deployment {
address: Address;
abi: ABI;
receipt?: Receipt;
transactionHash?: string;
history?: Deployment[];
numDeployments?: number;
implementation?: string;
args: any[];
linkedData?: any;
solcInputHash: string;
metadata: string;
bytecode: string;
deployedBytecode: string;
libraries?: Libraries;
userdoc: any;
devdoc: any;
methodIdentifiers?: any;
diamondCut?: FacetCut[];
facets?: Facet[];
storageLayout: any;
gasEstimates?: any;
}Moreover, each /deployments/<network> folder contains .chainId file with the id of a corresponding network. This data alongside with contract abi and bytecode can be useful for external applications.
In order to interact with smart contracts from golang, go bindings are needed. These are basically all smart contract public fields, structs, events and functions transpiled to golang, which can be invoked from go code and will interact with blockchain right away.
Go bindings are generated with abigen tool. The functionality of resulting bindings depends on the data you supplied to abigen.
We encourage you to provide a combined source of data, called 'standart json', which comprises contract abi and bytecode.This will additionaly allow the developer to deploy smart contracts from the back-end.
'standart json' can be obtained with solc - solidity compiler.
(excerpt from official Solidity documentation. Other download methods are described there)
Latest Ubuntu stable version is available using the following commands:
sudo add-apt-repository ppa:ethereum/ethereum
sudo apt-get update
sudo apt-get install solcFurthermore, some Linux distributions provide their own packages.
For example, Arch Linux has packages for the latest development version:
pacman -S solidityThere is also a snap package, however, it is currently unmaintained. It is installable in all the supported Linux distros. To install the latest stable version of solc:
sudo snap install solcSolidity compiler is also distributed through Homebrew as a build-from-source version. Pre-built bottles are currently not supported.
brew update
brew upgrade
brew tap ethereum/ethereum
brew install solidityTo install the most recent 0.4.x / 0.5.x version of Solidity you can also use brew install solidity@4 and brew install solidity@5, respectively.
If you need a specific version of Solidity you can install a Homebrew formula directly from Github.
View solidity.rb commits on Github.
Copy the commit hash of the version you want and check it out on your machine.
git clone <https://github.com/ethereum/homebrew-ethereum.git>
cd homebrew-ethereum
git checkout <your-hash-goes-here>Install it using brew:
brew unlink solidity
# eg. Install 0.4.8
brew install solidity.rbDownload prebuilt binary file corresponding to your OS at a desirable version from solidity/releases page.
solc-select is a tool to quickly switch between Solidity compiler versions.
Install with
pip3 install solc-selectMore documentation is available on plugin's GitHub repository.
(excerpt from official geth installation documentation. Other download methods are described there) Other download methods are available.
Note: These commands install the core Geth software and the following developer tools:
clef,devp2p,abigen,bootnode,evm,rlpdumpandpuppeth. The binaries for each of these tools are saved in/usr/bin/.
The easiest way to install Geth on Ubuntu-based distributions is with the built-in launchpad PPAs (Personal Package Archives). The following command enables the built-in launchpad repository:
sudo add-apt-repository -y ppa:ethereum/ethereumThen, to install the stable version of go-ethereum:
sudo apt-get update
sudo apt-get install ethereumAlso available on Arch linux from pacman:
pacman -S gethNote: These commands install the core Geth software and the following developer tools:
clef,devp2p,abigen,bootnode,evm,rlpdumpandpuppeth. The binaries for each of these tools are saved in/usr/bin/.
brew tap ethereum/ethereum
brew install ethereumDownload prebuild binary corresponding to your OS at a desirable version from official Download Geth website;
We use make to execute scripts to generate go bindings, so make sure it is installed.
Required packages: curl, tar, solc, abigen.
Run locally (on the host machine) installed solc and abigen.
npm run bindings:localIf you need to generate go bindings frequently, we encourage you to install
solcandabigenon your machine.
Required packages: curl, tar.
Install solc and abigen to ./cache folder, and use them generate bindings.
npm run bindings:[linux | macos]Required packages: curl, tar.
solc and abigen must be installed to ./cache folder. Use solc and abigen from ./cache to generate bindings.
npm run bindings:cacheRequired packages: docker.
Use this method if you don't want any files added, except for the bindings. Run a docker container, which installs solc and abigen, generate bindings and copy them to host machine.
Note: it takes approximately 100 seconds to build container the first time, so be patient.
npm run bindings:dockerDocumentation of smart contract API and system architecture is available at /docs.
BE and FE interactions with smart contracts are described in /docs/api.
npx hardhat compileAlongside with generating artifacts (abi + bytecode, stored in ./artifacts), this script creates typescript types (stored in ./typechain).
To start local hardhat node available at http://127.0.0.1:8545.
You can connect further hardhat calls to this node by providing --network localhost parameter to the commands.
npm run node:localSmart contracts are deployed via hardhat-deploy plugin, deploy scripts are stored in ./deploy and deployment information is stored to ./deployments (see more).
If you want to deploy specific contract(s), you need to specify deploy scripts tag(s) (can be found at the bottom of the script, e.g. func.tags = ['clearing'];) via --tags flag.
Moreover, you can specify the network you want to deploy contract(s) to via --network flag.
List of supported networks is described in hardhat.config.ts.
Note: Some scripts require specific ENV variables to be provided, so make sure you have read the script before running it.
[script-variables] npx hardhat deploy [--tags <deploy-script-tags,...>] [--network <network>]If you need to deploy a contract without a script present in ./deploy, you can use generalized deploy script present in ./scripts:
[CONTRACT=<name> CONTRACT_ARGS=<args,sep,by,comma>] npx hardat run scripts/deploy-contract.ts [--network <network>]The same applies for upgradability deployments:
[CONTRACT=<name> CONTRACT_ARGS=<args,sep,by,comma>] npx hardat run scripts/deploy-upgradable-contract.ts [--network <network>]And upgrade with
[CONTRACT=<name> IMPL_ADDRESS=<new_impl_address>] npx hardat run scripts/upgrade-contract.ts [--network <network>]npm run YN:localThis deploys YellowClearing, VaultImpl and connected VaultProxy to it. Addresses of deployed contracts are exported to ./local-YN-addresses.json.
Deployers of aforementioned contracts, Broker and CoSigner are respectifully [0:5] local hardhat node addresses.
Note: Original
VaultProxycontract requires hardcodedVaultImpladdress, which is impossible to do by scripts. Therefore, this script deploys test version ofVaultProxy(which acceptsVaultImpladdress as a constructor parameter) and has different abi and bytecode.
Scripts are located in ./scripts folder and are used to interact with the contracts.
Note: before running a script make sure you know what ENV variables it expects to be set.
[ENV=<val>] npx hardhat run scripts/path.to.script.ts [--network <network>]If you set mnemonics in hardhat.config.ts or have a mnemonic addresses of which you want to know, run
[MNEMONIC=<mnemonic>] npm run export-accountsThis script generates accounts addresses and private keys to ./hardhat-accounts.json.
If you have deployed the contract with the help of deploy scripts, some deployments data is saved to ./deployments (see more).
This data can be used to verify these contracts:
npx hardhat etherscan-verify --network <network> [--contract-name <specific-contract-name>]See more with
npx hardhat help etherscan-verifyNevertheless, if you have deployed the contract with simple scripts (not hardhat-deploy) or certain contract deployment information in ./deployments is lost, you can use
npx hardhat verify --network <network> <address to verify>See more with
npx hardhat help verifyTo run linter to see errors use
npx run lintIf you want linter to fix all autofixable errors use
npx run lint:fixYou can generate contracts documentation with
npm run docsThis will rewrite docs to ./docs/api and put table of contents to all other .md files.
Test everything:
npx hardhat testTo test specific file:
npx hardhat test test/path.to.file.spec.tsTo generate test coverage files use
npx hardhat coverageThis will write contracts test coverate in html page format to ./coverage folder. Moveover, ./coverage.json containing all coverage information will be created.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent