aea.crypto.ledger_apis
Module wrapping all the public and private keys cryptography.
LedgerApis Objects
class LedgerApis()
Store all the ledger apis we initialise.
has_ledger
| @staticmethod
| has_ledger(identifier: str) -> bool
Check if it has the api.
get_api
| @classmethod
| get_api(cls, identifier: str) -> LedgerApi
Get the ledger API.
get_balance
| @classmethod
| get_balance(cls, identifier: str, address: str) -> Optional[int]
Get the token balance.
Arguments:
identifier: the identifier of the ledgeraddress: the address to check for
Returns:
the token balance
get_transfer_transaction
| @classmethod
| get_transfer_transaction(cls, identifier: str, sender_address: str, destination_address: str, amount: int, tx_fee: int, tx_nonce: str, **kwargs, ,) -> Optional[Any]
Get a transaction to transfer from self to destination.
Arguments:
identifier: the identifier of the ledgersender_address: the address of the senderdestination_address: the address of the receiveramount: the amounttx_nonce: verifies the authenticity of the txtx_fee: the tx fee
Returns:
tx
send_signed_transaction
| @classmethod
| send_signed_transaction(cls, identifier: str, tx_signed: Any) -> Optional[str]
Send a signed transaction and wait for confirmation.
Arguments:
identifier: the identifier of the ledgertx_signed: the signed transaction
Returns:
the tx_digest, if present
get_transaction_receipt
| @classmethod
| get_transaction_receipt(cls, identifier: str, tx_digest: str) -> Optional[Any]
Get the transaction receipt for a transaction digest.
Arguments:
identifier: the identifier of the ledgertx_digest: the digest associated to the transaction.
Returns:
the tx receipt, if present
get_transaction
| @classmethod
| get_transaction(cls, identifier: str, tx_digest: str) -> Optional[Any]
Get the transaction for a transaction digest.
Arguments:
identifier: the identifier of the ledgertx_digest: the digest associated to the transaction.
Returns:
the tx, if present
is_transaction_settled
| @staticmethod
| is_transaction_settled(identifier: str, tx_receipt: Any) -> bool
Check whether the transaction is settled and correct.
Arguments:
identifier: the identifier of the ledgertx_receipt: the transaction digest
Returns:
True if correctly settled, False otherwise
is_transaction_valid
| @staticmethod
| is_transaction_valid(identifier: str, tx: Any, seller: Address, client: Address, tx_nonce: str, amount: int) -> bool
Check whether the transaction is valid.
Arguments:
identifier: Ledger identifiertx: the transactionseller: the address of the seller.client: the address of the client.tx_nonce: the transaction nonce.amount: the amount we expect to get from the transaction.
Returns:
True if is valid , False otherwise
generate_tx_nonce
| @staticmethod
| generate_tx_nonce(identifier: str, seller: Address, client: Address) -> str
Generate a random str message.
Arguments:
identifier: ledger identifier.seller: the address of the seller.client: the address of the client.
Returns:
return the hash in hex.
recover_message
| @staticmethod
| recover_message(identifier: str, message: bytes, signature: str, is_deprecated_mode: bool = False) -> Tuple[Address, ...]
Recover the addresses from the hash.
Arguments:
identifier: ledger identifier.message: the message we expectsignature: the transaction signatureis_deprecated_mode: if the deprecated signing was used
Returns:
the recovered addresses
get_hash
| @staticmethod
| get_hash(identifier: str, message: bytes) -> str
Get the hash of a message.
Arguments:
identifier: ledger identifier.message: the message to be hashed.
Returns:
the hash of the message.