Space Operator CLI

CLI for Space Operator.

Table of contents:

• Install
• Login
• Run flow-server
• Generate a new native node
• Generate input and output struct
• Upload node
• Command-Line Help for spo

Install

Install using cargo install:

cargo install space-operator-cli --force

Binary name: spo

$ spo --help
Usage: spo [OPTIONS] [COMMAND]

Commands:
  login     Login to Space Operator using API key
  start     Start flow-server [aliases: s]
  node      Manage your nodes [aliases: n]
  generate  Generate various things [aliases: g]
  help      Print this message or the help of the given subcommand(s)

Options:
      --url <URL>  URL of flow-server to use (default: https://dev-api.spaceoperator.com)
  -h, --help       Print help

Login

Run spo login:

$ spo login
Go to https://spaceoperator.com/dashboard/profile/apikey go generate a key
Please paste your API key below

Enter your API key to login.

Run flow-server

Clone flow-backend repository:

git clone https://github.com/space-operator/flow-backend

cd into flow-backend and run spo start:

cd flow-backend
spo start

This will create a configuration file for flow-server then compile and run it (first compilation will take several minutes).

Example output:

generated config.toml
$ cargo build --bin flow-server
    Finished `dev` profile [optimized] target(s) in 0.60s
$ target/debug/flow-server config.toml
2024-10-19T14:19:36.514531Z  INFO flow_server: native commands: ["add_config_lines", "add_config_lines_core", "add_required_signatory", "add_signatory", "arweave_file_upload", "arweave_nft_upload", "associated_token_account", "attest_from_eth", "attest_token", "burn_cNFT", "burn_v1", "cancel_proposal", "cast_vote", "collect", "complete_native", "complete_proposal", "complete_transfer_wrapped", "const", "create_core_collection_v2", "create_core_v2", "create_governance", "create_master_edition", "create_metadata_account", "create_mint_account", "create_native_treasury", "create_proposal", "create_realm", "create_streamflow_timelock", "create_token_account", "create_token_owner_record", "create_tree", "create_v1", "create_wrapped", "create_wrapped_on_eth", "das_api", "delegate_v1", "deposit_governing_tokens", "execute_transaction", "fetch_assets", "fileexplorer", "finalize_vote", "find_pda", "flow_input", "flow_output", "flow_run_info", "foreach", "gen_metaplex_attrs", "gen_pdg_attrs", "generate_base", "generate_keypair", "get_balance", "get_effect_list", "get_foreign_asset_eth", "get_vaa", "governance_post_message", "http_request", "initialize_candy_guard", "initialize_candy_machine", "initialize_candy_machine_core", "initialize_core_candy_guards", "initialize_record_with_seed", "initialize_token_bridge", "insert_transaction", "interflow", "interflow_instructions", "json_extract", "json_get_field", "json_insert", "kv_create_store", "kv_delete_store", "kv_read_item", "kv_write_item", "kvexplorer", "memo", "mint", "mint_cNFT_to_collection", "mint_candy_machine_core", "mint_compressed_NFT", "mint_token", "mint_v1", "mpl_core_update_plugin", "nft_complete_native", "nft_complete_wrapped", "nft_complete_wrapped_meta", "nft_transfer_native", "nft_transfer_wrapped", "note", "parse_pdg_attrs", "parse_vaa", "pdg_render", "post_message", "post_vaa", "postgrest_builder_eq", "postgrest_builder_insert", "postgrest_builder_is", "postgrest_builder_limit", "postgrest_builder_match", "postgrest_builder_neq", "postgrest_builder_not", "postgrest_builder_order", "postgrest_builder_select", "postgrest_builder_update", "postgrest_builder_upsert", "postgrest_execute_query", "postgrest_new_query", "postgrest_new_rpc", "print", "push_effect_list", "pyth_price", "range", "read_record", "redeem_nft_on_eth", "redeem_on_eth", "refund_proposal_deposit", "relinquish_token_owner_record_locks", "relinquish_vote", "remove_required_signatory", "remove_transaction", "request_airdrop", "revoke_governing_tokens", "set_authority", "set_authority_2022", "set_governance_config", "set_governance_delegate", "set_realm_authority", "set_realm_config", "set_token_owner_record_locks", "sign_off_proposal", "storage_create_signed_url", "storage_delete", "storage_download", "storage_get_file_metadata", "storage_get_public_url", "storage_list", "storage_upload", "supabase", "to_bytes", "to_string", "to_vec", "transfer_cNFT", "transfer_from_eth", "transfer_native", "transfer_nft_from_eth", "transfer_sol", "transfer_token", "transfer_wrapped", "update_cNFT", "update_core_v1", "update_render_params", "update_v1", "verify_collection_v1", "verify_creator_v1", "verify_signatures", "wait", "wallet", "withdraw_governing_tokens", "withdraw_streamflow_timelock", "wrap", "wrap_core", "write_to_record"]
2024-10-19T14:19:36.514586Z  INFO flow_server: allow CORS origins: ["*"]
2024-10-19T14:19:36.528967Z  INFO db::local_storage: openning sled storage: _data/guest_local_storage
2024-10-19T14:19:37.728815Z  WARN flow_server: missing credentials, some routes are not available: need database credentials
2024-10-19T14:19:37.728846Z  INFO flow_server: listening on "0.0.0.0" port 8080
2024-10-19T14:19:37.729177Z  INFO actix_server::builder: starting 8 workers
2024-10-19T14:19:37.729198Z  INFO actix_server::server: Actix runtime found; starting in Actix runtime
2024-10-19T14:19:37.729207Z  INFO actix_server::server: starting service: "actix-web-service-0.0.0.0:8080", workers: 8, listening on: 0.0.0.0:8080
2024-10-19T14:19:37.759200Z DEBUG flow_server::db_worker::token_worker: started TokenWorker c334e245-75b4-49fd-93c0-c4b25ab74f70
2024-10-19T14:19:37.759314Z  INFO flow_server::db_worker: started DBWorker

Generate a new native node

Make sure you are inside flow-backend repository.

Generate with spo node new:

$ spo node new
could not determine which package to update
use `-p` option to specify a package
available packages:
    client
    flow-lib
    spo-helius
    flow-value
    space-lib
    cmds-deno
    command-rpc
    srpc
    cmds-pdg
    pdg-common
    cmds-solana
    cmds-std
    db
    flow
    rhai-script
    space-wasm
    utils
    flow-server

Because our workspace have several packages, you must specify one of them to use (our CLI can automatically choose one if you are inside one of them).

$ spo node new -p cmds-solana

Fill the prompts for node definition, for example:

$ spo node new -p cmds-solana
using package: cmds-solana
enter ? for help
? module path: ?
enter valid Rust module path to save the node (empty to save at root)
? module path:
? node id: transfer
? display name: Transfer
description:

adding node inputs (enter empty name to finish)
? name: fee_payer
? input type: keypair
? optional (true/false): false
? passthrough (true/false): true

adding node inputs (enter empty name to finish)
? name: amount
? input type: decimal
? optional (true/false): false
? passthrough (true/false): false

adding node inputs (enter empty name to finish)
? name:

adding node outputs (enter empty name to finish)
? name: balance
? output type: decimal
? optional (true/false): true

adding node outputs (enter empty name to finish)
? name:
will this node emit Solana instructions? (y/n): y
adding `signature` output
adding `submit` input
adding instruction info: {
  "before": [
    "balance",
    "fee_payer"
  ],
  "signature": "signature",
  "after": []
}
writing node definition to crates/cmds-solana/node-definitions/transfer.json
writing code to crates/cmds-solana/src/transfer.rs
updating module crates/cmds-solana/src/lib.rs
upload node (y/n): y
node: transfer
command is not in database
upload? (y/n): y
inserted new node, id=1256
view your node:
https://spaceoperator.com/dashboard/nodes/c334e245-75b4-49fd-93c0-c4b25ab74f70.transfer.0.1

Generated Rust code:

use flow_lib::command::prelude::*;
const NAME: &str = "transfer";
flow_lib::submit!(CommandDescription::new(NAME, | _ | build()));
fn build() -> BuildResult {
    const DEFINITION: &str = flow_lib::node_definition!("/transfer.json");
    static CACHE: BuilderCache = BuilderCache::new(|| {
        CmdBuilder::new(DEFINITION)?.check_name(NAME)
    });
    Ok(CACHE.clone()?.build(run))
}
#[derive(Deserialize, Serialize, Debug)]
struct Input {
    #[serde(with = "value::keypair")]
    fee_payer: Keypair,
    #[serde(with = "value::decimal")]
    amount: Decimal,
    #[serde(default = "value::default::bool_true")]
    submit: bool,
}
#[derive(Deserialize, Serialize, Debug)]
struct Output {
    #[serde(default, with = "value::decimal::opt")]
    balance: Option<Decimal>,
    #[serde(default, with = "value::signature::opt")]
    signature: Option<Signature>,
}
async fn run(mut ctx: Context, input: Input) -> Result<Output, CommandError> {
    tracing::info!("input: {:?}", input);
    let signature = ctx
        .execute(Instructions::default(), value::map! {})
        .await?
        .signature;
    Err(CommandError::msg("unimplemented"))
}
#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn test_build() {
        build().unwrap();
    }
    #[tokio::test]
    async fn test_run() {
        let ctx = Context::default();
        build().unwrap().run(ctx, ValueSet::new()).await.unwrap_err();
    }
}

