/ckb-fiber-docker

CKB Fiber Docker image that runs the fiber node in a container for easy deployment

Primary LanguageTypeScriptMIT LicenseMIT

CKB Fiber Docker

Automatic builds badge Docker Image Size

Docker image that contains the CKB Fiber Network Node (FNN) and ckb-cli for easy deployment.

Check the version

# https://github.com/nervosnetwork/fiber/releases/tag/v0.5.1
export FIBER_IMAGE=ghcr.io/flouse/ckb-fiber:v0.5.1

docker run --rm ${FIBER_IMAGE} ckb-cli --version
# Output: ckb-cli 1.12.0 (278c7be 2024-09-20)

docker run --rm ${FIBER_IMAGE}
# Ouptut: fnn 0.5.1

Usage

# Fiber Help
docker run --rm ${FIBER_IMAGE} fnn --help

# Copy the example environment file and set your password
cp example.env .env
# Edit .env to set `FIBER_SECRET_KEY_PASSWORD` etc.

# Start a Fiber node with custom configuration (./testnet-config.yml)
docker compose up -d

# Watch logs
docker compose logs -f --tail 10

# Get node info
curl -s -X POST http://localhost:58227 \
  -H "Content-Type: application/json" \
  --data '{"id":2, "jsonrpc":"2.0", "method":"node_info", "params":[]}'

RPC docs of Fiber Network Node

See https://github.com/nervosnetwork/fiber/tree/develop/crates/fiber-lib/src/rpc

TODO

Faucet Testing

  • Add balance check before faucet request
  • Get CKB faucet if necessary

Peer Connection

  • Fetch peer list from testnet explorer
  • Implement connection to known peers
  • Verify successful peer connections

Channel Operations

  • Test channel opening functionality
    • CKB channel
    • USDI channel
  • Implement channel listing
  • Close channels
  • Verify channel states

Payment Testing

  • Setup key_send payment test
  • Verify balance after payment success

Reuse the tests of fiber

  • Use Bruno
  • implement the fiber E2E tests on CKB testnet Fiber E2E Tests