Skip to content

ipfs-force-community/venus-tool

Repository files navigation

Venus Tool


Why

We created this tool to address the need for a more convenient and efficient way to manage our data on the chain or other components. The purpose of venus-tool is to offer users of venus a comprehensive and user-friendly management interface for handling settings and data related to chain services, deal services, and power services. It also aims to resolve any conflicts arising from the separation of chain services and users.

This tool is currently under development. We welcome everyone to suggest new features, raise issues, and submit pull requests. If there are any features that you would like to see, please let us know.

Features

  • Overview of your assets and areas of interest
  • Access and manage your messages
  • View and interact with your sealing threads
  • Review your mining records
  • Monitor and handle your deals

Usage

Install And Run

Build from source

Just git clone the repo and make

make

Launch Up

You can run the binary directly

./venus-tool run \
--node-api=/ip4/{NODE_IP}/tcp/3453 \
--msg-api=/ip4/{MESSAGER_IP}/tcp/39812 \
--market-api=/ip4/{MARKET_IP}/tcp/41235 \
--miner-api=/ip4/{MINER_IP}/tcp/12308 \
--wallet-api={WALLET_TOKEN}:/ip4/{WALLET_IP}/tcp/5678/http \
--auth-api=http://{AUTH_IP}:8989 \
--damocles-api=/ip4/{DAMOCLES_MANAGER_IP}/tcp/1789 \
--common-token={CHAIN_SERVICE_TOKEN} \

tips: You can get WALLET_API from venus-wallet with venus-wallet auth api-info

With Docker

build a docker image or pull "filvenus/venus-tool" from docker hub.

make docker

run docker container

docker run -d filvenus/venus-tool:latest \
run \
--node-api=/ip4/{NODE_IP}/tcp/3453 \
--msg-api=/ip4/{MESSAGER_IP}/tcp/39812 \
--market-api=/ip4/{MARKET_IP}/tcp/41235 \
--miner-api=/ip4/{MINER_IP}/tcp/12308 \
--wallet-api={WALLET_TOKEN}:/ip4/{WALLET_IP}/tcp/5678/http \
--auth-api=http://{AUTH_IP}:8989 \
--damocles-api=/ip4/{DAMOCLES_MANAGER_IP}/tcp/1789 \
--common-token={CHAIN_SERVICE_TOKEN} \

Dashboard

Access your dashboard by visit `http://localhost:8090 if you run it in your local machine.

More

For more detail , run venus-tool -h.

Development Plan

Command Line

  • Message management
    • query message
    • send message
    • replace message
  • Miner management
    • create miner
    • set ask
    • query deadline
    • change owner , worker, controller
    • withdraw fund
    • withdraw fund from market
  • Multi Sign management
    • manage multi sign address
      • query
      • create
    • proposal management
      • propose
      • cancel
      • approve
    • signer management
      • add
      • remove
      • swap
    • wallet management
      • sign record query
      • sign offline
      • set sign filter

Web UI

  • Summary
    • All available balance
    • Total Collateral
    • Total Raw Byte Power
    • Total Quality Adjust Power
    • Gas Used
    • Collateral In Miner
    • Collateral In Market
    • Mined Block Count Expect
    • Mined Block Count Actually
  • Asset
    • Miners
      • Set your miner about ask, worker, controller, beneficiary and so on
    • Wallet Addresses
      • Gas setting used when sending messages
  • Message
    • Message List
      • Filt and sort msg by state
    • Send
      • Send message
      • Method Selector
    • Replace message
    • Mark Bad message
      • Basic
      • Markbad batch
  • Sealing
    • Thread list
    • Stop thread
    • Start thread
    • Abort thread
    • Set state of thread
    • Time used
  • Mine
    • Mined record
  • Deal
    • Deal List
    • Publish deal
    • Publish deal batch
  • Search
    • Message detail
    • Miner Detail
    • Deal Detail
    • Wallet address detail

Preview

No online demo available yet. You can run it locally to have a try. Preview