pyth-crosschain/ethereum/README.md

37 lines
1.3 KiB
Markdown
Raw Normal View History

# Pyth Ethereum Contract
2020-08-06 04:38:25 -07:00
This directory contains The Pyth contract on Ethereum and utilities to deploy it in EVM chains.
2020-08-06 04:38:25 -07:00
## Installation
2020-08-06 04:38:25 -07:00
Run the following command to install required dependencies for the contract:
2020-08-06 04:38:25 -07:00
```
# xc-governance-sdk-js is a local dependency that should be built
# it is used in deployment (truffle migrations) to generate/sanity check
# the governance VAAs
pushd third_party/pyth/xc-governance-sdk-js && npm ci && popd
npm ci
```
2020-08-06 04:38:25 -07:00
## Deployment
Please refer to [Deploying.md](./Deploying.md) for more information.
2020-08-06 04:38:25 -07:00
## Foundry
2020-08-06 04:38:25 -07:00
Foundry can be installed by the official installer, or by running our helper script which will automatically pull the correct installation script individually for Foundry and the Solidity compiler for your current OS. This may work better if you are running into networking/firewall issues using Foundry's Solidity installer. To use helper script, run the command below from this directory:
2020-08-06 04:38:25 -07:00
``` sh
pyth-crosschain/ethereum $ bash ../scripts/install-foundry.sh
```
2020-08-06 04:38:25 -07:00
You need to install npm dependencies as described in [Installation](#installation). Also, you need to run the following
command to install forge dependencies:
2020-08-06 14:32:31 -07:00
```
npm run install-forge-deps
```
2020-08-06 14:32:31 -07:00
After installing the dependencies. Run `forge build` to build the contracts and `forge test` to
test the contracts using tests in `forge-test` directory.