Algoduino Class Reference

#include <Algoduino.h>

Public Member Functions
	Algoduino (String ssid, String password, String apiKey, Network network)
	Initialize the connection. More...
void	begin (void)
	Start the Wifi connection.
String	getHealth (void)
	Get the network health. More...
AccountInformation	getAccountInformation (String address)
	Get account information. More...
String	getConfirmedTransactionInformation (String address, String txid)
	Get a specific confirmed transaction. More...
String	getConfirmedTransactionsList (String address)
	Get a specific confirmed transaction. More...
String	getPendingTransactionInformation (String txid)
	Get a specific pending transaction. More...
String	getPendingTransactionsList (void)
	Get a list of unconfirmed transactions currently in the transaction pool. More...
String	getPendingTransactionsList (String address)
	Get a list of unconfirmed transactions currently in the transaction pool by address. More...
AssetInformation	getAssetInformation (String index)
	Get asset information. More...
String	getAssetsList (String max, String index)
	Get List of assets. More...
String	getBlock (String round)
	Get the block for the given round. More...
LedgerSupply	getLedgerSupply (void)
	Get the current supply reported by the ledger. More...
Status	getStatus (void)
	Gets the current node status. More...
Status	getStatus (String round)
	Gets the node status after waiting for the given round. More...
TransactionInformation	getTransactionInformation (String txid)
	Get the transaction note from a single transaction. More...
int	getTransactionsFee (void)
	Get the suggested transaction fee. More...
TransactionParams	getTransactionParams (void)
	Get parameters for constructing a new transaction. More...
Version	getVersions (void)
	Get the current version of the network. More...

Detailed Description

Algoduino.h - Algorand IoT library for Arduino Copyright (c) 2020 Algoduino. All right reserved. For the full copyright and license information, please view the LICENSE file that was distributed with this source code. Algoduino class.

Constructor & Destructor Documentation

Algoduino()

Algoduino::Algoduino	(	String	ssid,
		String	password,
		String	apiKey,
		Network	network
	)

Initialize the connection.

Parameters

ssid	Wifi network SSID.
password	Wifi network password.
apiKey	API key to connect to a node.
network	Algorand network: BETANET, TESTNET or MAINNET.

Member Function Documentation

getAccountInformation()

AccountInformation Algoduino::getAccountInformation

(

String

address

)

Get account information.

Parameters

address

An account public key.

Returns

AccountInformation structure containing accounts status, balance and spendable amounts.

getAssetInformation()

AssetInformation Algoduino::getAssetInformation

(

String

index

)

Get asset information.

Parameters

index

Asset index.

Returns

AssetInformation structure containing asset's creator, manager, reserve, freeze, and clawback addresses.

getAssetsList()

String Algoduino::getAssetsList	(	String	max,
		String	index
	)

Get List of assets.

Parameters

max	Maximum number of assets to fetch.
index	Asset index.

Returns

String containing a list of up to max assets.

getBlock()

String Algoduino::getBlock

(

String

round

)

Get the block for the given round.

Parameters

round

The round from which to fetch block information.

Returns

String containing the block information.

getConfirmedTransactionInformation()

String Algoduino::getConfirmedTransactionInformation	(	String	address,
		String	txid
	)

Get a specific confirmed transaction.

Parameters

address	An account public key.
txid	A transaction id.

Returns

String containing a list of confirmed transactions.

getConfirmedTransactionsList()

String Algoduino::getConfirmedTransactionsList

(

String

address

)

Get a specific confirmed transaction.

Parameters

address

An account public key.

Returns

String containing a list of confirmed transactions.

getHealth()

String Algoduino::getHealth

(

void

)

Get the network health.

Returns

String containing the response.

getLedgerSupply()

LedgerSupply Algoduino::getLedgerSupply

(

void

)

Get the current supply reported by the ledger.

Returns

LedgerSupply structure containing the current supply information.

getPendingTransactionInformation()

String Algoduino::getPendingTransactionInformation

(

String

txid

)

Get a specific pending transaction.

Parameters

txid	A transaction id.

Returns

String containing the pending transaction information.

getPendingTransactionsList() [1/2]

String Algoduino::getPendingTransactionsList

(

String

address

)

Get a list of unconfirmed transactions currently in the transaction pool by address.

Parameters

address

An account public key.

Returns

String containing a list of unconfirmed transactions by address.

getPendingTransactionsList() [2/2]

String Algoduino::getPendingTransactionsList

(

void

)

Get a list of unconfirmed transactions currently in the transaction pool.

Returns

String containing a list of unconfirmed transactions.

getStatus() [1/2]

Status Algoduino::getStatus

(

String

round

)

Gets the node status after waiting for the given round.

Parameters

round

The round from which to fetch block information.

Returns

Status structure containing the node status information.

getStatus() [2/2]

Status Algoduino::getStatus

(

void

)

Gets the current node status.

Returns

Status structure containing the current node status information.

getTransactionInformation()

TransactionInformation Algoduino::getTransactionInformation

(

String

txid

)

Get the transaction note from a single transaction.

Parameters

txid	A transaction id.

Returns

TransactionInformation structure containing the transaction information of the given txid.

getTransactionParams()

TransactionParams Algoduino::getTransactionParams

(

void

)

Get parameters for constructing a new transaction.

Returns

TransactionParams structure containing the transaction parameters information.

getTransactionsFee()

int Algoduino::getTransactionsFee

(

void

)

Get the suggested transaction fee.

Returns

The suggested transaction fee in units of micro-Algos per byte.

getVersions()

Version Algoduino::getVersions

(

void

)

Get the current version of the network.

Returns

Version structure containing the current version of the network.

---

The documentation for this class was generated from the following files:

• Algoduino.h
• Algoduino.cpp