Merge pull request #458 from hirosystems/feat/ordhook-schemas

feat: update ordhook schemas
hirosystems · Nov 17, 2023 · 2973c22 · 2973c22
2 parents b47713c + 0017f7e
commit 2973c22
Show file tree

Hide file tree

Showing 10 changed files with 782 additions and 1,020 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -5,3 +5,7 @@ members = [
     "components/chainhook-types-rs",
 ]
 default-members = ["components/chainhook-cli", "components/chainhook-sdk"]
+resolver = "2"
+
+[replace]
+"jsonrpc:0.13.0" = { git = 'https://github.com/apoelstra/rust-jsonrpc', rev = "1063671f122a8985c1b7c29030071253da515839" }
diff --git a/components/chainhook-cli/Cargo.toml b/components/chainhook-cli/Cargo.toml
@@ -15,10 +15,9 @@ redis = "0.21.5"
 serde-redis = "0.12.0"
 hex = "0.4.3"
 rand = "0.8.5"
-chainhook-sdk = { version = "0.10.0", default-features = false, features = [
+chainhook-sdk = { version = "0.11.0", default-features = false, features = [
     "zeromq",
 ], path = "../chainhook-sdk" }
-clarinet-files = "2"
 hiro-system-kit = "0.3.1"
 # clarinet-files = { path = "../../../clarinet/components/clarinet-files" }
 # hiro-system-kit = { path = "../../../clarinet/components/hiro-system-kit" }

diff --git a/components/chainhook-cli/src/config/file.rs b/components/chainhook-cli/src/config/file.rs
@@ -60,6 +60,7 @@ pub enum NetworkConfigMode {
     Devnet,
     Testnet,
     Mainnet,
+    Signet,
 }
 
 impl NetworkConfigMode {
@@ -68,13 +69,15 @@ impl NetworkConfigMode {
             BitcoinNetwork::Regtest => NetworkConfigMode::Devnet,
             BitcoinNetwork::Testnet => NetworkConfigMode::Testnet,
             BitcoinNetwork::Mainnet => NetworkConfigMode::Mainnet,
+            BitcoinNetwork::Signet => NetworkConfigMode::Signet,
         }
     }
     pub fn as_str(&self) -> &str {
         match self {
             NetworkConfigMode::Devnet => "devnet",
             NetworkConfigMode::Testnet => "testnet",
             NetworkConfigMode::Mainnet => "mainnet",
+            NetworkConfigMode::Signet => "signet",
         }
     }
 }
diff --git a/components/chainhook-sdk/Cargo.toml b/components/chainhook-sdk/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "chainhook-sdk"
-version = "0.10.2"
+version = "0.11.0"
 description = "Stateless Transaction Indexing Engine for Stacks and Bitcoin"
 license = "GPL-3.0"
 edition = "2021"
@@ -18,7 +18,7 @@ hiro-system-kit = { version = "0.3.1", optional = true }
 # stacks-rpc-client = { version = "1", path = "../../../clarinet/components/stacks-rpc-client" }
 # clarinet-utils = { version = "1", path = "../../../clarinet/components/clarinet-utils" }
 # hiro-system-kit = { version = "0.1.0", path = "../../../clarinet/components/hiro-system-kit" }
-chainhook-types = { version = "1.1.0", path = "../chainhook-types-rs" }
+chainhook-types = { version = "1.2.0", path = "../chainhook-types-rs" }
 rocket = { version = "=0.5.0-rc.3", features = ["json"] }
 bitcoincore-rpc = "0.16.0"
 bitcoincore-rpc-json = "0.16.0"
@@ -47,9 +47,6 @@ miniscript = "10.0.0"
 [dev-dependencies]
 test-case = "3.1.0"
 
-[replace]
-"jsonrpc:0.13.0" = { git = 'https://github.com/apoelstra/rust-jsonrpc', rev = "1063671f122a8985c1b7c29030071253da515839" }
-
 [features]
 default = ["hiro-system-kit/log"]
 zeromq = ["zmq"]

diff --git a/components/chainhook-sdk/src/chainhooks/types.rs b/components/chainhook-sdk/src/chainhooks/types.rs
@@ -535,6 +535,7 @@ pub fn get_stacks_canonical_magic_bytes(network: &BitcoinNetwork) -> [u8; 2] {
         BitcoinNetwork::Mainnet => *b"X2",
         BitcoinNetwork::Testnet => *b"T2",
         BitcoinNetwork::Regtest => *b"id",
+        BitcoinNetwork::Signet => unreachable!()
     }
 }
 
@@ -597,6 +598,7 @@ pub fn get_canonical_pox_config(network: &BitcoinNetwork) -> PoxConfig {
         BitcoinNetwork::Mainnet => POX_CONFIG_MAINNET,
         BitcoinNetwork::Testnet => POX_CONFIG_TESTNET,
         BitcoinNetwork::Regtest => POX_CONFIG_DEVNET,
+        BitcoinNetwork::Signet => unreachable!(),
     }
 }
 

