blockworks-foundation
/
pyth-crosschain
mirror of https://github.com/blockworks-foundation/pyth-crosschain.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc(target_chains/starknet): add readme

This commit is contained in:
Pavel Strakhov 2024-04-23 12:11:03 +01:00
parent b30604c5ba
commit c7883c822b
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
target_chains/starknet/contracts/README.md Normal file
View File

@ -0,0 +1,20 @@
# Pyth Starknet Contract
This directory contains the Pyth contract on [Starknet](https://www.starknet.io/).
## Installation
1. Install Scarb (the Cairo and Starknet development toolchain) by following [the installation instructions](https://docs.swmansion.com/scarb/download).
2. Install Starknet Foundry by following [the installation instructions](https://foundry-rs.github.io/starknet-foundry/getting-started/installation.html).
The `.tool-versions` file in this directory specifies the tool versions used by the contract.
## Testing
Run `snforge test` in this directory to run the contract unit tests and integration tests.
## Local deployment
1. Install Starkli (a cli tool for Starknet) by following [the installation instructions](https://github.com/xJonathanLEI/starkli).
2. Install Katana (a local Starknet node) by following [the installation instructions](https://book.starknet.io/ch02-04-katana.html).
3. Run the `deploy/local_deploy` setup script.