certusone
/
trustless-generic-relayer
mirror of https://github.com/certusone/trustless-generic-relayer.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

README file for ts tooling

This commit is contained in:
chase-45 2023-01-07 14:58:16 -05:00 committed by Joe Howarth
parent 7005533a23
commit e2dbc6f5f5
1 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
ethereum/ts-scripts/README.md Normal file
View File

@ -0,0 +1,39 @@
# How to use these scripts
## Configuration
Private keys should be placed in a .env file corresponding to the Environment you intend to work in. For example, tilt private keys should be kept in ./.env.tilt
If you do not set an environment, the 'default' environment will be used, and .env will be read.
All other configuration is done through files in the ./config/${env} directory.
./config/${env}/chains.json is the file which controls how many chains will be executed against, as well as their RPC and basic info.
./config/${env}/contracts.json is the file which allows you to target specific contracts on each chain.
./config/${env}/scriptConfigs contains custom configurations for individual scripts. Not all scripts have custom arguments.
## Running the scripts
All files in the coreRelayer, relayProvider, and MockIntegration directories are runnable.
The target environment must be passed in as an environment variable. So, for example, you can run the RelayProvider deployment script by running:
```
ENV=tilt ts-node ./ts-scripts/relayProvider/deployRelayProvider.ts
```
## Chaining multiple scripts
Scripts are meant to be run individually or successively. Scripts which deploy contracts will write the deployed addresses into the ./output folder.
If "useLastRun" is set to true in the contracts.json configuration file, the lastrun files from the deployment scripts will be used, rather than the deployed addresses of the contracts.json file. This allows you to easily run things like
```
ENV=tilt ts-node ./ts-scripts/relayProvider/upgradeRelayProvider.ts && ts-node ./ts-scripts/mockIntegration/messageTest.ts
```
The ./shell directory contains shell scripts which combine commonly chained actions together.
For example, ./shell/deployConfigureTest.sh will deploy the RelayProvider, CoreRelayer, and MockIntegration contracts. Configure them all to point at eachother, and then run messageTest to test that everything worked. Note: useLastRun in contracts.json needs to be set to "true" in order for this script to work.