diff --git a/components/chainhook-sdk/src/observer/mod.rs b/components/chainhook-sdk/src/observer/mod.rs
@@ -136,6 +136,59 @@ impl EventObserverConfig {
             _ => unreachable!(),
         }
     }
+
+    pub fn new_using_overrides(
+        overrides: Option<&EventObserverConfigOverrides>,
+    ) -> Result<EventObserverConfig, String> {
+        let bitcoin_network =
+            if let Some(network) = overrides.and_then(|c| c.bitcoin_network.as_ref()) {
+                BitcoinNetwork::from_str(network)?
+            } else {
+                BitcoinNetwork::Regtest
+            };
+
+        let stacks_network =
+            if let Some(network) = overrides.and_then(|c| c.stacks_network.as_ref()) {
+                StacksNetwork::from_str(network)?
+            } else {
+                StacksNetwork::Devnet
+            };
+
+        let config = EventObserverConfig {
+            bitcoin_rpc_proxy_enabled: false,
+            chainhook_config: None,
+            ingestion_port: overrides
+                .and_then(|c| c.ingestion_port)
+                .unwrap_or(DEFAULT_INGESTION_PORT),
+            bitcoind_rpc_username: overrides
+                .and_then(|c| c.bitcoind_rpc_username.clone())
+                .unwrap_or("devnet".to_string()),
+            bitcoind_rpc_password: overrides
+                .and_then(|c| c.bitcoind_rpc_password.clone())
+                .unwrap_or("devnet".to_string()),
+            bitcoind_rpc_url: overrides
+                .and_then(|c| c.bitcoind_rpc_url.clone())
+                .unwrap_or("http://localhost:18443".to_string()),
+            bitcoin_block_signaling: overrides
+                .and_then(|c| c.bitcoind_zmq_url.as_ref())
+                .map(|url| BitcoinBlockSignaling::ZeroMQ(url.clone()))
+                .unwrap_or(BitcoinBlockSignaling::Stacks(
+                    StacksNodeConfig::default_localhost(
+                        overrides
+                            .and_then(|c| c.ingestion_port)
+                            .unwrap_or(DEFAULT_INGESTION_PORT),
+                    ),
+                )),
+            display_logs: overrides.and_then(|c| c.display_logs).unwrap_or(false),
+            cache_path: overrides
+                .and_then(|c| c.cache_path.clone())
+                .unwrap_or("cache".to_string()),
+            bitcoin_network,
+            stacks_network,
+            data_handler_tx: None,
+        };
+        Ok(config)
+    }
 }
 
 #[derive(Deserialize, Debug)]

diff --git a/components/chainhook-types-rs/Cargo.toml b/components/chainhook-types-rs/Cargo.toml
@@ -2,7 +2,7 @@
 name = "chainhook-types"
 description = "Bitcoin and Stacks data schemas, based on the Rosetta specification"
 license = "MIT"
-version = "1.1.0"
+version = "1.2.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

diff --git a/components/chainhook-types-rs/src/rosetta.rs b/components/chainhook-types-rs/src/rosetta.rs
@@ -324,13 +324,21 @@ pub enum OrdinalOperation {
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
 pub struct OrdinalInscriptionTransferData {
     pub inscription_id: String,
-    pub updated_address: Option<String>,
+    pub destination: OrdinalInscriptionTransferDestination,
     pub satpoint_pre_transfer: String,
     pub satpoint_post_transfer: String,
     pub post_transfer_output_value: Option<u64>,
     pub tx_index: usize,
 }
 
+#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
+#[serde(tag = "type", content = "value", rename_all = "snake_case")]
+pub enum OrdinalInscriptionTransferDestination {
+    Transferred(String),
+    SpentInFees,
+    Burnt(String),
+}
+
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
 pub enum OrdinalInscriptionCurseType {
     Tag(u8),
@@ -877,6 +885,7 @@ impl StacksNetwork {
 pub enum BitcoinNetwork {
     Regtest,
     Testnet,
+    Signet,
     Mainnet,
 }
 
@@ -886,9 +895,10 @@ impl BitcoinNetwork {
             "regtest" => BitcoinNetwork::Regtest,
             "testnet" => BitcoinNetwork::Testnet,
             "mainnet" => BitcoinNetwork::Mainnet,
+            "signet" => BitcoinNetwork::Signet,
             _ => {
                 return Err(format!(
-                    "network '{}' unsupported (mainnet, testnet, regtest)",
+                    "network '{}' unsupported (mainnet, testnet, regtest, signet)",
                     network
                 ))
             }

diff --git a/docs/chainhook-openapi.json b/docs/chainhook-openapi.json
@@ -211,6 +211,17 @@
                       }
                     }
                   },
+                  {
+                    "type": "object",
+                    "required": [
+                      "signet"
+                    ],
+                    "properties": {
+                      "signet": {
+                        "$ref": "#/components/schemas/BitcoinChainhookNetworkSpecification"
+                      }
+                    }
+                  },
                   {
                     "type": "object",
                     "required": [
@@ -314,6 +325,7 @@
         "enum": [
           "regtest",
           "testnet",
+          "signet",
           "mainnet"
         ]
       },