blockchain.rs

Overview

This file provides functionality to retrieve a list of proxy servers from a blockchain-based proxy list contract. It contains a single asynchronous function, get_proxy_list, which currently reads the proxy addresses from a local text file and parses them into network socket addresses. The function is intended to be extended to interact directly with blockchain smart contracts to fetch proxy data.

The file includes detailed comments explaining how to interact with the relevant blockchain contracts to obtain proxy lists and related information, including command-line instructions using tvm-cli and GraphQL queries. These comments provide guidance on the underlying blockchain mechanisms and data sources that the function will eventually integrate with.

Functions

get_proxy_list() -> anyhow::Result<Vec<SocketAddr>>

Asynchronous function that returns a list of proxy servers as socket addresses.

Parameters

• None

Returns

• Result<Vec<SocketAddr>, anyhow::Error>: On success, returns a vector of SocketAddr representing the proxy servers. On failure, returns an error wrapped in anyhow::Result.

Description

• Reads proxy server addresses from a local file named proxy_list.txt.

• Parses each line of the file into a SocketAddr using the parse_publisher_addr function from the network module.

• Collects all parsed addresses into a vector.

• Returns the vector of proxy addresses wrapped in a result.

Usage Example

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let proxies = blockchain::get_proxy_list().await?;
    for proxy in proxies {
        println!("Proxy server address: {}", proxy);
    }
    Ok(())
}

Implementation Details

• The function currently does not perform any direct blockchain queries or interactions.

• The TODO comment indicates that the actual blockchain interaction is planned but not yet implemented.

• Parsing and error handling leverage Rust's strong type system and the anyhow crate for error management.

• The parse_publisher_addr function is used to convert string representations of addresses into SocketAddr objects, ensuring correctness of the address format.

Blockchain Interaction Notes

The code comments provide instructions on how to interact with the blockchain contracts related to proxy lists:

• To get the proxy list from the proxy list contract, run the getter getDetails in BlockKeeperEpochProxyList using tvm-cli.

• To get all proxy contracts by code hash, run the getter getProxyListCodeHash in the BlockKeeperContractRoot.

• A GraphQL query can be made to search for contracts by the code hash obtained, filtering accounts by hash.

• Links to the ABI JSON files for the relevant contracts are provided for reference.

These instructions indicate the expected eventual implementation approach for get_proxy_list, which will involve querying these blockchain contracts and parsing responses.

Interaction with Other Parts of the System

• The function depends on the network module for the parse_publisher_addr utility to parse string addresses into SocketAddr.

• The file is designed to serve as a bridge between blockchain data (proxy lists) and the networking components that require proxy server addresses.

• Other parts of the system that need to connect to proxy servers can call get_proxy_list to obtain up-to-date proxy endpoints.

• The comments reference external CLI tools and GraphQL APIs, suggesting the system may also include components for blockchain communication and data fetching.

Mermaid Diagram

flowchart TD
A["get_proxy_list()"] --> B[Open "proxy_list.txt"]
B --> C[Read file content into String]
C --> D[Split content into lines]
D --> E[Parse each line using parse_publisher_addr]
E --> F[Collect parsed SocketAddr into Vec]
F --> G[Return Vec<SocketAddr>]

This flowchart illustrates the sequential steps performed by the get_proxy_list function, from reading the file to returning the list of proxy addresses.