Skip to content

Commit c7883c8

Browse files
committed
doc(target_chains/starknet): add readme
1 parent b30604c commit c7883c8

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Pyth Starknet Contract
2+
3+
This directory contains the Pyth contract on [Starknet](https://www.starknet.io/).
4+
5+
## Installation
6+
7+
1. Install Scarb (the Cairo and Starknet development toolchain) by following [the installation instructions](https://docs.swmansion.com/scarb/download).
8+
2. Install Starknet Foundry by following [the installation instructions](https://foundry-rs.github.io/starknet-foundry/getting-started/installation.html).
9+
10+
The `.tool-versions` file in this directory specifies the tool versions used by the contract.
11+
12+
## Testing
13+
14+
Run `snforge test` in this directory to run the contract unit tests and integration tests.
15+
16+
## Local deployment
17+
18+
1. Install Starkli (a cli tool for Starknet) by following [the installation instructions](https://github.com/xJonathanLEI/starkli).
19+
2. Install Katana (a local Starknet node) by following [the installation instructions](https://book.starknet.io/ch02-04-katana.html).
20+
3. Run the `deploy/local_deploy` setup script.

0 commit comments

Comments
 (0)