Then, you can use spo start to run a local flow-server and test your node in flow editor.

Generate input and output struct

If you updated the node definition manually, you can use spo generate input and spo generate output to generate new type definitions.

For example

spo generate input crates/cmds-solana/node-definitions/nft/v1/mint_v1.json

#[derive(Deserialize, Serialize, Debug)]
struct Input {
    #[serde(with = "value::keypair")]
    fee_payer: Keypair,
    #[serde(default, with = "value::keypair::opt")]
    authority: Option<Keypair>,
    #[serde(with = "value::pubkey")]
    mint_account: Pubkey,
    #[serde(with = "value::pubkey")]
    token_owner: Pubkey,
    amount: Option<u64>,
    #[serde(default, with = "value::pubkey::opt")]
    delegate_record: Option<Pubkey>,
    #[serde(default, with = "value::pubkey::opt")]
    authorization_rules_program: Option<Pubkey>,
    #[serde(default, with = "value::pubkey::opt")]
    authorization_rules: Option<Pubkey>,
    authorization_data: Option<JsonValue>,
    #[serde(default = "value::default::bool_true")]
    submit: bool,
}

Upload node

Use spo node upload to upload new node definition or update existing one. We only support native node at the moment.

Command-Line Help for spo

This document contains the help content for the spo command-line program.

