Struct ergo_node_interface::scanning::Scan

pub struct Scan {
    pub name: String,
    pub id: ScanID,
    pub node_interface: NodeInterface,
}

A Scan is a name + scan_id for a given scan with extra methods for acquiring boxes.

Fields

name: String

id: ScanID

node_interface: NodeInterface

Implementations

impl Scan

pub fn new(name: &str, scan_id: &str, node_interface: &NodeInterface) -> Scan

Manually create a new Scan struct. It is assumed that a scan with the given id has already been registered with the Ergo Node and the developer is simply creating a struct for the given scan.

pub fn register(
    name: &String,
    tracking_rule: JsonValue,
    node_interface: &NodeInterface
) -> Result<Scan>

Register a new scan in the Ergo Node and builds/returns a Scan struct in a Result.

pub fn get_boxes(&self) -> Result<Vec<ErgoBox>>

Returns all ErgoBoxes found by the scan

pub fn get_box(&self) -> Result<ErgoBox>

Returns the first ErgoBox found by the scan

pub fn get_serialized_boxes(&self) -> Result<Vec<String>>

Returns all ErgoBoxes found by the scan serialized and ready to be used as rawInputs

pub fn get_serialized_box(&self) -> Result<String>

Returns the first ErgoBox found by the registered scan serialized and ready to be used as a rawInput

pub fn save_scan_ids_locally(scans: Vec<Scan>) -> Result<bool>

Saves UTXO-set scans (specifically id) to local scanIDs.json

pub fn read_local_scan_ids(node: &NodeInterface) -> Result<Vec<Scan>>

Read UTXO-set scan ids from local scanIDs.json

pub fn serialize_p2pk_for_tracking(
    node: &NodeInterface,
    address: &P2PKAddressString
) -> Result<String>

Serialize a “P2PKAddressString” to be used within a scan tracking rule

Trait Implementations

impl Clone for Scan

fn clone(&self) -> Scan

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Scan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.