avalanche-sdk 0.43.0

Avalanche API/SDK
Documentation
use std::{
    collections::HashMap,
    io::{self, Error, ErrorKind},
};

use avalanche_types::jsonrpc::{self, avm};

/// e.g., "avm.issueTx" on "http://[ADDR]:9650" and "/ext/bc/X" path.
/// ref. https://docs.avax.network/apis/avalanchego/apis/x-chain/#avmissuetx
pub async fn issue_tx(http_rpc: &str, tx: &str) -> io::Result<jsonrpc::IssueTxResponse> {
    let joined = http_manager::join_uri(http_rpc, "/ext/bc/X")?;
    log::debug!("issuing a transaction via {:?}", joined.as_str());

    let mut data = jsonrpc::DataForIssueTx::default();
    data.method = String::from("avm.issueTx");

    let params = jsonrpc::IssueTxRequest {
        tx: prefix_manager::prepend_0x(tx),
        encoding: String::from("hex"), // don't use "cb58"
    };
    data.params = Some(params);

    let d = data.encode_json()?;
    let rb = http_manager::post_non_tls(http_rpc, "/ext/bc/X", &d).await?;

    let resp: jsonrpc::RawIssueTxResponse = match serde_json::from_slice(&rb) {
        Ok(p) => p,
        Err(e) => {
            return Err(Error::new(
                ErrorKind::Other,
                format!("failed to decode jsonrpc::RawIssueTxResponse {}", e),
            ));
        }
    };
    Ok(resp.convert())
}

/// e.g., "avm.getTxStatus" on "http://[ADDR]:9650" and "/ext/bc/X" path.
/// ref. https://docs.avax.network/apis/avalanchego/apis/x-chain/#avmgettxstatus
pub async fn get_tx_status(
    http_rpc: &str,
    tx_id: &str,
) -> io::Result<jsonrpc::GetTxStatusResponse> {
    let joined = http_manager::join_uri(http_rpc, "/ext/bc/X")?;
    log::debug!("getting tx status via {:?}", joined.as_str());

    let mut data = jsonrpc::Data::default();
    data.method = String::from("avm.getTxStatus");

    let mut params = HashMap::new();
    params.insert(String::from("txID"), String::from(tx_id));
    data.params = Some(params);

    let d = data.encode_json()?;
    let rb = http_manager::post_non_tls(http_rpc, "/ext/bc/X", &d).await?;

    let resp: jsonrpc::RawGetTxStatusResponse = match serde_json::from_slice(&rb) {
        Ok(p) => p,
        Err(e) => {
            return Err(Error::new(
                ErrorKind::InvalidData,
                format!("failed to decode jsonrpc::RawGetTxStatusResponse {}", e),
            ));
        }
    };
    Ok(resp.convert()?)
}

/// e.g., "avm.getBalance" on "http://[ADDR]:9650" and "/ext/bc/X" path.
/// ref. https://docs.avax.network/build/avalanchego-apis/x-chain#avmgetbalance
pub async fn get_balance(http_rpc: &str, xaddr: &str) -> io::Result<avm::GetBalanceResponse> {
    let joined = http_manager::join_uri(http_rpc, "/ext/bc/X")?;
    log::debug!("getting balances for {} via {:?}", xaddr, joined);

    let mut data = jsonrpc::Data::default();
    data.method = String::from("avm.getBalance");

    let mut params = HashMap::new();
    params.insert(String::from("assetID"), String::from("AVAX"));
    params.insert(String::from("address"), xaddr.to_string());
    data.params = Some(params);

    let d = data.encode_json()?;
    let rb = http_manager::post_non_tls(http_rpc, "/ext/bc/X", &d).await?;

    let resp: avm::RawGetBalanceResponse = match serde_json::from_slice(&rb) {
        Ok(p) => p,
        Err(e) => {
            return Err(Error::new(
                ErrorKind::Other,
                format!("failed to decode avm::RawGetBalanceResponse {}", e),
            ));
        }
    };
    Ok(resp.convert()?)
}

/// e.g., "avm.getAssetDescription".
/// ref. https://docs.avax.network/build/avalanchego-apis/x-chain/#avmgetassetdescription
pub async fn get_asset_description(
    http_rpc: &str,
    asset_id: &str,
) -> io::Result<avm::GetAssetDescriptionResponse> {
    log::debug!(
        "getting asset description from {} for {}",
        http_rpc,
        asset_id
    );

    let mut data = jsonrpc::Data::default();
    data.method = String::from("avm.getAssetDescription");

    let mut params = HashMap::new();
    params.insert(String::from("assetID"), String::from(asset_id));
    data.params = Some(params);

    let d = data.encode_json()?;
    let rb = http_manager::post_non_tls(http_rpc, "ext/bc/X", &d).await?;

    let resp: avm::RawGetAssetDescriptionResponse = match serde_json::from_slice(&rb) {
        Ok(p) => p,
        Err(e) => {
            return Err(Error::new(
                ErrorKind::Other,
                format!("failed to decode avm::RawGetAssetDescriptionResponse {}", e),
            ));
        }
    };
    Ok(resp.convert()?)
}

/// e.g., "avm.getUTXOs" on "http://[ADDR]:9650" and "/ext/bc/X" path.
/// TODO: support paginated calls
/// ref. https://docs.avax.network/apis/avalanchego/apis/x-chain/#avmgetutxos
pub async fn get_utxos(http_rpc: &str, xaddr: &str) -> io::Result<jsonrpc::GetUtxosResponse> {
    let joined = http_manager::join_uri(http_rpc, "/ext/bc/X")?;
    log::debug!("getting UTXOs for {} via {:?}", xaddr, joined);

    let mut data = jsonrpc::DataForGetUtxos::default();
    data.method = String::from("avm.getUTXOs");

    let params = jsonrpc::GetUtxosRequest {
        addresses: vec![xaddr.to_string()],
        limit: 1024,
        encoding: String::from("hex"), // don't use "cb58"
    };
    data.params = Some(params);

    let d = data.encode_json()?;
    let rb = http_manager::post_non_tls(http_rpc, "/ext/bc/X", &d).await?;

    let resp: jsonrpc::RawGetUtxosResponse = match serde_json::from_slice(&rb) {
        Ok(p) => p,
        Err(e) => {
            return Err(Error::new(
                ErrorKind::Other,
                format!("failed to decode jsonrpc::RawGetUtxosResponse {}", e),
            ));
        }
    };
    Ok(resp.convert()?)
}

/// e.g., "avm.issueStopVertex" on "http://[ADDR]:9650" and "/ext/bc/X" path.
/// Issue itself is asynchronous, so the internal error is not exposed!
pub async fn issue_stop_vertex(http_rpc: &str) -> io::Result<()> {
    let joined = http_manager::join_uri(http_rpc, "/ext/bc/X")?;
    log::debug!(
        "issuing a stop vertex transaction via {:?}",
        joined.as_str()
    );

    let mut data = jsonrpc::DataForIssueStopVertex::default();
    data.method = String::from("avm.issueStopVertex");

    let params = jsonrpc::IssueStopVertexRequest {};
    data.params = Some(params);

    let d = data.encode_json()?;
    http_manager::post_non_tls(http_rpc, "/ext/bc/X", &d).await?;

    Ok(())
}