Skip to content
This repository has been archived by the owner on Mar 24, 2023. It is now read-only.

Latest commit

 

History

History
169 lines (123 loc) · 5.28 KB

README.md

File metadata and controls

169 lines (123 loc) · 5.28 KB
Raw

Godwoken Web3 API

A Web3 RPC compatible layer build upon Godwoken/Polyjuice.

Checkout additional feature.

Development

Config database

$ cat > ./packages/api-server/.env <<EOF
DATABASE_URL=postgres://username:password@localhost:5432/your_db
REDIS_URL=redis://user:password@localhost:6379 <redis url, optional, default to localhost on port 6379>

GODWOKEN_JSON_RPC=<godwoken rpc>
GODWOKEN_READONLY_JSON_RPC=<optional, default equals to GODWOKEN_JSON_RPC>

SENTRY_DNS=<sentry dns, optional>
SENTRY_ENVIRONMENT=<sentry environment, optional, default to `development`>,
NEW_RELIC_LICENSE_KEY=<new relic license key, optional>
NEW_RELIC_APP_NAME=<new relic app name, optional, default to 'Godwoken Web3'>

PG_POOL_MAX=<pg pool max count, optional, default to 20>
CLUSTER_COUNT=<cluster count, optional, default to num of cpus>
GAS_PRICE_CACHE_SECONDS=<seconds, optional, default to 0, and 0 means no cache>
EXTRA_ESTIMATE_GAS=<eth_estimateGas will add this number to result, optional, default to 0>
ENABLE_CACHE_ETH_CALL=<optional, enable eth_call cache, default to false>
ENABLE_CACHE_ESTIMATE_GAS=<optional, enable eth_estimateGas cache, default to false>
ENABLE_CACHE_EXECUTE_RAW_L2_TX=<optional, enable gw_execute_raw_l2Tx cache, default to false>
LOG_LEVEL=<optional, allowed value: `debug` / `info` / `warn` / `error`, default to `debug` in development, and default to `info` in production>
LOG_FORMAT=<optional, allowed value: `json`>
MAX_SOCKETS=<optional, max number of httpAgent sockets per host for web3 connecting to godwoken, default to 10>
WEB3_LOG_REQUEST_BODY=<optional, boolean, if true, will log request method / body, default to false>
PORT=<optional, the api-server running port, default to 8024>
MAX_QUERY_NUMBER=<optional, integer number, maximum number of records to be returned in one query from database>
MAX_QUERY_TIME_MILSECS=<optional, integer number, maximum number of time for database query>
ENABLE_PROF_RPC=<optional, boolean, default to false>
ENABLE_PRICE_ORACLE=<optional, boolean, decide if use dynamic gas price based on price oracle, default to false>
PRICE_ORACLE_DIFF_THRESHOLD=<optional, float, default to 0.05 (5%)>
PRICE_ORACLE_POLL_INTERVAL=<optional, milsecs, default to 30 * 60000 (30 minutes)>
PRICE_ORACLE_UPDATE_WINDOW=<optional, milsecs, default to 60 * 60000 (60 minutes)>
GAS_PRICE_DIVIDER=<optional, a system value to adjust gasPrice with ckbPrice, default to 76000000000000000 (0.00002pCKB with 0.0038 ckb price)>
MIN_GAS_PRICE_UPPER_LIMIT=<optional, uint pCKB(ether), default to 0.00004>
MIN_GAS_PRICE_LOWER_LIMIT=<optional, uint pCKB(ether), default to 0.00001>
BLOCK_CONGESTION_GAS_USED=<optional, default to 33848315>
EOF

$ yarn

# For api-server & indexer
$ DATABASE_URL=<your database url> make migrate

# Only for test purpose
$ yarn workspace @godwoken-web3/api-server reset_database

rate limit config

$ cat > ./packages/api-server/rate-limit-config.json <<EOF
{
  "expired_time_milsec": 60000,
  "methods": {
    "poly_executeRawL2Transaction": 30,
    "<rpc method name>": <max requests number in expired_time>
  }
}
EOF

Start Indexer

The default indexer_config_path is './indexer-config.toml'. More details about the configs refer to struct IndexerConfig.

cargo build --release

godwoken_rpc_url=<godwoken rpc, e.g. "http://godwoken:8119"> \
pg_url=<database url, e.g. "postgres://username:password@localhost:5432/dbname"> \
./target/release/gw-web3-indexer

Update blocks

Update blocks / transactions / logs info in database by update command, include start block and end block.

./target/release/gw-web3-indexer update <optional start block, default to 0> <optional end block, default to local tip> <optional cpu cores to use for update, default to half of local cores>

Start API server

yarn run build:godwoken
yarn run start

Start in production mode

yarn run build && yarn run start:prod

Start via pm2

yarn run build && yarn run start:pm2

Start using docker image

docker run -d -it -v <YOUR .env FILE PATH>:/godwoken-web3/packages/api-server/.env  -w /godwoken-web3  --name godwoken-web3 nervos/godwoken-web3-prebuilds:<TAG> bash -c "yarn workspace @godwoken-web3/api-server start:pm2"

then you can monit web3 via pm2 inside docker container:

docker exec -it <CONTAINER NAME> /bin/bash
$ root@ec562fe2172b:/godwoken-web3# pm2 monit

URLs

# Http 
http://example_web3_rpc_url

# WebSocket
ws://example_web3_rpc_url/ws

With instant-finality feature turn on:

# Http 
http://example_web3_rpc_url?instant-finality-hack=true
http://example_web3_rpc_url/instant-finality-hack

# WebSocket
ws://example_web3_rpc_url/ws?instant-finality-hack=true

Docker Prebuilds

local development:

make build-test-image # (tag: latest-test)

push to docker:

make build-push # needs login, will ask you for tag

resource:

RPC Docs

Get RPC docs at RPCs doc