Skip to content

Commit

Permalink
docs: improve account-faucet's README (#146)
Browse files Browse the repository at this point in the history
  • Loading branch information
ShookLyngs authored Jul 11, 2022
1 parent 03360f6 commit 5357952
Showing 1 changed file with 29 additions and 13 deletions.
42 changes: 29 additions & 13 deletions scripts/account-faucet/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,44 @@
# Account-Faucet

## What is it?
Account-Faucet is a CLI tool to help you claim faucet to your Godwoken layer 2 accounts.
## What is this?
This is Account-Faucet, a CLI tool to claim faucet for your Godwoken layer 2 accounts.

You can pass a `CKB private key`, the CLI will automatically calculate the layer 2 deposit address, and then claim faucet to the address. Or you can pass your `ETH address`, the CLI will do the same thing for you.
## Why should I use it?
Originally, when you need to claim faucet to your Godwoken layer 2 wallet, you need to go through all these steps:
1. Go to [Faucet](https://faucet.nervos.org) page and claim faucet to your CKB account
2. Go to [Godwoken Bridge](https://testnet.bridge.godwoken.io/) and deposit CKB to your Godwoken layer 2 account

## Usage
Install dependencies
The steps above are fairly simple, but not so easy if you do it manually, every day.
With this CLI tool, you can actually finish the entire process in one command, which can save you a lot of time.

All you need to prepare is your `ETH address`, or your `CKB private key`.

## Ready
1. Go to `Account-Faucet` folder in `Godwoken-Tests`:
```bash
$ npm install
$ cd scripts/account-faucet
```
Claim faucet, using your `CKB Layer 1 Private Key`
2. Install dependencies:
```bash
$ npm run faucet -- claim -p <CKB_PRIVATE_KEY>
$ npm install
```
Claim faucet, using your `ETH Address`

## Claim faucet

### Claim with ETH Address
If you're more familiar with your `ETH address`, we recommend you to use this command:
```bash
$ npm run faucet -- claim -e <ETH_ADDRESS>
```
When Claiming with `ETH Address`, you can also pass your `CKB Address`

### Claim with CKB Private Key
If you prefer to claim faucet with your `CKB Layer 1 Private Key`:
```bash
$ npm run faucet -- claim -e <ETH_ADDRESS> - c <CKB_ADDRESS>
$ npm run faucet -- claim -p <CKB_PRIVATE_KEY>
```
For more options, you can check for help

### Other command options
For more options, you can check with the `--help` command:
```bash
$ npm run faucet -- -h
$ npm run faucet -- claim -h
```

0 comments on commit 5357952

Please sign in to comment.