chore: update outdated info in Readme files (#3830)

pull/3840/head
J M Rossy 6 months ago committed by GitHub
parent 1c4cf44c91
commit 6971d8da02
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 2
      solidity/README.md
  2. 2
      typescript/cli/README.md
  3. 15
      typescript/sdk/README.md

@ -28,7 +28,7 @@ yarn test
### Fixtures ### 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 ## License

@ -12,7 +12,7 @@ To read more about interchain applications, how the protocol works, and how to i
## Setup ## Setup
Node 16 or newer is required. Node 18 or newer is required.
**Option 1: Global install:** **Option 1: Global install:**

@ -18,12 +18,6 @@ Note, this package uses [ESM Modules](https://gist.github.com/sindresorhus/a3978
## Contents ## 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: 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. - `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. - `HyperlaneDeployer`: The base class for executing multi-chain contract deployments.
- `Token` & `WarpCore`: Utilities for interacting with Warp Route 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 ## License
Apache 2.0 Apache 2.0

Loading…
Cancel
Save