From 1b4b80b9dc9b5769f41429bd683c95906e72636e Mon Sep 17 00:00:00 2001 From: Bengt Lofgren Date: Tue, 4 Feb 2025 10:59:51 +0000 Subject: [PATCH 1/2] README setup instructions improved --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 3c39548f..70f95614 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,22 @@ git clone git@github.com: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 `npm run 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. From 7148b22673fb2c60dfdd9483125ab9a5474f2c31 Mon Sep 17 00:00:00 2001 From: Daniel Bloom Date: Tue, 18 Feb 2025 13:39:49 -0800 Subject: [PATCH 2/2] chore: README setup instructions further improved --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 70f95614..48739584 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ nvm use 20.18.2 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 `npm run build` *inside* the `evm` directory. Without this step, the typescript SDK will not be able to be interpreted by the typescript compiler. +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 @@ -34,7 +34,6 @@ Each directory represents Wormhole integrations for specific blockchain networks [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: @@ -61,4 +60,3 @@ import { import { PreparedOrder } from "@wormhole-foundation/example-liquidity-layer-solana/tokenRouter/state"; // ... ``` -