Struct NodeInterface

pub struct NodeInterface {
    pub api_key: String,
    pub url: Url,
}

The NodeInterface struct which holds the relevant Ergo node data and has methods implemented to interact with the node.

Fields

api_key: String

url: Url

Implementations

impl NodeInterface

pub fn new(api_key: &str, ip: &str, port: &str) -> Result<Self>

Create a new NodeInterface using details about the Node Sets url to http://ip:port using ip and port

pub fn from_url(api_key: &str, url: Url) -> Self

pub fn from_url_str(api_key: &str, url: &str) -> Result<Self>

pub fn unspent_boxes_by_address( &self, address: &P2PKAddressString, offset: u64, limit: u64, ) -> Result<Vec<ErgoBox>>

Acquires unspent boxes from the blockchain by specific address

pub fn unspent_boxes_by_token_id( &self, token_id: &TokenId, offset: u64, limit: u64, ) -> Result<Vec<ErgoBox>>

Acquires unspent boxes from the blockchain by specific token_id

pub fn nano_ergs_balance(&self, address: &P2PKAddressString) -> Result<NanoErg>

Get the current nanoErgs balance held in the address

pub fn p2s_to_tree(&self, address: &P2SAddressString) -> Result<String>

Given a P2S Ergo address, extract the hex-encoded serialized ErgoTree (script)

pub fn p2s_to_bytes(&self, address: &P2SAddressString) -> Result<String>

Given a P2S Ergo address, convert it to a hex-encoded Sigma byte array constant

pub fn p2pk_to_raw(&self, address: &P2PKAddressString) -> Result<String>

Given an Ergo P2PK Address, convert it to a raw hex-encoded EC point

pub fn p2pk_to_raw_for_register( &self, address: &P2PKAddressString, ) -> Result<String>

Given an Ergo P2PK Address, convert it to a raw hex-encoded EC point and prepend the type bytes so it is encoded and ready to be used in a register.

pub fn raw_to_p2pk(&self, raw: &str) -> Result<P2PKAddressString>

Given a raw hex-encoded EC point, convert it to a P2PK address

pub fn raw_from_register_to_p2pk( &self, typed_raw: &str, ) -> Result<P2PKAddressString>

Given a raw hex-encoded EC point from a register (thus with type encoded characters in front), convert it to a P2PK address

pub fn serialize_boxes(&self, b: &[ErgoBox]) -> Result<Vec<String>>

Given a Vec<ErgoBox> return the given boxes (which must be part of the UTXO-set) as a vec of serialized strings in Base16 encoding

pub fn serialize_box(&self, b: &ErgoBox) -> Result<String>

Given an ErgoBox return the given box (which must be part of the UTXO-set) as a serialized string in Base16 encoding

pub fn serialized_box_from_id(&self, box_id: &String) -> Result<String>

Given a box id return the given box (which must be part of the UTXO-set) as a serialized string in Base16 encoding

pub fn box_from_id(&self, box_id: &String) -> Result<ErgoBox>

Given a box id return the given box (which must be part of the UTXO-set) as a serialized string in Base16 encoding

pub fn current_block_height(&self) -> Result<BlockHeight>

Get the current block height of the blockchain

pub fn get_state_context(&self) -> Result<ErgoStateContext>

Get the current state context of the blockchain

pub fn get_last_block_headers(&self, number: u32) -> Result<Vec<Header>>

Get the last number of block headers from the blockchain

pub fn indexer_status(&self) -> Result<IndexerStatus>

Checks if the blockchain indexer is active by querying the node.

impl NodeInterface

pub fn get_node_api_header(&self) -> HeaderValue

Builds a HeaderValue to use for requests with the api key specified

pub fn set_req_headers(&self, rb: RequestBuilder) -> RequestBuilder

Sets required headers for a request

pub fn send_get_req(&self, endpoint: &str) -> Result<Response>

Sends a GET request to the Ergo node

pub fn send_post_req(&self, endpoint: &str, body: String) -> Result<Response>

Sends a POST request to the Ergo node

pub fn parse_response_to_json( &self, resp: Result<Response>, ) -> Result<JsonValue>

Parses response from node into JSON

pub fn use_json_endpoint_and_check_errors( &self, endpoint: &str, json_body: &JsonString, ) -> Result<JsonValue>

General function for submitting a Json String body to an endpoint which also returns a JsonValue response.

impl NodeInterface

Scanning-related endpoints

pub fn register_scan(&self, scan_json: Value) -> Result<ScanId>

