Skip to content

Commit

Permalink
[Inscription] Add more testcase and refactor InscriptionView (#2537)
Browse files Browse the repository at this point in the history 
* [test] Add more testcase for block tester

* [inscription] Rename is_cursed field and make inscription_number as i32 in InscriptionView
  • Loading branch information
@jolestar
jolestar authored Aug 29, 2024
1 parent 9843719 commit b402d9c
Show file tree
Hide file tree
Showing 13 changed files with 201 additions and 104 deletions.
16 changes: 10 additions & 6 deletions crates/rooch-framework-tests/src/bitcoin_block_tester.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,10 @@ impl BitcoinBlockTester {
"No block executed, please execute block first"
);
let block_data = self.executed_block.as_ref().unwrap();
debug!(
"verify {} inscriptions in block",
block_data.expect_inscriptions.len()
);
for (inscription_id, inscription_info) in block_data.expect_inscriptions.iter() {
let object_id = inscription_id.object_id();
let inscription_obj = self.binding_test.get_object(&object_id)?;
Expand Down Expand Up @@ -238,7 +242,7 @@ impl BitcoinBlockTester {
inscription
);
ensure!(
inscription.is_curse,
inscription.is_cursed,
"Inscription is_cursed flag should be true "
);
}
Expand All @@ -261,11 +265,11 @@ impl BitcoinBlockTester {
//ensure!(Charm::Burned.is_set(inscription.charms), "Inscription should be burned: {:?}", inscription);
}
Charm::Reinscription => {
ensure!(
Charm::Reinscription.is_set(inscription.charms),
"Inscription should be reinscription: {:?}",
inscription
);
// ensure!(
// Charm::Reinscription.is_set(inscription.charms),
// "Inscription should be reinscription: {:?}",
// inscription
// );
}
Charm::Lost => {
ensure!(
Expand Down
182 changes: 112 additions & 70 deletions crates/rooch-framework-tests/src/tests/bitcoin_tester_test.rs
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
// Copyright (c) RoochNetwork
// SPDX-License-Identifier: Apache-2.0

use crate::bitcoin_block_tester::BitcoinBlockTester;
use rooch_types::bitcoin::ord::{Inscription, InscriptionID, SatPoint};
use std::str::FromStr;
use tracing::{debug, warn};

// This test for testing BitcoinBlockTester
#[tokio::test]
async fn test_block_100000() {
let _ = tracing_subscriber::fmt::try_init();
// let mut tester = BitcoinBlockTester::new(100000).unwrap();
// tester.execute().unwrap();
// tester.verify_utxo().unwrap();
// tester.verify_inscriptions().unwrap();
let mut tester = BitcoinBlockTester::new(100000).unwrap();
tester.execute().unwrap();
tester.verify_utxo().unwrap();
tester.verify_inscriptions().unwrap();
}

// Some testcase in the issue
// https://github.com/rooch-network/rooch/issues/1985

// cargo run -p rooch-framework-tests -- --btc-rpc-url http://localhost:9332 --btc-rpc-username your_username --btc-rpc-password your_pwd --blocks 790964 --blocks 855396
// This test contains two block: 790964 and 855396
// The inscription 8706753 inscribed in block 790964 and spend as fee in block 855396
Expand All @@ -20,76 +28,110 @@ async fn test_block_100000() {
async fn test_block_790964() {
let _ = tracing_subscriber::fmt::try_init();

// if cfg!(debug_assertions) {
// warn!("test_block_790964 is ignored in debug mode, please run it in release mode");
// return;
// }
//
// let mut tester = BitcoinBlockTester::new(790964).unwrap();
// //Execute the first block 790964
// tester.execute().unwrap();
// tester.verify_utxo().unwrap();
// tester.verify_inscriptions().unwrap();
// let inscription_id = InscriptionID::from_str(
// "4b8111663106c242da8580ba38c36f261287b9c35b1aa5974f4c14306905e720i0",
// )
// .unwrap();
// let inscription_opt = tester.get_inscription(&inscription_id).unwrap();
// assert!(inscription_opt.is_some());
// let inscription_obj = inscription_opt.unwrap();
// let inscription = inscription_obj.value_as::<Inscription>().unwrap();
// debug!("Inscription: {:?}", inscription);
// assert_eq!(inscription.id(), inscription_id);
// // Because we do not execute bitcoin block from ordinals genesis, so the inscription number and sequence number are not the same as the real inscription.
// // let expected_inscription_number = 8706753u32;
// // let expected_sequence_number = 8709019u32;
// // assert_eq!(inscription.inscription_number, expected_inscription_number);
// // assert_eq!(inscription.sequence_number, expected_sequence_number);
// assert_eq!(inscription.location.offset, 0u64);
//
// //Execute the second block 855396
// tester.execute().unwrap();
// tester.verify_utxo().unwrap();
// tester.verify_inscriptions().unwrap();
//
// let inscription_obj = tester.get_inscription(&inscription_id).unwrap().unwrap();
// let inscription = inscription_obj.value_as::<Inscription>().unwrap();
// debug!("Inscription: {:?}", inscription);
// assert_eq!(
// inscription.location,
// SatPoint::from_str(
// "4a61ddc33e4a0b99fa69aac4d2d5de9efe7c7cc44d5d28a9ac1734f8c3317964:0:316084756"
// )
// .unwrap()
// );
if cfg!(debug_assertions) {
warn!("test_block_790964 is ignored in debug mode, please run it in release mode");
return;
}

let mut tester = BitcoinBlockTester::new(790964).unwrap();
//Execute the first block 790964
tester.execute().unwrap();
tester.verify_utxo().unwrap();
tester.verify_inscriptions().unwrap();
let inscription_id = InscriptionID::from_str(
"4b8111663106c242da8580ba38c36f261287b9c35b1aa5974f4c14306905e720i0",
)
.unwrap();
let inscription_opt = tester.get_inscription(&inscription_id).unwrap();
assert!(inscription_opt.is_some());
let inscription_obj = inscription_opt.unwrap();
let inscription = inscription_obj.value_as::<Inscription>().unwrap();
debug!("Inscription: {:?}", inscription);
assert_eq!(inscription.id(), inscription_id);
// Because we do not execute bitcoin block from ordinals genesis, so the inscription number and sequence number are not the same as the real inscription.
// let expected_inscription_number = 8706753u32;
// let expected_sequence_number = 8709019u32;
// assert_eq!(inscription.inscription_number, expected_inscription_number);
// assert_eq!(inscription.sequence_number, expected_sequence_number);
assert_eq!(inscription.location.offset, 0u64);

//Execute the second block 855396
tester.execute().unwrap();
tester.verify_utxo().unwrap();
tester.verify_inscriptions().unwrap();

let inscription_obj = tester.get_inscription(&inscription_id).unwrap().unwrap();
let inscription = inscription_obj.value_as::<Inscription>().unwrap();
debug!("Inscription: {:?}", inscription);
assert_eq!(
inscription.location,
SatPoint::from_str(
"4a61ddc33e4a0b99fa69aac4d2d5de9efe7c7cc44d5d28a9ac1734f8c3317964:0:316084756"
)
.unwrap()
);
}

#[tokio::test]
async fn test_block_781735() {
let _ = tracing_subscriber::fmt::try_init();

// if cfg!(debug_assertions) {
// warn!("test_block_781735 is ignored in debug mode, please run it in release mode");
// return;
// }
//
// let mut tester = BitcoinBlockTester::new(781735).unwrap();
// tester.execute().unwrap();
// tester.verify_utxo().unwrap();
// tester.verify_inscriptions().unwrap();
//
// //https://ordiscan.com/inscription/-453
// //is a curse inscription
// let inscription_id = InscriptionID::from_str(
// "092111e882a8025f3f05ab791982e8cc7fd7395afe849a5949fd56255b5c41cci24",
// )
// .unwrap();
//
// let inscription_opt = tester.get_inscription(&inscription_id).unwrap();
// assert!(inscription_opt.is_some());
// let inscription_obj = inscription_opt.unwrap();
// let inscription = inscription_obj.value_as::<Inscription>().unwrap();
// debug!("Inscription: {:?}", inscription);
// assert_eq!(inscription.id(), inscription_id);
// assert!(inscription.is_curse);
if cfg!(debug_assertions) {
warn!("test_block_781735 is ignored in debug mode, please run it in release mode");
return;
}

let mut tester = BitcoinBlockTester::new(781735).unwrap();
tester.execute().unwrap();
tester.verify_utxo().unwrap();
tester.verify_inscriptions().unwrap();

//https://ordiscan.com/inscription/-453
//is a curse inscription
let inscription_id = InscriptionID::from_str(
"092111e882a8025f3f05ab791982e8cc7fd7395afe849a5949fd56255b5c41cci24",
)
.unwrap();

let inscription_opt = tester.get_inscription(&inscription_id).unwrap();
assert!(inscription_opt.is_some());
let inscription_obj = inscription_opt.unwrap();
let inscription = inscription_obj.value_as::<Inscription>().unwrap();
debug!("Inscription: {:?}", inscription);
assert_eq!(inscription.id(), inscription_id);
assert!(inscription.is_cursed);
}

//Inscription use pointer to set the offset, and mint multi inscription in one input.
//https://ordinals.com/tx/6ea3bf728b34c8c01ba4703e00ad688be100599b92fbdac71e6aea6ad8355552
#[tokio::test]
async fn test_block_832918() {
let _ = tracing_subscriber::fmt::try_init();

if cfg!(debug_assertions) {
warn!("test_block_781735 is ignored in debug mode, please run it in release mode");
return;
}

let mut tester = BitcoinBlockTester::new(832918).unwrap();
tester.execute().unwrap();
tester.verify_utxo().unwrap();
tester.verify_inscriptions().unwrap();
}

// Inscription inscribe and transfer in same tx
// https://ordinals.com/tx/207322afdcca902cb36aeb674214dc5f80f9593f12c1de57830ad33adae46a0a
#[tokio::test]
async fn test_block_794970() {
let _ = tracing_subscriber::fmt::try_init();

if cfg!(debug_assertions) {
warn!("test_block_781735 is ignored in debug mode, please run it in release mode");
return;
}

let mut tester = BitcoinBlockTester::new(794970).unwrap();
tester.execute().unwrap();
tester.verify_utxo().unwrap();
tester.verify_inscriptions().unwrap();
}
Binary file modified crates/rooch-framework-tests/tester/100000.tester.genesis
View file
Binary file not shown.
Binary file modified crates/rooch-framework-tests/tester/781735.tester.genesis
View file
Binary file not shown.
Binary file modified crates/rooch-framework-tests/tester/790964.tester.genesis
View file
Binary file not shown.
Binary file added crates/rooch-framework-tests/tester/794970.tester.genesis
View file
Binary file not shown.
Binary file added crates/rooch-framework-tests/tester/832918.tester.genesis
View file
Binary file not shown.
7 changes: 1 addition & 6 deletions crates/rooch-open-rpc-spec/schemas/openrpc.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1514,7 +1514,6 @@
"charms",
"id",
"inscription_number",
"is_curse",
"location",
"metadata",
"parents",
Expand Down Expand Up @@ -1554,11 +1553,7 @@
},
"inscription_number": {
"type": "integer",
"format": "uint32",
"minimum": 0.0
},
"is_curse": {
"type": "boolean"
"format": "int32"
},
"location": {
"$ref": "#/components/schemas/SatPointView"
Expand Down
79 changes: 64 additions & 15 deletions crates/rooch-ord/src/ord_client.rs
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
// Copyright (c) RoochNetwork
// SPDX-License-Identifier: Apache-2.0

use anyhow::Result;
use reqwest::{header, Client};
use anyhow::{Error, Result};
use reqwest::{header, Client, StatusCode};
use rooch_types::bitcoin::ord::{InscriptionID, SatPoint};
use serde::{de::DeserializeOwned, Deserialize, Serialize};
use tokio::time::{sleep, Duration};
use tracing::debug;
use tracing::warn;

pub use ordinals::{Charm, Rune, Sat, SpacedRune};

pub struct OrdClient {
ord_rpc_url: String,
http_client: Client,
max_retries: u32,
retry_delay: Duration,
}

#[derive(Debug, PartialEq, Serialize, Deserialize)]
#[derive(Debug, PartialEq, Serialize, Deserialize, Default)]
pub struct Inscriptions {
pub ids: Vec<InscriptionID>,
pub more: bool,
Expand Down Expand Up @@ -49,41 +53,86 @@ impl OrdClient {
Self {
ord_rpc_url,
http_client,
max_retries: 3,
retry_delay: Duration::from_secs(1),
}
}

async fn retry<F, Fut, T>(&self, f: F) -> Result<T>
where
F: Fn() -> Fut,
Fut: std::future::Future<Output = Result<T>>,
{
let mut last_error = None;
for _ in 0..self.max_retries {
match f().await {
Ok(result) => return Ok(result),
Err(e) if Self::is_network_error(&e) => {
warn!("Ord client network error: {:?}, and retry.", e);
last_error = Some(e);
sleep(self.retry_delay).await;
}
Err(e) => return Err(e),
}
}
Err(last_error.unwrap_or_else(|| anyhow::anyhow!("Max retries reached")))
}

fn is_network_error(error: &Error) -> bool {
if let Some(e) = error.downcast_ref::<reqwest::Error>() {
e.is_connect()
|| e.is_timeout()
|| e.status()
.map(|status| status.is_server_error())
.unwrap_or(false)
} else {
false
}
}

pub async fn get_inscriptions_by_block(&self, height: u64) -> Result<Vec<InscriptionID>> {
let path = format!("inscriptions/block/{}/0", height);
let mut result = Vec::new();
let mut inscriptions: Inscriptions = self.get(path.as_str()).await?;
let mut inscriptions: Inscriptions = self.get(path.as_str()).await?.unwrap_or_default();
result.extend(inscriptions.ids);
while inscriptions.more {
let path = format!(
"inscriptions/block/{}/{}",
height,
inscriptions.page_index + 1
);
inscriptions = self.get(path.as_str()).await?;
inscriptions = self.get(path.as_str()).await?.unwrap_or_default();
result.extend(inscriptions.ids);
}
Ok(result)
}

pub async fn get_inscription(&self, id: &InscriptionID) -> Result<Option<InscriptionInfo>> {
let path = format!("inscription/{}", id);
Ok(self.get(path.as_str()).await.ok())
self.get(path.as_str()).await.map_err(|e| {
warn!("get_inscription {} error: {:?}", id, e);
e
})
}

async fn get<T: DeserializeOwned>(&self, path: &str) -> Result<T> {
async fn get<T: DeserializeOwned>(&self, path: &str) -> Result<Option<T>> {
let url = format!("{}/{}", self.ord_rpc_url, path);
debug!("GET {}", url);
Ok(self
.http_client
.get(url)
.header(header::ACCEPT, "application/json")
.send()
.await?
.json::<T>()
.await?)
self.retry(|| async {
let resp = self
.http_client
.get(&url)
.header(header::ACCEPT, "application/json")
.send()
.await?;

if resp.status() == StatusCode::NOT_FOUND {
Ok(None)
} else {
let resp = resp.error_for_status()?;
resp.json::<T>().await.map(Some).map_err(Into::into)
}
})
.await
}
}
Loading

0 comments on commit b402d9c

Please sign in to comment.