Skip to content

Commit 38153ca

Browse files
author
Ludo Galabru
committed
fix: documentation drift
1 parent 9816cbb commit 38153ca

File tree

5 files changed

+19
-31
lines changed

5 files changed

+19
-31
lines changed

‎README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -129,15 +129,15 @@ The current `bitcoin` predicates supports the following `if_this` constructs:
129129
// Broadcasted payloads include Proof of Transfer reward informations.
130130
{
131131
"if_this": {
132-
"protocol": "stacks",
132+
"scope": "stacks_protocol",
133133
"operation": "block_committed"
134134
}
135135
}
136136

137137
// Get any transaction including a key registration operation
138138
{
139139
"if_this": {
140-
"protocol": "stacks",
140+
"scope": "stacks_protocol",
141141
"operation": "leader_key_registered"
142142
}
143143
}
@@ -146,7 +146,7 @@ The current `bitcoin` predicates supports the following `if_this` constructs:
146146
// Coming soon
147147
{
148148
"if_this": {
149-
"protocol": "stacks",
149+
"scope": "stacks_protocol",
150150
"operation": "stx_transfered"
151151
}
152152
}
@@ -155,15 +155,15 @@ The current `bitcoin` predicates supports the following `if_this` constructs:
155155
// Coming soon
156156
{
157157
"if_this": {
158-
"protocol": "stacks",
158+
"scope": "stacks_protocol",
159159
"operation": "stx_locked"
160160
}
161161
}
162162

163163
// Get any transaction including a new Ordinal inscription (inscription revealed and transfered)
164164
{
165165
"if_this": {
166-
"protocol": "ordinals",
166+
"scope": "ordinals_protocol",
167167
"operation": "inscription_feed"
168168
}
169169
}

