SpacesVM (#73)

* change name to spacesvm-rs
Signed-off-by: Sam Batschelet <[email protected]>

Author: hexfusion

.github/workflows/test-and-release.yml

@@ -114,9 +114,9 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: build
-          args: --release --bin mini-kvvm
+          args: --release --bin spacesvm
       - name: Run e2e tests
-        run: VM_PLUGIN_PATH=/home/runner/work/mini-kvvm-rs/mini-kvvm-rs/target/release/mini-kvvm scripts/tests.e2e.sh
+        run: VM_PLUGIN_PATH=/home/runner/work/spacesvm-rs/spacesvm-rs/target/release/spacesvm scripts/tests.e2e.sh
 
   release:
     name: Release ${{ matrix.job.target }} (${{ matrix.job.os }})

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "proto/protos/avalanchego"]
-	path = crates/avalanche-proto/protos/avalanchego
-	url = https://github.com/ava-labs/avalanchego.git

Cargo.toml

@@ -1,8 +1,8 @@
 [workspace]
 members = [
-    "mini-kvvm",
+    "spacesvm",
     "tests/e2e",
-    "cli",
+    "spaces-cli",
 ]
 
 [patch.crates-io]

README.md

@@ -1,24 +1,132 @@
+[<img alt="crates.io" src="https://img.shields.io/crates/v/spacesvm.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/spacesvm)
+[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-spacesvm-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/spacesvm)
+![Github Actions](https://github.com/ava-labs/spacesvm-rs/actions/workflows/test-and-release.yml/badge.svg)
 
-![Github Actions](https://github.com/ava-labs/mini-kvvm-rs/actions/workflows/test-and-release.yml/badge.svg)
+# `spacesvm-rs`
 
-# mini-kvvm-rs
+### status: experimental
 
-Mini key-value store VM in Rust for Avalanche
+`spacesvm-rs` is a (EIP-712)[https://eips.ethereum.org/EIPS/eip-712] compatible Rust port of the (SpacesVm)[https://github.com/ava-labs/spacesvm] virtual machine using the Avalanche [Rust SDK](https://github.com/ava-labs/avalanche-types-rs). Although the goal is to achieve feature parity with its Golang counterpart, it is not yet compatible with the existing spaces network.
 
-## Rust Version
+## Core features
+### Authentication
+Any mutations to the key space require the signature of the owner.
+### EIP-712 Compatibility
+Typed structured data hashing and signing.
 
-`mini-kvvm-rs` currently works on Rust `1.60+` and requires support for the `2021` edition.
+## Current Functionality
+### Claim
+Interacting with the SpacesVM starts with a `ClaimTx`. This reserves your own
+"space" and associates your address with it (so that only you can make changes
+to it and/or the keys in it).
 
+### Set/Delete
+Once you have a space, you can then use `SetTx` and `DeleteTx` actions to
+add/modify/delete keys in it.
+
+### Resolve
+When you want to view data stored in SpacesVM, you call `Resolve` on the value
+path: `<space>/<key>`. If you stored a file at a particular path, use this
+command to retrieve it: `spaces-cli resolve-file <path> <destination
+filepath>`.
+
+#### Getting Started
+The easiest way to test and interact with spacesvm is with the included e2e scripts.
+
+```bash
+# build the spacesvm plugin, run e2e tests, and keep the network running
+./scripts/build.release.sh \
+&& VM_PLUGIN_PATH=$(pwd)/target/release/spacesvm \
+./scripts/tests.e2e.sh
+
+# or, specify the custom avalanchego binary
+./scripts/build.release.sh \
+&& VM_PLUGIN_PATH=$(pwd)/target/release/spacesvm \
+./scripts/tests.e2e.sh ~/go/src/github.com/ava-labs/avalanchego/build/avalanchego
+
+# (optional) set NETWORK_RUNNER_ENABLE_SHUTDOWN=1 in "tests.e2e.sh"
+# to shut down the network afterwards
+```
+#### Compile from source.
+
+```bash
+cargo build \
+  --release \
+  --bin spacesvm
+
+./target/release/spaces-vm
+```
+
+```bash
+cargo build \
+  --release \
+  --bin spaces-cli
+
+./target/release/spaces-cli
+
+```
+
+To test `spacesvm` APIs, try the following commands with the CLI or shell commands:
 ```bash
-cd ${HOME}/go/src/github.com/ava-labs/subnet-cli
-go install -v .
-subnet-cli create VMID minikvvmrs
-# qBnAKUQ2mxjMHCneWjq5nFuhntoWrsKsCjaYSouFjpuCB2o5d
-
-cd ${HOME}/mini-kvvm-rs
-./scripts/build.x86_64-linux-musl.sh
-cp \
-./target/x86_64-unknown-linux-musl/release/mini-kvvm-rs \
-${HOME}/go/src/github.com/ava-labs/avalanchego/build/plugins/qBnAKUQ2mxjMHCneWjq5nFuhntoWrsKsCjaYSouFjpuCB2o5d
+SpacesVM CLI for issuing RPC commands
+
+Usage: spacescli [OPTIONS] --endpoint <ENDPOINT> <COMMAND>
+
+Commands:
+  claim  
+  set     
+  delete  
+  get     
+  help    Print this message or the help of the given subcommand(s)
+
+Options:
+      --endpoint <ENDPOINT>                  Endpoint for RPC calls
+      --private-key-file <PRIVATE_KEY_FILE>  Private key file [default: .spacesvm-cli-pk]
+  -h, --help                                 Print help information
+  -V, --version                              Print version information
 ```
-##
+
+## Client
+#### Public Endpoints (`/public`)
+
+#### spacesvm.ping
+```bash
+# "2FdEyx8mgicqvQaGN3HGkDwo7NbhKAY6pgTXUB1UkHW4meySUv" is the blockchain Id
+curl -X POST --data '{
+    "jsonrpc": "2.0",
+    "id"     : 1,
+    "method" : "spaces.ping",
+    "params" : []
+}' -H 'content-type:application/json;' 127.0.0.1:9650/ext/bc/2FdEyx8mgicqvQaGN3HGkDwo7NbhKAY6pgTXUB1UkHW4meySUv/public
+
+# {"jsonrpc":"2.0","result":{"success":true},"id":1}
+```
+#### spacesvm.issueTx
+```bash
+# "2FdEyx8mgicqvQaGN3HGkDwo7NbhKAY6pgTXUB1UkHW4meySUv" is the blockchain Id
+curl -X POST --data '{
+  "jsonrpc": "2.0",
+  "method": "spacesvm.issueTx",
+  "params":{
+    "typedData":<EIP-712 compliant typed data>,
+    "signature":<hex-encoded sig>
+  },
+  "id": 1
+}'
+# IssueTxResponse {"tx_id":<ID>}
+```
+#### spacesvm.resolve
+```bash
+curl -X POST --data '{
+  "jsonrpc": "2.0",
+  "method": "spacesvm.resolve",
+  "params":{
+    "path":<string | ex:jim/twitter>
+  },
+  "id": 1
+}'
+# ResolveResponse {"exists":<bool>, "value":<base64 encoded>, "valueMeta":<chain.ValueMeta>}
+```
+
+## License
+`spacesvm-rs` is under the BSD 3.0 license. See the [LICENSE](LICENSE) file for details.

scripts/build.release.sh

@@ -9,6 +9,6 @@ fi
 # "--bin" can be specified multiple times for each directory in "bin/*" or workspaces
 cargo build \
 --release \
---bin mini-kvvm
+--bin spacesvm
 
-./target/release/mini-kvvm -V
+./target/release/spacesvm -V

scripts/build.x86_64-linux-musl.sh

@@ -11,8 +11,8 @@ docker pull clux/muslrust
 docker run -v $PWD:/volume --rm -t clux/muslrust \
 cargo build \
 --release \
---bin mini-kvvm \
+--bin spacesvm \
 --target x86_64-unknown-linux-musl
 
 BIN_PATH=./target/x86_64-unknown-linux-musl/release
-${BIN_PATH}/mini-kvvm-rs --help || true
+${BIN_PATH}/spacesvm --help || true

cli/.gitignore renamed to spaces-cli/.gitignore

@@ -1,23 +1,23 @@
 [package]
-name = "cli"
-version = "0.0.0"
+name = "spacesvm_cli"
+version = "0.0.1"
 edition = "2021"
 rust-version = "1.65"
 publish = false
-description = "cli for issuing simple rpc commands to mini-kvvm"
+description = "spacesvm_cli_for_issuing_RPC_commands"
 license = "BSD-3-Clause"
 homepage = "https://avax.network"
 
 [dependencies]
-avalanche-types = { version = "0.0.132", features = ["rpcchainvm"] }
+avalanche-types = { version = "0.0.135", features = ["subnet"] }
 clap = { version = "4.0", features = ["derive"] }
 hex = "0.4.3"
 jsonrpc-core = "18.0.0"
 jsonrpc-core-client = { version = "18.0.0" }
 jsonrpc-client-transports = "18.0.0"
 jsonrpc-derive = "18.0"
 log = "0.4.17"
-mini-kvvm = {path = "../mini-kvvm"}
+spacesvm = { path = "../spacesvm" }
 serde = { version = "1.0.147", features = ["derive"] }
 serde_json = "1.0.87" 
 tokio = { version = "1.21.2", features = ["full"] }

cli/Cargo.toml renamed to spaces-cli/Cargo.toml

@@ -1,15 +1,17 @@
-use avalanche_types::key;
-use clap::{Parser, Subcommand};
-use jsonrpc_client_transports::{transports, RpcError};
-use jsonrpc_core::futures;
-use mini_kvvm::api::ServiceClient as Client;
-use mini_kvvm::api::{DecodeTxArgs, IssueTxArgs, ResolveArgs};
-use mini_kvvm::chain::tx::{decoder, tx::TransactionType, unsigned::TransactionData};
 use std::error;
 use std::fs::File;
 use std::io::{Result, Write};
 use std::path::Path;
 
+use avalanche_types::key;
+use clap::{Parser, Subcommand};
+use jsonrpc_client_transports::{transports, RpcError};
+use jsonrpc_core::futures;
+use spacesvm::{
+    api::{DecodeTxArgs, IssueTxArgs, ResolveArgs, ServiceClient as Client},
+    chain::tx::{decoder, tx::TransactionType, unsigned::TransactionData},
+};
+
 #[derive(Parser)]
 #[command(version, about, long_about = None)]
 struct Cli {
@@ -18,7 +20,7 @@ struct Cli {
     endpoint: String,
 
     /// Private key file.
-    #[clap(long, default_value = ".mini-kvvm-cli-pk")]
+    #[clap(long, default_value = ".spacesvm-cli-pk")]
     private_key_file: String,
 
     /// Which subcommand to call.
@@ -28,20 +30,20 @@ struct Cli {
 
 #[derive(Subcommand, Debug)]
 enum Command {
-    Bucket {
-        bucket: String,
+    Claim {
+        space: String,
     },
     Set {
-        bucket: String,
+        space: String,
         key: String,
         value: String,
     },
     Delete {
-        bucket: String,
+        space: String,
         key: String,
     },
     Get {
-        bucket: String,
+        space: String,
         key: String,
     },
 }
@@ -55,9 +57,9 @@ async fn main() -> std::result::Result<(), Box<dyn error::Error>> {
     let client = futures::executor::block_on(connection)?;
     ping(&client).await?;
 
-    if let Command::Get { bucket, key } = &cli.command {
+    if let Command::Get { space, key } = &cli.command {
         futures::executor::block_on(client.resolve(ResolveArgs {
-            bucket: bucket.as_bytes().to_vec(),
+            space: space.as_bytes().to_vec(),
             key: key.as_bytes().to_vec(),
         }))
         .map_err(|e| e.to_string())?;
@@ -71,9 +73,9 @@ async fn main() -> std::result::Result<(), Box<dyn error::Error>> {
 
 fn command_to_tx(command: Command) -> Result<TransactionData> {
     match command {
-        Command::Bucket { bucket } => Ok(bucket_tx(bucket)),
-        Command::Set { bucket, key, value } => Ok(set_tx(bucket, key, value.as_bytes().to_vec())),
-        Command::Delete { bucket, key } => Ok(delete_tx(bucket, key)),
+        Command::Claim { space } => Ok(claim_tx(space)),
+        Command::Set { space, key, value } => Ok(set_tx(space, key, value.as_bytes().to_vec())),
+        Command::Delete { space, key } => Ok(delete_tx(space, key)),
         _ => Err(std::io::Error::new(
             std::io::ErrorKind::Other,
             "not a supported tx",
@@ -96,28 +98,28 @@ fn get_or_create_pk(path: &str) -> Result<key::secp256k1::private_key::Key> {
         .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e.to_string()))
 }
 
-fn bucket_tx(bucket: String) -> TransactionData {
+fn claim_tx(space: String) -> TransactionData {
     TransactionData {
-        typ: TransactionType::Bucket,
-        bucket,
+        typ: TransactionType::Claim,
+        space,
         key: "".to_string(),
         value: vec![],
     }
 }
 
-fn set_tx(bucket: String, key: String, value: Vec<u8>) -> TransactionData {
+fn set_tx(space: String, key: String, value: Vec<u8>) -> TransactionData {
     TransactionData {
         typ: TransactionType::Set,
-        bucket,
+        space,
         key,
         value,
     }
 }
 
-fn delete_tx(bucket: String, key: String) -> TransactionData {
+fn delete_tx(space: String, key: String) -> TransactionData {
     TransactionData {
         typ: TransactionType::Delete,
-        bucket,
+        space,
         key,
         value: vec![],
     }

cli/src/main.rs renamed to spaces-cli/src/main.rs

@@ -1,21 +1,20 @@
 [package]
-name = "mini-kvvm"
+name = "spacesvm"
 version = "0.0.0"
 edition = "2021"
 rust-version = "1.65"
 publish = false
-description = "Mini key-value store VM for Avalanche in Rust"
+description = "Authenticated, hierarchical key-value store w/EIP-712 compatibility"
 license = "BSD-3-Clause"
 homepage = "https://avax.network"
 readme = "README.md"
 
 [[bin]]
-name = "mini-kvvm"
-path = "src/bin/mini-kvvm/main.rs"
+name = "spacesvm"
+path = "src/bin/spaces/main.rs"
 
 [dependencies]
-avalanche-proto = { version = "0.19.0" }
-avalanche-types = { version = "0.0.132", features = ["rpcchainvm"] }
+avalanche-types = { version = "0.0.135", features = ["subnet"] }
 byteorder = "1.4.3"
 chrono = "0.4.19"
 crossbeam-channel = "0.5.6"

mini-kvvm/Cargo.toml renamed to spacesvm/Cargo.toml

@@ -66,7 +66,7 @@ pub struct DecodeTxResponse {
 
 #[derive(Deserialize, Serialize, Debug)]
 pub struct ResolveArgs {
-    pub bucket: Vec<u8>,
+    pub space: Vec<u8>,
     pub key: Vec<u8>,
 }
 

mini-kvvm/src/api/mod.rs renamed to spacesvm/src/api/mod.rs

@@ -0,0 +1,16 @@
+use serde::{Deserialize, Serialize};
+
+#[derive(Clone, PartialEq, Debug, Serialize, Deserialize)]
+struct Request {
+    jsonrpc: String,
+    method: String,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    params: Option<serde_json::Value>,
+    id: serde_json::Value,
+}
+
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn test_request() {}
+}