Registers a scan with the node and either returns the scan_id or an error

pub fn deregister_scan(&self, scan_id: ScanId) -> Result<ScanId>

pub fn scan_boxes(&self, scan_id: ScanId) -> Result<Vec<ErgoBox>>

Using the scan_id of a registered scan, acquires unspent boxes which have been found by said scan

pub fn add_box_to_scan( &self, scan_id: ScanId, box_id: &String, ) -> Result<String>

Using the scan_id of a registered scan, manually adds a box to said scan.

impl NodeInterface

pub fn submit_json_transaction( &self, signed_tx_json: &JsonString, ) -> Result<TxId>

Submits a Signed Transaction provided as input as JSON to the Ergo Blockchain mempool.

pub fn sign_json_transaction( &self, unsigned_tx_string: &JsonString, ) -> Result<JsonValue>

Sign an Unsigned Transaction which is formatted in JSON

pub fn sign_and_submit_json_transaction( &self, unsigned_tx_string: &JsonString, ) -> Result<TxId>

Sign an Unsigned Transaction which is formatted in JSON and then submit it to the mempool.

pub fn submit_transaction(&self, signed_tx: &Transaction) -> Result<TxId>

Submits a Signed Transaction provided as input to the Ergo Blockchain mempool.

pub fn sign_transaction( &self, unsigned_tx: &UnsignedTransaction, boxes_to_spend: Option<Vec<ErgoBox>>, data_input_boxes: Option<Vec<ErgoBox>>, ) -> Result<Transaction>

Sign an UnsignedTransaction unsigned_tx - The unsigned transaction to sign. boxes_to_spend - optional list of input boxes. If not provided, the node will search for the boxes in UTXO data_input_boxes - optional list of data boxes. If not provided, the node will search for the data boxes in UTXO

pub fn sign_and_submit_transaction( &self, unsigned_tx: &UnsignedTransaction, ) -> Result<TxId>

Sign an UnsignedTransaction and then submit it to the mempool.

pub fn generate_and_submit_transaction( &self, tx_request_json: &JsonString, ) -> Result<TxId>

Generates and submits a tx using the node endpoints. Input is a json formatted request with rawInputs (and rawDataInputs) manually selected or inputs will be automatically selected by wallet. Returns the resulting TxId.

pub fn generate_json_transaction( &self, tx_request_json: &JsonString, ) -> Result<JsonValue>

Generates Json of an Unsigned Transaction. Input must be a json formatted request with rawInputs (and rawDataInputs) manually selected or will be automatically selected by wallet.

pub fn get_recommended_fee(&self, bytes: u64, wait_time: u64) -> Result<u64>

Gets the recommended fee for a transaction. bytes - size of the transaction in bytes wait_time - minutes to wait for the transaction to be included in the blockchain

impl NodeInterface

pub fn wallet_addresses(&self) -> Result<Vec<P2PKAddressString>>

Get all addresses from the node wallet

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

Acquires unspent boxes from the node wallet

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

Returns unspent boxes from the node wallet ordered from highest to lowest nanoErgs value.

pub fn unspent_boxes_with_min_total( &self, total: NanoErg, ) -> Result<Vec<ErgoBox>>

Returns a sorted list of unspent boxes which cover at least the provided value total of nanoErgs. Note: This box selection strategy simply uses the largest value holding boxes from the user’s wallet first.

pub fn unspent_boxes_with_min_total_by_age( &self, total: NanoErg, ) -> Result<Vec<ErgoBox>>

Returns a list of unspent boxes which cover at least the provided value total of nanoErgs. Note: This box selection strategy simply uses the oldest unspent boxes from the user’s full node wallet first.

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

Acquires the unspent box with the highest value of Ergs inside from the wallet

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

Acquires the unspent box with the highest value of Ergs inside from the wallet and serializes it

pub fn serialized_unspent_boxes_with_min_total( &self, total: NanoErg, ) -> Result<Vec<String>>

Acquires unspent boxes which cover total amount of nanoErgs from the wallet and serializes the boxes

pub fn wallet_nano_ergs_balance(&self) -> Result<NanoErg>

Get the current nanoErgs balance held in the Ergo Node wallet

pub fn wallet_status(&self) -> Result<WalletStatus>

Get wallet status /wallet/status

pub fn wallet_unlock(&self, password: &str) -> Result<bool>

Unlock wallet

Trait Implementations

impl Clone for NodeInterface

fn clone(&self) -> NodeInterface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeInterface

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

Formats the value using the given formatter.