Skip to content

Commit

Permalink
doc(target_chains/starknet): add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Riateche committed Apr 23, 2024
1 parent b30604c commit c7883c8
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions target_chains/starknet/contracts/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit c7883c8

Please sign in to comment.