diff --git a/node/src/bin/space-cli.rs b/node/src/bin/space-cli.rs index 033ce04..00fbad3 100644 --- a/node/src/bin/space-cli.rs +++ b/node/src/bin/space-cli.rs @@ -2,7 +2,6 @@ extern crate core; use std::{fs, path::PathBuf, str::FromStr}; -use base64::{prelude::BASE64_STANDARD, Engine}; use clap::{Parser, Subcommand}; use jsonrpsee::{ core::{client::Error, ClientError}, @@ -10,9 +9,8 @@ use jsonrpsee::{ }; use protocol::{ bitcoin::{Amount, FeeRate, OutPoint, Txid}, - hasher::{KeyHasher, SpaceKey}, + hasher::{KeyHasher}, slabel::SLabel, - Covenant, FullSpaceOut, }; use serde::{Deserialize, Serialize}; use spaced::{ @@ -31,14 +29,14 @@ use wallet::export::WalletExport; pub struct Args { /// Bitcoin network to use #[arg(long, env = "SPACED_CHAIN")] - chain: spaced::config::ExtendedNetwork, + chain: ExtendedNetwork, /// Spaced RPC URL [default: based on specified chain] #[arg(long)] spaced_rpc_url: Option, /// Specify wallet to use #[arg(long, short, global = true, default_value = "default")] wallet: String, - /// Custom dust amount in sat for auction outputs + /// Custom dust amount in sat for bid outputs #[arg(long, short, global = true)] dust: Option, /// Force invalid transaction (for testing only) @@ -52,21 +50,15 @@ pub struct Args { enum Commands { /// Generate a new wallet #[command(name = "createwallet")] - CreateWallet { - #[arg(default_value = "default")] - name: String, - }, + CreateWallet, /// Load a wallet #[command(name = "loadwallet")] - LoadWallet { - #[arg(default_value = "default")] - name: String, - }, + LoadWallet, /// Export a wallet #[command(name = "exportwallet")] ExportWallet { - #[arg(default_value = "default")] - name: String, + // Destination path to export json file + path: PathBuf, }, /// Import a wallet #[command(name = "importwallet")] @@ -76,10 +68,7 @@ enum Commands { }, /// Export a wallet #[command(name = "getwalletinfo")] - GetWalletInfo { - #[arg(default_value = "default")] - name: String, - }, + GetWalletInfo, /// Export a wallet #[command(name = "getserverinfo")] GetServerInfo, @@ -163,8 +152,8 @@ enum Commands { #[command(name = "balance")] Balance, /// Pre-create outputs that can be auctioned off during the bidding process - #[command(name = "createauctionoutputs")] - CreateAuctionOutputs { + #[command(name = "createbidouts")] + CreateBidOuts { /// Number of output pairs to create /// Each pair can be used to make a bid pairs: u8, @@ -187,20 +176,21 @@ enum Commands { outpoint: OutPoint, }, /// Get the estimated rollout batch for the specified interval - #[command(name = "getrolloutestimate")] - GetRolloutEstimate { + #[command(name = "getrollout")] + GetRollout { // Get the estimated rollout for the target interval. Every ~144 blocks (a rollout interval), // 10 spaces are released for auction. Specify 0 [default] for the coming interval, 1 // for the interval after and so on. #[arg(default_value = "0")] target_interval: usize, }, - /// Associate the specified data with a given space (experimental may be removed) - #[command(name = "setdata")] - SetData { + /// Associate the specified data with a given space (not recommended use Fabric instead) + /// If for whatever reason it's not possible to use other protocols, then you may use this. + #[command(name = "setrawfallback")] + SetRawFallback { /// Space name space: String, - /// Base64 encoded data + /// Hex encoded data data: String, /// Fee rate to use in sat/vB #[arg(long, short)] @@ -212,8 +202,8 @@ enum Commands { ListSpaces, /// List unspent auction outputs i.e. outputs that can be /// auctioned off in the bidding process - #[command(name = "listauctionoutputs")] - ListAuctionOutputs, + #[command(name = "listbidouts")] + ListBidOuts, /// List unspent coins owned by wallet #[command(name = "listunspent")] ListUnspent, @@ -225,12 +215,6 @@ enum Commands { /// compatible with most bitcoin wallets #[command(name = "getnewaddress")] GetCoinAddress, - /// Calculate a spacehash from the specified space name - #[command(name = "spacehash")] - SpaceHash { - /// The space name - space: String, - }, /// Force spend an output owned by wallet (for testing only) #[command(name = "forcespend")] ForceSpend { @@ -238,6 +222,11 @@ enum Commands { #[arg(long, short)] fee_rate: u64, }, + /// DNS encodes the space and calculates the SHA-256 hash + #[command(name = "hashspace")] + HashSpace { + space: String, + }, } struct SpaceCli { @@ -376,11 +365,10 @@ async fn main() -> anyhow::Result<()> { Ok(()) } -fn space_hash(spaceish: &str) -> anyhow::Result { +fn hash_space(spaceish: &str) -> anyhow::Result { let space = normalize_space(&spaceish); let sname = SLabel::from_str(&space)?; - let spacehash = SpaceKey::from(Sha256::hash(sname.as_ref())); - Ok(hex::encode(spacehash.as_slice())) + Ok(hex::encode(Sha256::hash(sname.as_ref()))) } async fn handle_commands( @@ -388,44 +376,10 @@ async fn handle_commands( command: Commands, ) -> std::result::Result<(), ClientError> { match command { - Commands::GetRolloutEstimate { + Commands::GetRollout { target_interval: target, } => { - let hashes = cli.client.get_rollout(target).await?; - let mut spaceouts = Vec::with_capacity(hashes.len()); - for (priority, spacehash) in hashes { - let outpoint = cli - .client - .get_space_owner(&hex::encode(spacehash.as_slice())) - .await?; - - if let Some(outpoint) = outpoint { - if let Some(spaceout) = cli.client.get_spaceout(outpoint).await? { - spaceouts.push(( - priority, - FullSpaceOut { - txid: outpoint.txid, - spaceout, - }, - )); - } - } - } - - let data: Vec<_> = spaceouts - .into_iter() - .map(|(priority, spaceout)| { - let space = spaceout.spaceout.space.unwrap(); - ( - space.name.to_string(), - match space.covenant { - Covenant::Bid { .. } => priority, - _ => 0, - }, - ) - }) - .collect(); - + let data = cli.client.get_rollout(target).await?; println!("{}", serde_json::to_string_pretty(&data)?); } Commands::EstimateBid { target } => { @@ -433,7 +387,7 @@ async fn handle_commands( println!("{} sat", Amount::from_sat(response).to_string()); } Commands::GetSpace { space } => { - let space_hash = space_hash(&space).map_err(|e| ClientError::Custom(e.to_string()))?; + let space_hash = hash_space(&space).map_err(|e| ClientError::Custom(e.to_string()))?; let response = cli.client.get_space(&space_hash).await?; println!("{}", serde_json::to_string_pretty(&response)?); } @@ -441,11 +395,11 @@ async fn handle_commands( let response = cli.client.get_spaceout(outpoint).await?; println!("{}", serde_json::to_string_pretty(&response)?); } - Commands::CreateWallet { name } => { - cli.client.wallet_create(&name).await?; + Commands::CreateWallet => { + cli.client.wallet_create(&cli.wallet).await?; } - Commands::LoadWallet { name } => { - cli.client.wallet_load(&name).await?; + Commands::LoadWallet => { + cli.client.wallet_load(&cli.wallet).await?; } Commands::ImportWallet { path } => { let content = @@ -453,12 +407,14 @@ async fn handle_commands( let wallet: WalletExport = serde_json::from_str(&content)?; cli.client.wallet_import(wallet).await?; } - Commands::ExportWallet { name } => { - let result = cli.client.wallet_export(&name).await?; - println!("{}", serde_json::to_string_pretty(&result).expect("result")); + Commands::ExportWallet { path } => { + let result = cli.client.wallet_export(&cli.wallet).await?; + let content = serde_json::to_string_pretty(&result).expect("result"); + fs::write(path, content).map_err(|e| + ClientError::Custom(format!("Could not save to path: {}", e.to_string())))?; } - Commands::GetWalletInfo { name } => { - let result = cli.client.wallet_get_info(&name).await?; + Commands::GetWalletInfo => { + let result = cli.client.wallet_get_info(&cli.wallet).await?; println!("{}", serde_json::to_string_pretty(&result).expect("result")); } Commands::GetServerInfo => { @@ -495,7 +451,7 @@ async fn handle_commands( ) .await? } - Commands::CreateAuctionOutputs { pairs, fee_rate } => { + Commands::CreateBidOuts { pairs, fee_rate } => { cli.send_request(None, Some(pairs), fee_rate).await? } Commands::Register { @@ -544,17 +500,17 @@ async fn handle_commands( ) .await? } - Commands::SetData { + Commands::SetRawFallback { mut space, data, fee_rate, } => { space = normalize_space(&space); - let data = match BASE64_STANDARD.decode(data) { + let data = match hex::decode(data) { Ok(data) => data, Err(e) => { return Err(ClientError::Custom(format!( - "Could not base64 decode data: {}", + "Could not hex decode data: {}", e ))) } @@ -576,7 +532,7 @@ async fn handle_commands( let spaces = cli.client.wallet_list_unspent(&cli.wallet).await?; println!("{}", serde_json::to_string_pretty(&spaces)?); } - Commands::ListAuctionOutputs => { + Commands::ListBidOuts => { let spaces = cli.client.wallet_list_auction_outputs(&cli.wallet).await?; println!("{}", serde_json::to_string_pretty(&spaces)?); } @@ -610,12 +566,6 @@ async fn handle_commands( .await?; println!("{}", serde_json::to_string_pretty(&response)?); } - Commands::SpaceHash { space } => { - println!( - "{}", - space_hash(&space).map_err(|e| ClientError::Custom(e.to_string()))? - ); - } Commands::ForceSpend { outpoint, fee_rate } => { let result = cli .client @@ -627,6 +577,12 @@ async fn handle_commands( .await?; println!("{}", serde_json::to_string_pretty(&result).expect("result")); } + Commands::HashSpace { space } => { + println!( + "{}", + hash_space(&space).map_err(|e| ClientError::Custom(e.to_string()))? + ); + } } Ok(()) diff --git a/node/src/rpc.rs b/node/src/rpc.rs index 7ef78ee..7dd9995 100644 --- a/node/src/rpc.rs +++ b/node/src/rpc.rs @@ -1,3 +1,4 @@ +use crate::store::RolloutEntry; use std::{ collections::BTreeMap, fs, io::Write, net::SocketAddr, path::PathBuf, str::FromStr, sync::Arc, }; @@ -32,6 +33,8 @@ use tokio::{ sync::{broadcast, mpsc, oneshot, RwLock}, task::JoinSet, }; +use protocol::hasher::KeyHasher; +use protocol::slabel::SLabel; use wallet::{ bdk_wallet as bdk, bdk_wallet::template::Bip86, bitcoin::hashes::Hash, export::WalletExport, DoubleUtxo, SpacesWallet, WalletConfig, WalletDescriptors, WalletInfo, @@ -46,6 +49,7 @@ use crate::{ AddressKind, Balance, RpcWallet, TxResponse, WalletCommand, WalletOutput, WalletResponse, }, }; +use crate::store::Sha256; pub(crate) type Responder = oneshot::Sender; @@ -55,6 +59,8 @@ pub struct ServerInfo { pub tip: ChainAnchor, } + + pub enum ChainStateCommand { GetTip { resp: Responder>, @@ -86,7 +92,7 @@ pub enum ChainStateCommand { }, GetRollout { target: usize, - resp: Responder>>, + resp: Responder>>, }, } @@ -101,11 +107,11 @@ pub trait Rpc { async fn get_server_info(&self) -> Result; #[method(name = "getspace")] - async fn get_space(&self, space_hash: &str) -> Result, ErrorObjectOwned>; + async fn get_space(&self, space_or_hash: &str) -> Result, ErrorObjectOwned>; #[method(name = "getspaceowner")] - async fn get_space_owner(&self, space_hash: &str) - -> Result, ErrorObjectOwned>; + async fn get_space_owner(&self, space_or_hash: &str) + -> Result, ErrorObjectOwned>; #[method(name = "getspaceout")] async fn get_spaceout(&self, outpoint: OutPoint) -> Result, ErrorObjectOwned>; @@ -114,7 +120,7 @@ pub trait Rpc { async fn estimate_bid(&self, target: usize) -> Result; #[method(name = "getrollout")] - async fn get_rollout(&self, target: usize) -> Result, ErrorObjectOwned>; + async fn get_rollout(&self, target: usize) -> Result, ErrorObjectOwned>; #[method(name = "getblockmeta")] async fn get_block_meta( @@ -172,7 +178,7 @@ pub trait Rpc { #[method(name = "walletlistspaces")] async fn wallet_list_spaces(&self, wallet: &str) - -> Result, ErrorObjectOwned>; + -> Result, ErrorObjectOwned>; #[method(name = "walletlistunspent")] async fn wallet_list_unspent( @@ -567,8 +573,9 @@ impl RpcServer for RpcServerImpl { Ok(ServerInfo { chain, tip }) } - async fn get_space(&self, space_hash: &str) -> Result, ErrorObjectOwned> { - let space_hash = space_hash_from_string(space_hash)?; + async fn get_space(&self, space_or_hash: &str) -> Result, ErrorObjectOwned> { + let space_hash = get_space_key(space_or_hash)?; + let info = self .store .get_space(space_hash) @@ -579,9 +586,9 @@ impl RpcServer for RpcServerImpl { async fn get_space_owner( &self, - space_hash: &str, + space_or_hash: &str, ) -> Result, ErrorObjectOwned> { - let space_hash = space_hash_from_string(space_hash)?; + let space_hash = get_space_key(space_or_hash)?; let info = self .store .get_space_outpoint(space_hash) @@ -609,7 +616,7 @@ impl RpcServer for RpcServerImpl { Ok(info) } - async fn get_rollout(&self, target: usize) -> Result, ErrorObjectOwned> { + async fn get_rollout(&self, target: usize) -> Result, ErrorObjectOwned> { let rollouts = self .store .get_rollout(target) @@ -928,7 +935,7 @@ impl AsyncChainState { resp_rx.await? } - pub async fn get_rollout(&self, target: usize) -> anyhow::Result> { + pub async fn get_rollout(&self, target: usize) -> anyhow::Result> { let (resp, resp_rx) = oneshot::channel(); self.sender .send(ChainStateCommand::GetRollout { target, resp }) @@ -983,20 +990,29 @@ impl AsyncChainState { } } -fn space_hash_from_string(space_hash: &str) -> Result { +fn get_space_key(space_or_hash: &str) -> Result { + if space_or_hash.len() != 64 { + return Ok( + SpaceKey::from( + Sha256::hash(SLabel::try_from(space_or_hash).map_err(|_| { + ErrorObjectOwned::owned( + -1, + "expected a space name prefixed with @ or a hex encoded space hash", + None::, + ) + })?.as_ref()) + ) + ); + } + let mut hash = [0u8; 32]; - hex::decode_to_slice(space_hash, &mut hash).map_err(|_| { + hex::decode_to_slice(space_or_hash, &mut hash).map_err(|_| { ErrorObjectOwned::owned( -1, - "expected a 32-byte hex encoded space hash", + "expected a space name prefixed with @ or a hex encoded space hash", None::, ) })?; - SpaceKey::from_raw(hash).map_err(|_| { - ErrorObjectOwned::owned( - -1, - "expected a 32-byte hex encoded space hash", - None::, - ) - }) + + Ok(SpaceKey::from(hash)) } diff --git a/node/src/store.rs b/node/src/store.rs index a21f008..3e84efb 100644 --- a/node/src/store.rs +++ b/node/src/store.rs @@ -10,13 +10,9 @@ use std::{ use anyhow::Result; use bincode::{config, Decode, Encode}; -use protocol::{ - bitcoin::OutPoint, - constants::{ChainAnchor, ROLLOUT_BATCH_SIZE}, - hasher::{BidKey, KeyHash, OutpointKey, SpaceKey}, - prepare::DataSource, - FullSpaceOut, SpaceOut, -}; +use jsonrpsee::core::Serialize; +use serde::Deserialize; +use protocol::{bitcoin::OutPoint, constants::{ChainAnchor, ROLLOUT_BATCH_SIZE}, hasher::{BidKey, KeyHash, OutpointKey, SpaceKey}, prepare::DataSource, Covenant, FullSpaceOut, SpaceOut}; use spacedb::{ db::{Database, SnapshotIterator}, fs::FileBackend, @@ -24,6 +20,12 @@ use spacedb::{ Configuration, Hash, NodeHasher, Sha256Hasher, }; +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct RolloutEntry { + pub space: String, + pub value: u32 +} + type SpaceDb = Database; type ReadTx = ReadTransaction; pub type WriteTx<'db> = WriteTransaction<'db, Sha256Hasher>; @@ -256,7 +258,7 @@ impl LiveSnapshot { .insert(key, Some(value)); } - fn update_snapshot(&mut self, version: u32) -> anyhow::Result<()> { + fn update_snapshot(&mut self, version: u32) -> Result<()> { if self.snapshot.0 != version { self.snapshot.1 = self.db.begin_read()?; let anchor: ChainAnchor = self.snapshot.1.metadata().try_into().map_err(|_| { @@ -315,27 +317,49 @@ impl LiveSnapshot { Ok(()) } - pub fn estimate_bid(&mut self, target: usize) -> anyhow::Result { + pub fn estimate_bid(&mut self, target: usize) -> Result { let rollout = self.get_rollout(target)?; if rollout.is_empty() { return Ok(0); } - let (priority, _) = rollout.last().unwrap(); - Ok(*priority as u64) + let entry = rollout.last().unwrap(); + Ok(entry.value as u64) } - pub fn get_rollout(&mut self, target: usize) -> anyhow::Result> { + pub fn get_rollout(&mut self, target: usize) -> Result> { let skip = target * ROLLOUT_BATCH_SIZE; - let entries = self.get_rollout_entries(Some(ROLLOUT_BATCH_SIZE), skip)?; + let rollouts = self.get_rollout_entries(Some(ROLLOUT_BATCH_SIZE), skip)?; + let mut spaceouts = Vec::with_capacity(rollouts.len()); + for (priority, spacehash) in rollouts { + let outpoint = self.get_space_outpoint(&spacehash)?; + if let Some(outpoint) = outpoint { + if let Some(spaceout) = self.get_spaceout(&outpoint)? { + spaceouts.push((priority, FullSpaceOut { txid: outpoint.txid, spaceout })); + } + } + } - Ok(entries) + let data: Vec<_> = spaceouts + .into_iter() + .map(|(priority, spaceout)| { + let space = spaceout.spaceout.space.unwrap(); + RolloutEntry { + space: space.name.to_string(), + value: match space.covenant { + Covenant::Bid { .. } => priority, + _ => 0, + }, + } + }) + .collect(); + Ok(data) } pub fn get_rollout_entries( &mut self, limit: Option, skip: usize, - ) -> anyhow::Result> { + ) -> Result> { // TODO: this could use some clean up let rlock = self.staged.read().expect("acquire lock"); let mut deleted = BTreeSet::new(); @@ -387,10 +411,10 @@ impl LiveSnapshot { } } -impl protocol::prepare::DataSource for LiveSnapshot { +impl DataSource for LiveSnapshot { fn get_space_outpoint( &mut self, - space_hash: &protocol::hasher::SpaceKey, + space_hash: &SpaceKey, ) -> protocol::errors::Result> { let result: Option = self .get(*space_hash) diff --git a/node/src/wallets.rs b/node/src/wallets.rs index 337d499..c0135c2 100644 --- a/node/src/wallets.rs +++ b/node/src/wallets.rs @@ -479,7 +479,7 @@ impl RpcWallet { Ok(sname) => sname, Err(_) => { return Err(anyhow!( - "recipient must be a valid space name or an address" + "recipient must be a valid space name prefixed with @ or an address" )); } }; diff --git a/protocol/src/constants.rs b/protocol/src/constants.rs index 2ca677e..1d964ca 100644 --- a/protocol/src/constants.rs +++ b/protocol/src/constants.rs @@ -69,14 +69,10 @@ impl ChainAnchor { // Testnet4 activation block pub const TESTNET4: fn() -> Self = || { - Self::new( - [ - 0x66, 0x02, 0x57, 0xdf, 0x48, 0xcb, 0xd5, 0x82, 0xf0, 0xa8, 0x5d, 0x9e, 0xad, 0x85, - 0x3d, 0x68, 0x8f, 0x7a, 0x90, 0x0d, 0x56, 0x79, 0xe0, 0x63, 0x08, 0x00, 0x00, 0x00, - 0x00, 0x00, 0x00, 0x00, - ], - 50_000, - ) + Self { + hash: BlockHash::all_zeros(), + height: 50_000, + } }; // Testnet activation block