Struct AlgodClient

pub struct AlgodClient { /* private fields */ }

Client for interacting with the Algorand protocol daemon

Implementations

impl AlgodClient

pub fn new(address: &str, token: &str) -> AlgodClient

Examples found in repository

examples/submit_file.rs (line 15)

fn main() -> Result<(), Box<dyn Error>> {
    let algod_address = "http://localhost:8080";
    let algod_token = "contents-of-algod.token";

    let mut f = File::open("./signed.tx")?;
    let mut raw_transaction = Vec::new();
    let _ = f.read_to_end(&mut raw_transaction)?;

    let algod_client = AlgodClient::new(algod_address, algod_token);

    let send_response = algod_client.raw_transaction(&raw_transaction)?;
    println!("Transaction ID: {}", send_response.tx_id);

    Ok(())
}

examples/quickstart.rs (line 9)

fn main() {
    let algod_address = "http://localhost:8080";
    let algod_token = "contents-of-algod.token";
    let kmd_address = "http://localhost:7833";
    let kmd_token = "contents-of-kmd.token";

    let algod_client = AlgodClient::new(algod_address, algod_token);
    let kmd_client = KmdClient::new(kmd_address, kmd_token);

    println!(
        "Algod versions: {:?}",
        algod_client.versions().unwrap().versions
    );
    println!(
        "Kmd versions: {:?}",
        kmd_client.versions().unwrap().versions
    );
}

examples/algod_client.rs (line 9)

fn main() -> Result<(), Box<dyn Error>> {
    let algod_address = "http://localhost:8080";
    let algod_token = "contents-of-algod.token";

    let algod_client = AlgodClient::new(algod_address, algod_token);

    // Print algod status
    let node_status = algod_client.status()?;
    println!("algod last round: {}", node_status.last_round);
    println!(
        "algod time since last round: {}",
        node_status.time_since_last_round
    );
    println!("algod catchup: {}", node_status.catchup_time);
    println!("algod latest version: {}", node_status.last_version);

    // Fetch block information
    let last_block = algod_client.block(node_status.last_round)?;
    println!("{:#?}", last_block);

    Ok(())
}

examples/sign_submit_transaction.rs (line 13)

fn main() -> Result<(), Box<dyn Error>> {
    let kmd_address = "http://localhost:7833";
    let kmd_token = "contents-of-kmd.token";
    let algod_address = "http://localhost:8080";
    let algod_token = "contents-of-algod.token";

    let kmd_client = KmdClient::new(kmd_address, kmd_token);
    let algod_client = AlgodClient::new(algod_address, algod_token);

    let list_response = kmd_client.list_wallets()?;

    let wallet_id = match list_response
        .wallets
        .into_iter()
        .find(|wallet| wallet.name == "testwallet")
    {
        Some(wallet) => wallet.id,
        None => return Err("Wallet not found".into()),
    };

    let init_response = kmd_client.init_wallet_handle(&wallet_id, "testpassword")?;
    let wallet_handle_token = init_response.wallet_handle_token;

    let gen_response = kmd_client.generate_key(&wallet_handle_token)?;
    let from_address = Address::from_string(&gen_response.address)?;

    let gen_response = kmd_client.generate_key(&wallet_handle_token)?;
    let to_address = Address::from_string(&gen_response.address)?;

    let transaction_params = algod_client.transaction_params()?;

    let genesis_id = transaction_params.genesis_id;
    let genesis_hash = transaction_params.genesis_hash;

    let base = BaseTransaction {
        sender: from_address,
        first_valid: transaction_params.last_round,
        last_valid: transaction_params.last_round + 1000,
        note: Vec::new(),
        genesis_id,
        genesis_hash,
    };

    let payment = Payment {
        amount: MicroAlgos(200_000),
        receiver: to_address,
        close_remainder_to: None,
    };

    let transaction = Transaction::new(base, MicroAlgos(1000), TransactionType::Payment(payment))?;

    let sign_response =
        kmd_client.sign_transaction(&wallet_handle_token, "testpassword", &transaction)?;

    println!(
        "kmd made signed transaction with {} bytes",
        sign_response.signed_transaction.len()
    );

    // Broadcast the transaction to the network
    // Note this transaction will get rejected because the accounts do not have any tokens
    let send_response = algod_client.raw_transaction(&sign_response.signed_transaction)?;

    println!("Transaction ID: {}", send_response.tx_id);

    Ok(())
}

pub fn new_with_headers( address: &str, token: &str, headers: HeaderMap, ) -> AlgodClient

pub fn health(&self) -> Result<(), Error>

Returns Ok if healthy

pub fn versions(&self) -> Result<Version, Error>

