Skip to content

chore: README setup instructions further improved #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore: README setup instructions further improved #6

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b4b80b
README setup instructions improved
Feb 4, 2025
6078aea
Merge pull request #5 from wormholelabs-xyz/dbloom/update-readme
Daniel-Aaron-Bloom Feb 18, 2025
7148b22
chore: README setup instructions further improved
Daniel-Aaron-Bloom Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,28 @@ git clone [email protected]:wormhole-foundation/example-liquidity-layer.git --recur

## Prerequisites

### Node version

It is recommended to use `Node v20.18.x`.

```bash
# E.g.
nvm install 20.18.2
nvm use 20.18.2
```

### EVM

Install [Foundry tools](https://book.getfoundry.sh/getting-started/installation), which include `forge`, `anvil` and `cast` CLI tools.

Before using the typescript SDK, build the evm types by running `make build` _inside_ the `evm` directory. Without this step, the typescript SDK will not be able to be interpreted by the typescript compiler.

## Build, Test and Deploy Smart Contracts

Each directory represents Wormhole integrations for specific blockchain networks. Please navigate to a network subdirectory to see more details (see the relevant README.md) on building, testing and deploying the smart contracts.

[Wormhole Circle Integration]: https://github.com/wormhole-foundation/wormhole-circle-integration/blob/main/DESIGN.md


### Typescript SDK

To use the Typescript SDK, at the root of this repository, run:
Expand All @@ -49,4 +60,3 @@ import {
import { PreparedOrder } from "@wormhole-foundation/example-liquidity-layer-solana/tokenRouter/state";
// ...
```