The solana-cli-template from mvines

solana-cli-template's Introduction

Quick start

Install Rust from https://rustup.rs/
cargo run

Want Batteries Included?

This template is intentionally minimal. For a template that's more functional out of the box, try https://github.com/hashblock/solana-cli-program-template

About

solana-cli-template is a sample app demonstrating the creation of a minimal CLI application written in Rust to interact with Solana. It provides three pieces of functionality:

ping: Creates a transaction sending 0 SOL from the signer's account to the signer's account. Returns the signature of the transaction.
balance: Returns the account's balance.
help: Tips for using the app. This is an off-chain operation.

Local step-by-step

Prepare account:

Start a local node: run solana-test-validator.
Generate a keypair: solana-keygen new -o test.json.
Add 100 SOL to the corresponding account solana airdrop --url http://127.0.0.1:8899 --keypair test.json 100.

Build app: cargo run.
Ping:

$ cargo run -- ping --url http://127.0.0.1:8899 --keypair test.json
Signature: 2Y863JX96RTqbeGfcvQowVt1V91Dgs2LZfVgQ3mGJPmYu24sUTYmfkArHAAgj4uFqP75bm9GXU9DYjiMFxahQJUC

Balance:

$ cargo run -- balance --url http://127.0.0.1:8899 --keypair test.json
3dSRGE3wYCcGWFrxAsQs5PaBqtJzzxdTzY2ypXNFUji9 has a balance of ◎99.999995000 // balance less than 100 because of ping operation above

Run help for the complete list of options:

$ cargo run -- --help
cli-template 0.1.0


USAGE:
    cli-template [FLAGS] [OPTIONS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
    -v, --verbose    Show additional information

OPTIONS:
    -C, --config <PATH>        Configuration file to use [default: /Users/user/.config/solana/cli/config.yml]
        --url <URL>            JSON RPC URL for the cluster [default: value from configuration file]
        --keypair <KEYPAIR>    Filepath or URL to a keypair [default: client keypair]

SUBCOMMANDS:
    balance    Get balance
    help       Prints this message or the help of the given subcommand(s)
    ping       Send a ping transaction

solana-cli-template's People

Contributors

Stargazers

Watchers

solana-cli-template's Issues

PR Potential

@mvines Wanted run the PR idea by you

Add a program source directory to the template that demonstrates exercising various program instructions, account state (data) management, etc.
Add a keys directory to support faux program wallets and account keys
Add a tests directory with multiple test run scenarios (i.e. "no batteries required", etc.)

I realize there are lots of sample programs but my thoughts are that the intent of the template is to kick start others CLI implementations with boiler plate simplicity.

Thoughts?

And, if you agree its a worthy addition, are we doing Draft PR's with incremental updates for review before finalizing? Or...?

Recommend Projects