Command Overview:

• spo↴
• spo login↴
• spo start↴
• spo node↴
• spo node new↴
• spo node upload↴
• spo generate↴
• spo generate input↴
• spo generate output↴
• spo generate config↴

spo

Usage: spo [OPTIONS] [COMMAND]

Subcommands:

• login — Login to Space Operator using API key
• start — Start flow-server
• node — Manage your nodes
• generate — Generate various things

Options:

• --url <URL> — URL of flow-server to use (default: https://dev-api.spaceoperator.com)

spo login

Login to Space Operator using API key

Usage: spo login

spo start

Start flow-server

Usage: spo start [CONFIG]

Arguments:

• <CONFIG> — Path to configuration file

spo node

Manage your nodes

Usage: spo node <COMMAND>

Subcommands:

• new — Generate a new node
• upload — Upload nodes

spo node new

Generate a new node

Usage: spo node new [OPTIONS]

Options:

• --allow-dirty — Allow dirty git repository
• -p, --package <PACKAGE> — Specify which Rust package to add the new node to

spo node upload

Upload nodes

Usage: spo node upload [OPTIONS] <PATH>

Arguments:

• <PATH> — Path to JSON node definition file

Options:

• --dry-run — Only print diff, don't do anything
• --no-confirm — Don't ask for confirmation

spo generate

Generate various things

Usage: spo generate <COMMAND>

Subcommands:

• input — Generate input struct
• output — Generate output struct
• config — Generate configuration file for flow-server

spo generate input

Generate input struct

Usage: spo generate input <PATH>

Arguments:

• <PATH> — Path to node definition file

spo generate output

Generate output struct

Usage: spo generate output <PATH>

Arguments:

• <PATH> — Path to node definition file

spo generate config

Generate configuration file for flow-server

Usage: spo generate config [PATH]

Arguments:

• <PATH> — Path to save configuration file (default: config.toml)

This document was generated automatically by clap-markdown.