Skip to content

Commit

Permalink
chore: update outdated info in Readme files (#3830)
Browse files Browse the repository at this point in the history
  • Loading branch information
jmrossy authored May 21, 2024
1 parent 1c4cf44 commit 6971d8d
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 17 deletions.
2 changes: 1 addition & 1 deletion solidity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion typescript/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand Down
15 changes: 0 additions & 15 deletions typescript/sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

0 comments on commit 6971d8d

Please sign in to comment.