Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 55 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,71 @@
Simple CLI tool for fetching data from symbiotic core smart contracts.

## Install

```bash
pip3 install -r requirements.txt
```

## Usage

```
$ python3 symb.py
Usage: symb.py [OPTIONS] COMMAND [ARGS]...

Options:
--provider TEXT Ethereum provider URL [http(s)]
--help Show this message and exit.
--provider TEXT Ethereum provider URL [http(s)]
--help Show this message and exit.
--private-key TEXT Private key to sign transactions with (only for write functionality).
--ledger Flag if to use a ledger to sign transactions (only for write functionality). Make sure to install Ledger Live, open the Ethereum app, and enable the blind signing first.
--ledger-address TEXT Address of the ledger's account to use to sign transactions (only for write functionality).


Commands:
isnet Check if address is network
isop Check if address is operator
middleware Get network middleware address
netops List all operators opted in network
nets List all networks
netstakes Show stakes of all operators in network
opnets List all networks where operator is opted in
ops List all operators
opstakes Show operator stakes in all networks
vaultnets List all networks associated with the given vault.
vaultnetsops List all operators and their associated networks for the...
vaultops List all operators opted into the given vault.
vaults List all vaults
--- for general use (related to Networks) ---

isnet Check if address is network.
middleware Get network middleware address.
nets List all networks.
netops List all operators opted in network.
netstakes Show stakes of all operators in network.
pending-resolver Get a current resolver for a subnetwork in a vault.
resolver Get a pending resolver for a subnetwork in a vault.

--- for general use (related to Operators) ---

isop Check if address is operator.
ops List all operators.
opnets List all networks where operator is opted in.
op-vault-net-stake Get operator stake in vault for network (includes data about the operator's shares if NetworkRestakeDelegator).
opstakes Show operator stakes in all networks.
check-opt-in-network Check if operator is opted in to a network.
check-opt-in-vault Check if is opted in to a vault.

--- for general use (related to Vaults) ---

isvault Check if address is vault.
vaults List all vaults.
vaultnets List all networks associated with the given vault.
vaultops List all operators opted into the given vault.
vaultnetsops List all operators and their associated networks for the given vault.

--- for Networks ---

register-network Register the signer as a network.
set-max-network-limit Set a maximum network limit at the vault's delegator.
set-resolver Set a resolver for a subnetwork at VetoSlasher.

--- for Operators ---

register-operator Register the signer as an operator.
opt-in-network Opt-in to a network.
opt-in-vault Opt-in to a vault.
opt-out-network Opt-out from a network.
opt-out-vault Opt-out from a vault.

--- for Vault Curators ---

set-network-limit Set a network limit at the vault's delegator.
set-operator-network-limit Set an operator-network limit at the vault's delegator.
set-operator-network-shares Set an operator-network shares at the vault's delegator.
```
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
click==8.1.3
web3==6.11.1
w3multicall==0.3.1
w3multicall==0.3.1
ledgereth==0.9.1
Loading