From 6971d8da0201d194d2410e3f71036366bc049fbb Mon Sep 17 00:00:00 2001 From: J M Rossy Date: Tue, 21 May 2024 13:55:25 -0400 Subject: [PATCH] chore: update outdated info in Readme files (#3830) --- solidity/README.md | 2 +- typescript/cli/README.md | 2 +- typescript/sdk/README.md | 15 --------------- 3 files changed, 2 insertions(+), 17 deletions(-) diff --git a/solidity/README.md b/solidity/README.md index d800b4a1c..041d45fa6 100644 --- a/solidity/README.md +++ b/solidity/README.md @@ -28,7 +28,7 @@ yarn test ### Fixtures -Some forge tests may generate fixtures in the [fixtures](./fixtures/) directory. This allows [SDK](../typescript/sdk) tests to leverage forge fuzzing. These are git ignored and should not be committed. +Some forge tests may generate fixtures. This allows the [SDK](https://github.com/hyperlane-xyz/hyperlane-monorepo/tree/main/typescript/sdk) tests to leverage forge fuzzing. These are git ignored and should not be committed. ## License diff --git a/typescript/cli/README.md b/typescript/cli/README.md index 20fe12cda..8493414cd 100644 --- a/typescript/cli/README.md +++ b/typescript/cli/README.md @@ -12,7 +12,7 @@ To read more about interchain applications, how the protocol works, and how to i ## Setup -Node 16 or newer is required. +Node 18 or newer is required. **Option 1: Global install:** diff --git a/typescript/sdk/README.md b/typescript/sdk/README.md index 4c704aa12..d662581f0 100644 --- a/typescript/sdk/README.md +++ b/typescript/sdk/README.md @@ -18,12 +18,6 @@ Note, this package uses [ESM Modules](https://gist.github.com/sindresorhus/a3978 ## Contents -### Constants - -The names and relevant metadata for all Hyperlane-supported chains are included in this SDK, including public RPC and Explorer urls. It also includes the addresses for all Hyperlane core contracts and middleware. - -### Classes for development, deployment, and testing - The SDK includes various classes for building, deploying, and testing multi-chain applications. Different abstractions serve different use cases. A few common utilities include: - `MultiProvider` / `MultiProtocolProvider`: A utility for managing chain metadata, and RPC providers. @@ -32,15 +26,6 @@ The SDK includes various classes for building, deploying, and testing multi-chai - `HyperlaneDeployer`: The base class for executing multi-chain contract deployments. - `Token` & `WarpCore`: Utilities for interacting with Warp Route deployments. -### Chain Logos - -The SDK contains SVG files for all Hyperlane-supported chains. They can be imported from the `/logos` folder. - -```js -import ArbitrumBlack from '@hyperlane-xyz/sdk/logos/black/arbitrum.svg'; -import ArbitrumColor from '@hyperlane-xyz/sdk/logos/color/arbitrum.svg'; -``` - ## License Apache 2.0