Make the command more approachbable (#35)

* Make the command more approachbable

* Update Readme

* updated warp api link

---------

Co-authored-by: Anett <44020788+anettrolikova@users.noreply.github.com>
pull/2435/head
Nam Chu Hoai 2 years ago committed by GitHub
parent d952989070
commit 3b6b95b5d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 14
      README.md
  2. 3
      package.json

@ -1,6 +1,6 @@
# Interchain tokens using Hyperlane
# Hyperlane Warp Route
This repo showcases a Hyperlane ERC20 and ERC721 tokens (HypERC20 and HypERC721). These tokens extend the base standards with an additional `transferRemote` function.
This repo contains the base Hyperlane ERC20 and ERC721 tokens (HypERC20 and HypERC721). These tokens extend the base standards with an additional `transferRemote` function. Warp Routes are way of arranging these contracts to make existing assets interchain. Read more about Warp Routes and how to deploy your own at [Warp API docs](https://docs.hyperlane.xyz/docs/developers/warp-api).
```mermaid
%%{init: {'theme':'base'}}%%
@ -30,7 +30,7 @@ graph TB
HYP_P-.->Bob
```
## Setup
## Setup for local development
```sh
# Install dependencies
@ -40,14 +40,8 @@ yarn
yarn build:dev
```
### (Optional) Using local core contracts
```sh
# yarn link does not work well with workspaces
ln -s ~/path/to/monorepo/solidity node_modules/@hyperlane-xyz/core
```
## Test
## Unit testing
```sh
# Run all unit tests

@ -56,7 +56,8 @@
"coverage": "hardhat coverage",
"lint": "eslint . --ext .ts",
"prettier": "prettier --write ./contracts ./test",
"test": "hardhat test ./test/*.test.ts"
"test": "hardhat test ./test/*.test.ts",
"deploy-warp-route": "DEBUG=* ts-node scripts/deploy"
},
"types": "dist/index.d.ts"
}

Loading…
Cancel
Save