vyper-protocol / vyper-cli

🎼 Command Line to interact with on chain Vyper program suite

Vyper-Cli

Command Line to interact with on chain Vyper program suite

Installation

1. Download the source code.

$ git clone [email protected]:vyper-protocol/vyper-cli.git
$ cd vyper-cli

2. Build

$ cargo build

3. Install

$ cargo install --path .

Usage

$ vyper <option> <command>

Example

Get current version

$ vyper --version

Fetch tranche configuration

$ vyper core fetch 5Q8tNcpKjBSGHyW3LEr1rGAJeuuLWCbYB5frL79XacRC

vyper-cli's Issues

Fetch rate_switchboard plugin state

We need to fetch a plugin state account for the rate_switchboard plugin program

Read wallet and cluster parameters from solana config

Documentation website

We need to generate a documentation website that will serve as main point of reference for users and developers.

The website will have, for each command:

• syntax explanation (required parameters and optional ones)
• examples

The structure will be something like:

• introduction
• core commands
• • fetch
• redeem logic commands
• • forward
• • • fetch
• rate commands
• • switchboard
• • • fetch

The website will be hosted on github pages, from this repo.

For the website generation we can do some research in order to check which is the best tool. Probably rust md-book is currently a good option, we're currently using it for vyper main developer docs (here the source and here the deploy gh action). If we can find some tool that generate automatically the docs from the source code comments we can evaluate that as well.

State Creation for redeem logic forward plugin

Create an OTC contract

Related to #15

Read redeemlogic_forward state account

This will be a new command in the redeem_logic_forward sub suite, we need to fetch a redeem_logic_state and print in the console all the parameters inside (strike, notional, etc..)

Overwrite provider parameters

We have to replicate the same anchor behavior in order to allow the user to overwrite the provider details: cluster and wallet. If we check in the anchor cli command we have always these options available:

        --provider.cluster <CLUSTER>    Cluster override
        --provider.wallet <WALLET>      Wallet override

We should replicate the same feat. the open source repo for the anchor cli is here

Redeem Logic plugin state creation

We have to include the possibility to create redeem logic plugin states for all the following types:

• #29
• settled forward
• vanilla option
• farming
• fila
• lending fee
• lending
• digital #40

We can open multiple PRs addressing this issues, if that's convenient. Then we'll track progress checking the above list

Print current version

Print current software version reading from Cargo.toml

Redeem Logic plugin state fetching

We have to include the possibility to fetch redeem logic plugin states from all the following plugins:

• forward
• settled forward
• vanilla option
• farming
• fila
• lending fee
• lending
• digital #40

We can open multiple PRs addressing this issues, if that's convenient. Then we'll track progress checking the above list

Create Switchboard Rate plugin

We need to allow users to create a switchboard rate plugin

ref #28

Introduce clap for argument parsing

introduce clap:
https://docs.rs/clap/latest/clap/

Read last aggregator value from switchboard

Given a switchboard aggregator account we should be able to read the last saved value. This will be useful as a standalone command in the rate_switchboard sub suite and as a collateral data fetching the rate_state fetching pointed at #12

More on aggregator last value here

Provide github check actions on push and pull_req

Digital RedeemLogic plugin support

• Create new Digital redeem logic plugin
• Fetch existing Digital redeem logic plugin

Ref: #23

Change crate name to vyper-cli

vyper-cli/Cargo.toml

Line 2 in 4fd4932

name = "vyper"

after this change we'll need to change also the website
from
https://vyper-protocol.github.io/vyper-cli/vyper/
to
https://vyper-protocol.github.io/vyper-cli/vyper-cli/

Improve installation documentation

We need to provide easier options to install the CLI in docs, for example:

cargo install --git https://github.com/vyper-protocol/vyper-cli vyper --force

We need also to provide instructions on how to update the executable (ie running the same command).

Fetch an otc contract

We should be able to fetch an OTC contract and print all the parameters inside. the OTC program is saved in a dedicated repo

Rate plugin state fetching

We have to include the possibility to fetch rate plugin states from all the following plugins:

• switchboard
• pyth #39
• poolv2
• twap
• mock

We can open multiple PRs addressing this issues, if that's convenient. Then we'll track progress checking the above list

Add a progress bar using Indicatif module

Introduce better error handling mechanism

Rate plugin state creation

We have to include the possibility to create rate plugin states from all the following types:

• switchboard #41
• pyth #39
• poolv2
• twap
• mock

We can open multiple PRs addressing this issues, if that's convenient. Then we'll track progress checking the above list

Basic documentation

Create proper documentation in readme.md to give instructions on how to download the CLI and how to compile locally. This will be useful as long as we'll provide pre compiled binaries on github releases assets (example here).

Pyth Rate plugin support

• Create new Pyth rate plugin
• Fetch existing pyth rate plugin

Ref: #24

Introduce cli common libraries

Evaluate the followings:

https://github.com/console-rs/console
https://docs.rs/indicatif/latest/indicatif/
https://docs.rs/dialoguer/latest/dialoguer/

Check dependencies used here

Read Vyper Core Tranche Configuration

Move contracts publickey in a settings toml file

Currently we have all the chain smart contracts public keys hardcoded in the codebase:

vyper-cli/src/main.rs

Lines 35 to 38 in c9fc594

	const VYPER_CORE_ID: &str = "vyPErCcGJKQQBeeQ59gXcWrDyU4vBrq8qQfacwmsAsp";
	const REDEEM_LOGIC_FORWARD: &str = "BrpV1re8MshA8qskKVxcEG8zXG3vf2uLX6myeTKAyhsK";
	const RATE_SWITCHBOARD: &str = "2hGXiH1oEQwjCXRx8bNdHTi49ScZp7Mj2bxcjxtULKe1";
	const OTC: &str = "8aHSkExY28qCvg4gnTLU7y1Ev6HnpJ1NxuWb9XtEesVt";

We should move these parameters to an external file for easy tuning. For example it could be a settings.toml file (in order to prepare the field also for future user settings/preferences).

Once created the settings.toml file we can create a new command to open it in a text editor in order to allow users to change it, for example:

vyper-cli settings open

I would avoid creating a command for changing each setting entry from the suite, for now it's not needed.

Better error handling

Fetching an unexisting tranche config result in this output:

➜  vyper-cli git:(feat/cli-setup) cargo run -- core fetch 5Q8tNcpKjBSGHyW3LEr1rGAJeuuLWCbYB5frL79XacRC
    Finished dev [unoptimized + debuginfo] target(s) in 0.13s
     Running `target/debug/vyper core fetch 5Q8tNcpKjBSGHyW3LEr1rGAJeuuLWCbYB5frL79XacRC`
thread 'main' panicked at 'Could not find tranche with given publickey: AccountNotFound', src/ops/core_ops.rs:22:84
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

we need a better error handling