Retrieves the current version

Examples found in repository

examples/quickstart.rs (line 14)

fn main() {
    let algod_address = "http://localhost:8080";
    let algod_token = "contents-of-algod.token";
    let kmd_address = "http://localhost:7833";
    let kmd_token = "contents-of-kmd.token";

    let algod_client = AlgodClient::new(algod_address, algod_token);
    let kmd_client = KmdClient::new(kmd_address, kmd_token);

    println!(
        "Algod versions: {:?}",
        algod_client.versions().unwrap().versions
    );
    println!(
        "Kmd versions: {:?}",
        kmd_client.versions().unwrap().versions
    );
}

pub fn status(&self) -> Result<NodeStatus, Error>

Gets the current node status

Examples found in repository

examples/algod_client.rs (line 12)

fn main() -> Result<(), Box<dyn Error>> {
    let algod_address = "http://localhost:8080";
    let algod_token = "contents-of-algod.token";

    let algod_client = AlgodClient::new(algod_address, algod_token);

    // Print algod status
    let node_status = algod_client.status()?;
    println!("algod last round: {}", node_status.last_round);
    println!(
        "algod time since last round: {}",
        node_status.time_since_last_round
    );
    println!("algod catchup: {}", node_status.catchup_time);
    println!("algod latest version: {}", node_status.last_version);

    // Fetch block information
    let last_block = algod_client.block(node_status.last_round)?;
    println!("{:#?}", last_block);

    Ok(())
}

pub fn status_after_block(&self, round: Round) -> Result<NodeStatus, Error>

Waits for a block to appear after the specified round and returns the node status at the time

pub fn block(&self, round: Round) -> Result<Block, Error>

Get the block for the given round

Examples found in repository

examples/algod_client.rs (line 22)

fn main() -> Result<(), Box<dyn Error>> {
    let algod_address = "http://localhost:8080";
    let algod_token = "contents-of-algod.token";

    let algod_client = AlgodClient::new(algod_address, algod_token);

    // Print algod status
    let node_status = algod_client.status()?;
    println!("algod last round: {}", node_status.last_round);
    println!(
        "algod time since last round: {}",
        node_status.time_since_last_round
    );
    println!("algod catchup: {}", node_status.catchup_time);
    println!("algod latest version: {}", node_status.last_version);

    // Fetch block information
    let last_block = algod_client.block(node_status.last_round)?;
    println!("{:#?}", last_block);

    Ok(())
}

pub fn ledger_supply(&self) -> Result<Supply, Error>

Gets the current supply reported by the ledger

pub fn account_information(&self, address: &str) -> Result<Account, Error>

pub fn pending_transactions( &self, limit: u64, ) -> Result<PendingTransactions, Error>

Gets a list of unconfirmed transactions currently in the transaction pool

Sorted by priority in decreasing order and truncated at the specified limit, or returns all if specified limit is 0

pub fn pending_transaction_information( &self, transaction_id: &str, ) -> Result<Transaction, Error>

Get a specified pending transaction

pub fn transactions( &self, address: &str, first_round: Option<Round>, last_round: Option<Round>, from_date: Option<String>, to_date: Option<String>, limit: Option<u64>, ) -> Result<TransactionList, Error>

Get a list of confirmed transactions, limited to filters if specified

pub fn send_transaction( &self, signed_transaction: &SignedTransaction, ) -> Result<TransactionID, Error>

Broadcasts a transaction to the network

pub fn raw_transaction(&self, raw: &[u8]) -> Result<TransactionID, Error>

Broadcasts a raw transaction to the network

Examples found in repository

examples/submit_file.rs (line 17)

fn main() -> Result<(), Box<dyn Error>> {
    let algod_address = "http://localhost:8080";
    let algod_token = "contents-of-algod.token";

    let mut f = File::open("./signed.tx")?;
    let mut raw_transaction = Vec::new();
    let _ = f.read_to_end(&mut raw_transaction)?;

    let algod_client = AlgodClient::new(algod_address, algod_token);

    let send_response = algod_client.raw_transaction(&raw_transaction)?;
    println!("Transaction ID: {}", send_response.tx_id);

    Ok(())
}

examples/sign_submit_transaction.rs (line 67)