‎components/chainhook-cli/src/cli/mod.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use crate::service::Service;
88
use chainhook_event_observer::bitcoincore_rpc::{Auth, Client, RpcApi};
99
use chainhook_event_observer::chainhooks::types::{
1010
BitcoinChainhookFullSpecification, BitcoinChainhookNetworkSpecification, BitcoinPredicateType,
11-
ChainhookFullSpecification, FileHook, HookAction, OrdinalOperations, Protocols,
11+
ChainhookFullSpecification, FileHook, HookAction, OrdinalOperations,
1212
StacksChainhookFullSpecification, StacksChainhookNetworkSpecification, StacksPredicate,
1313
StacksPrintEventBasedPredicate,
1414
};
@@ -463,9 +463,9 @@ async fn handle_command(opts: Opts, ctx: Context) -> Result<(), String> {
463463
BitcoinChainhookNetworkSpecification {
464464
start_block: Some(0),
465465
end_block: Some(100),
466-
predicate: BitcoinPredicateType::Protocol(Protocols::Ordinal(
466+
predicate: BitcoinPredicateType::OrdinalsProtocol(
467467
OrdinalOperations::InscriptionFeed,
468-
)),
468+
),
469469
expire_after_occurrence: None,
470470
action: HookAction::FileAppend(FileHook {
471471
path: "ordinals.txt".into(),

‎components/chainhook-cli/src/scan/bitcoin.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use chainhook_event_observer::chainhooks::bitcoin::{
66
BitcoinChainhookOccurrence, BitcoinTriggerChainhook,
77
};
88
use chainhook_event_observer::chainhooks::types::{
9-
BitcoinChainhookSpecification, BitcoinPredicateType, Protocols,
9+
BitcoinChainhookSpecification, BitcoinPredicateType,
1010
};
1111
use chainhook_event_observer::hord::db::{
1212
fetch_and_cache_blocks_in_hord_db, find_all_inscriptions, find_block_at_block_height,
@@ -71,7 +71,7 @@ pub async fn scan_bitcoin_chainstate_via_http_using_predicate(
7171
let mut is_predicate_evaluating_ordinals = false;
7272
let mut hord_blocks_requires_update = false;
7373

74-
if let BitcoinPredicateType::Protocol(Protocols::Ordinal(_)) = &predicate_spec.predicate {
74+
if let BitcoinPredicateType::OrdinalsProtocol(_) = &predicate_spec.predicate {
7575
is_predicate_evaluating_ordinals = true;
7676
if let Ok(inscriptions_db_conn) =
7777
open_readonly_hord_db_conn(&config.expected_cache_path(), &ctx)

‎components/chainhook-event-observer/src/chainhooks/bitcoin/mod.rs

+7-13
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use super::types::{
22
BitcoinChainhookSpecification, BitcoinPredicateType, ExactMatchingRule, HookAction,
3-
InputPredicate, MatchingRule, OrdinalOperations, OutputPredicate, Protocols, StacksOperations,
3+
InputPredicate, MatchingRule, OrdinalOperations, OutputPredicate, StacksOperations,
44
};
55
use crate::utils::Context;
66

@@ -373,53 +373,47 @@ impl BitcoinPredicateType {
373373
// TODO(lgalabru)
374374
unimplemented!()
375375
}
376-
BitcoinPredicateType::Protocol(Protocols::Stacks(
377-
StacksOperations::StackerRewarded,
378-
)) => {
376+
BitcoinPredicateType::StacksProtocol(StacksOperations::StackerRewarded) => {
379377
for op in tx.metadata.stacks_operations.iter() {
380378
if let StacksBaseChainOperation::BlockCommitted(_) = op {
381379
return true;
382380
}
383381
}
384382
false
385383
}
386-
BitcoinPredicateType::Protocol(Protocols::Stacks(StacksOperations::BlockCommitted)) => {
384+
BitcoinPredicateType::StacksProtocol(StacksOperations::BlockCommitted) => {
387385
for op in tx.metadata.stacks_operations.iter() {
388386
if let StacksBaseChainOperation::BlockCommitted(_) = op {
389387
return true;
390388
}
391389
}
392390
false
393391
}
394-
BitcoinPredicateType::Protocol(Protocols::Stacks(
395-
StacksOperations::LeaderRegistered,
396-
)) => {
392+
BitcoinPredicateType::StacksProtocol(StacksOperations::LeaderRegistered) => {
397393
for op in tx.metadata.stacks_operations.iter() {
398394
if let StacksBaseChainOperation::LeaderRegistered(_) = op {
399395
return true;
400396
}
401397
}
402398
false
403399
}
404-
BitcoinPredicateType::Protocol(Protocols::Stacks(StacksOperations::StxTransfered)) => {
400+
BitcoinPredicateType::StacksProtocol(StacksOperations::StxTransfered) => {
405401
for op in tx.metadata.stacks_operations.iter() {
406402
if let StacksBaseChainOperation::StxTransfered(_) = op {
407403
return true;
408404
}
409405
}
410406
false
411407
}
412-
BitcoinPredicateType::Protocol(Protocols::Stacks(StacksOperations::StxLocked)) => {
408+
BitcoinPredicateType::StacksProtocol(StacksOperations::StxLocked) => {
413409
for op in tx.metadata.stacks_operations.iter() {
414410
if let StacksBaseChainOperation::StxLocked(_) = op {
415411
return true;
416412
}
417413
}
418414
false
419415
}
420-
BitcoinPredicateType::Protocol(Protocols::Ordinal(
421-
OrdinalOperations::InscriptionFeed,
422-
)) => {
416+
BitcoinPredicateType::OrdinalsProtocol(OrdinalOperations::InscriptionFeed) => {
423417
for op in tx.metadata.ordinal_operations.iter() {
424418
if let OrdinalOperation::InscriptionRevealed(_) = op {
425419
return true;

‎components/chainhook-event-observer/src/chainhooks/types.rs

+2-8
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,8 @@ pub enum BitcoinPredicateType {
469469
Txid(ExactMatchingRule),
470470
Inputs(InputPredicate),
471471
Outputs(OutputPredicate),
472-
Protocol(Protocols),
472+
StacksProtocol(StacksOperations),
473+
OrdinalsProtocol(OrdinalOperations),
473474
}
474475

475476
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, JsonSchema)]
@@ -489,13 +490,6 @@ pub enum OutputPredicate {
489490
P2wsh(ExactMatchingRule),
490491
}
491492

492-
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, JsonSchema)]
493-
#[serde(rename_all = "snake_case")]
494-
pub enum Protocols {
495-
Stacks(StacksOperations),
496-
Ordinal(OrdinalOperations),
497-
}
498-
499493
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, JsonSchema)]
500494
#[serde(rename_all = "snake_case")]
501495
pub enum StacksOperations {

0 commit comments

Comments
 (0)