Skip to content

I0San/contract-captain

Repository files navigation

React Tailwind CSS Wagmi Ethers

Contract Captain

Decentralized Smart contract explorer and administration tool for developers and moderators of smart contracts.

Available for EVM-compatible blockchains (Ethereum, Polygon, BSC, Avalanche, Optimism, Hardhat, Localhost).

Support the project by donating or contributing to code and documentation.

BTC: bc1qszdxp6dzrrzv6h0mnk0093k48h07j4rhvsjl9u
EVM: 0x386A5a8b33234B5eb22dAeE45C1693c8591cB4a2

Features

  • connect web3 wallet (Metamask, Coinbase Wallet, WalletConnect)
  • workspace for managing contracts under projects
  • add contracts by entering address and ABI (and code optionally)
  • displays view data
  • displays contract events (does not persist)
  • displays contract transactions (does not persist)
  • execute write functions
  • displays ABI
  • displays Code
  • generates React Hooks for all methods
  • no backend, uses localstorage

Home

Getters

Setters

ABI

Code

React Hooks

Project Settings

Workspace Settings

Planned features

  • migration script in case of state arhitecture change
  • sync workspace between devices (GitHub Gist, Google Cloud, Dropbox...)
  • on contract address entry, check if code or ABI is available on network explorers? (etherscan, bscscan, etc.)
  • disable getters on UI if failing (example onlyCreator can call a method)

TODOs

  • typescript
  • new build chain
  • delete project
  • check links to block explorers
  • grid transactions formating & styling
  • grid events formating & styling
  • project settings -> list of networks when not connected with wallet!
  • sync your workspace between devices through Gist (optionally) (https://docs.github.com/en/rest/gists?apiVersion=2022-11-28)
  • drag & drop items in navigation and persist sort order
  • prioritize getters (owner, name/_tokenName, symbol/_tokenSymbol, decimals/_tokenDecimals, _totalSupply/totalSupply, _tokenMaxSupply)
  • parse code and show comments and functions "onhover" over UI write or read method
  • responsive mobile views

Installation

yarn

Running

Run in different environments:

yarn start

Building

Build for production:

yarn build

Dependencies

License

This repository is licensed under the MIT license. See the LICENSE file for more information.

Authors

@IoSan - iosan@protonmail.com

Acknowledgements

@doktorBabo @formator

Contributors

Feel free to get in touch if you want to contribute to the project.