fn main() -> Result<(), Box<dyn Error>> {
    let kmd_address = "http://localhost:7833";
    let kmd_token = "contents-of-kmd.token";
    let algod_address = "http://localhost:8080";
    let algod_token = "contents-of-algod.token";

    let kmd_client = KmdClient::new(kmd_address, kmd_token);
    let algod_client = AlgodClient::new(algod_address, algod_token);

    let list_response = kmd_client.list_wallets()?;

    let wallet_id = match list_response
        .wallets
        .into_iter()
        .find(|wallet| wallet.name == "testwallet")
    {
        Some(wallet) => wallet.id,
        None => return Err("Wallet not found".into()),
    };

    let init_response = kmd_client.init_wallet_handle(&wallet_id, "testpassword")?;
    let wallet_handle_token = init_response.wallet_handle_token;

    let gen_response = kmd_client.generate_key(&wallet_handle_token)?;
    let from_address = Address::from_string(&gen_response.address)?;

    let gen_response = kmd_client.generate_key(&wallet_handle_token)?;
    let to_address = Address::from_string(&gen_response.address)?;

    let transaction_params = algod_client.transaction_params()?;

    let genesis_id = transaction_params.genesis_id;
    let genesis_hash = transaction_params.genesis_hash;

    let base = BaseTransaction {
        sender: from_address,
        first_valid: transaction_params.last_round,
        last_valid: transaction_params.last_round + 1000,
        note: Vec::new(),
        genesis_id,
        genesis_hash,
    };

    let payment = Payment {
        amount: MicroAlgos(200_000),
        receiver: to_address,
        close_remainder_to: None,
    };

    let transaction = Transaction::new(base, MicroAlgos(1000), TransactionType::Payment(payment))?;

    let sign_response =
        kmd_client.sign_transaction(&wallet_handle_token, "testpassword", &transaction)?;

    println!(
        "kmd made signed transaction with {} bytes",
        sign_response.signed_transaction.len()
    );

    // Broadcast the transaction to the network
    // Note this transaction will get rejected because the accounts do not have any tokens
    let send_response = algod_client.raw_transaction(&sign_response.signed_transaction)?;

    println!("Transaction ID: {}", send_response.tx_id);

    Ok(())
}

pub fn transaction(&self, transaction_id: &str) -> Result<Transaction, Error>

Gets the information of a single transaction

pub fn transaction_information( &self, address: &str, transaction_id: &str, ) -> Result<Transaction, Error>

Gets a specific confirmed transaction

pub fn suggested_fee(&self) -> Result<TransactionFee, Error>

Gets suggested fee in units of micro-Algos per byte

pub fn transaction_params(&self) -> Result<TransactionParams, Error>

Gets parameters for constructing a new transaction

Examples found in repository

examples/sign_submit_transaction.rs (line 35)

fn main() -> Result<(), Box<dyn Error>> {
    let kmd_address = "http://localhost:7833";
    let kmd_token = "contents-of-kmd.token";
    let algod_address = "http://localhost:8080";
    let algod_token = "contents-of-algod.token";

    let kmd_client = KmdClient::new(kmd_address, kmd_token);
    let algod_client = AlgodClient::new(algod_address, algod_token);

    let list_response = kmd_client.list_wallets()?;

    let wallet_id = match list_response
        .wallets
        .into_iter()
        .find(|wallet| wallet.name == "testwallet")
    {
        Some(wallet) => wallet.id,
        None => return Err("Wallet not found".into()),
    };

    let init_response = kmd_client.init_wallet_handle(&wallet_id, "testpassword")?;
    let wallet_handle_token = init_response.wallet_handle_token;

    let gen_response = kmd_client.generate_key(&wallet_handle_token)?;
    let from_address = Address::from_string(&gen_response.address)?;

    let gen_response = kmd_client.generate_key(&wallet_handle_token)?;
    let to_address = Address::from_string(&gen_response.address)?;

    let transaction_params = algod_client.transaction_params()?;

    let genesis_id = transaction_params.genesis_id;
    let genesis_hash = transaction_params.genesis_hash;

    let base = BaseTransaction {
        sender: from_address,
        first_valid: transaction_params.last_round,
        last_valid: transaction_params.last_round + 1000,
        note: Vec::new(),
        genesis_id,
        genesis_hash,
    };

    let payment = Payment {
        amount: MicroAlgos(200_000),
        receiver: to_address,
        close_remainder_to: None,
    };

    let transaction = Transaction::new(base, MicroAlgos(1000), TransactionType::Payment(payment))?;

    let sign_response =
        kmd_client.sign_transaction(&wallet_handle_token, "testpassword", &transaction)?;

    println!(
        "kmd made signed transaction with {} bytes",
        sign_response.signed_transaction.len()
    );

    // Broadcast the transaction to the network
    // Note this transaction will get rejected because the accounts do not have any tokens
    let send_response = algod_client.raw_transaction(&sign_response.signed_transaction)?;

    println!("Transaction ID: {}", send_response.tx_id);

    Ok(())
}