Expand description
Hiero Rust SDK.
Modules§
- account_
info_ flow - Flow for verifying signatures via account info.
Structs§
- Account
Balance - Response from
AccountBalanceQuery. - Account
Id - A unique identifier for a cryptocurrency account on Hiero.
- Account
Info - Response from
AccountInfoQuery. - Assessed
Custom Fee - A custom transfer fee that was assessed during the handling of a
CryptoTransfer. - Client
- Managed client for use on the Hiero network.
- Contract
Create Flow - Create a new smart contract
- Contract
Function Parameters - Builder for encoding parameters for a Solidity contract constructor/function call.
- Contract
Function Result - The result returned by a call to a smart contract function.
- Contract
Id - A unique identifier for a smart contract on Hiero.
- Contract
Info - Current information on a smart contract instance.
- Contract
LogInfo - The log information for an event returned by a smart contract function call. One function call may return several such events.
- Contract
Nonce Info - Info about a contract account’s nonce value. The nonce for a contract is only incremented when that contract creates another contract.
- Custom
Fee - A transfer fee to assess during a
CryptoTransferthat transfers units of the token to which the fee is attached. A custom fee may be either fixed or fractional, and must specify a fee collector account to receive the assessed fees. Only positive fees may be assessed. - Custom
FeeLimit - A custom transfer fee that was assessed during the handling of a
CryptoTransfer. - Custom
Fixed Fee - A custom fee definition for a consensus topic.
- Delegate
Contract Id - A unique identifier for a smart contract on Hiero.
- Eip1559
Ethereum Data - Data for an Eip 1559 ethereum transaction.
- Entity
Id - The ID of an entity on the Hiero network.
- Ethereum
Flow - Flow for executing ethereum transactions.
- EvmAddress
- An address as implemented in the Ethereum Virtual Machine.
- Exchange
Rate - Denotes a conversion between Hbars and cents (USD).
- Exchange
Rates - The current and next exchange rates between
Hbarand USD-cents. - FeeComponents
- The different components used for fee calculation.
- FeeData
- The total fees charged for a transaction, consisting of 3 parts: The node fee, the network fee, and the service fee.
- FeeSchedule
- The fee schedules for hedera functionality and the time at which this fee schedule will expire.
- FeeSchedules
- Contains the current and next
FeeSchedules. - File
Contents Response - Response from
FileContentsQuery. - FileId
- The unique identifier for a file on Hiero.
- File
Info - Response from
FileInfoQuery. - Fixed
FeeData - A fixed number of units (hbar or token) to assess as a fee during a
CryptoTransferthat transfers units of the token to which this fixed fee is attached. - Fractional
FeeData - A fraction of the transferred units of a token to assess as a fee. The amount assessed will never
be less than the given
minimum_amount, and never greater than the givenmaximum_amount. The denomination is always units of the token to which this fractional fee is attached. - Hbar
- A quantity of
hbar. - KeyList
- A list of keys with an optional threshold.
- Ledger
Id - The ID of a Hiero Ledger.
- Legacy
Ethereum Data - Data for a legacy ethereum transaction.
- Mirror
Query - A query that can be executed on the Hiero mirror network.
- Mnemonic
BIP-3924-word mnemonic phrase compatible with the Android and iOS mobile wallets.- Network
Version Info - Versions of Hiero Services, and the protobuf schema.
- NftId
- The unique identifier for a token on Hiero.
- Node
Address - The data about a node, including its service endpoints and the Hiero account to be paid for services provided by the node (that is, queries answered and transactions submitted.).
- Node
Address Book - A list of nodes and their metadata.
- Pending
Airdrop Id - A unique, composite, identifier for a pending airdrop.
- Pending
Airdrop Record - A record of a new pending airdrop.
- Private
Key - A private key on the Hiero network.
- Proxy
Staker - Information about a single account that is proxy staking.
- Public
Key - A public key on the Hiero network.
- Query
- A query that can be executed on the Hiero network.
- Royalty
FeeData - A fee to assess during a
CryptoTransferthat changes ownership of an NFT. Defines the fraction of the fungible value exchanged for an NFT that the ledger should collect as a royalty. (“Fungible value” includes both ℏ and units of fungible HTS tokens.) When the NFT sender does not receive any fungible value, the ledger will assess the fallback fee, if present, to the new NFT owner. Royalty fees can only be added to tokens of type typeNON_FUNGIBLE_UNIQUE. - Schedule
Id - The unique identifier for a scheduled transaction on Hiero.
- Schedule
Info - Response from
ScheduleInfoQuery. - Semantic
Version - Hiero follows semantic versioning for both the HAPI protobufs and the Services software.
- Service
Endpoint - Contains the IP address, the port, and the domain name representing a service endpoint of a Node in a network. Used to reach the Hiero API and submit transactions to the network.
- Staking
Info - Info related to account/contract staking settings.
- Token
Association - A token <-> account association.
- TokenId
- The unique identifier for a token on Hiero.
- Token
Info - Response from
TokenInfoQuery. - Token
NftInfo - Response from
TokenNftInfoQuery. - Token
NftTransfer - Represents a transfer of an NFT from one account to another.
- Token
Reject Flow - Reject undesired token(s) and dissociate in a single flow.
- TopicId
- The unique identifier for a topic on Hiero.
- Topic
Info - Response from
TopicInfoQuery. - Topic
Message - Topic message records.
- Transaction
- A transaction that can be executed on the Hiero network.
- Transaction
FeeSchedule - The fees for a specific transaction or query based on the fee data.
- Transaction
Hash - The client-generated SHA-384 hash of a transaction that was submitted.
- Transaction
Id - The client-generated ID for a transaction.
- Transaction
Receipt - The summary of a transaction’s result so far, if the transaction has reached consensus.
Response from
TransactionReceiptQuery. - Transaction
Record - The complete record for a transaction on Hiero that has reached consensus.
Response from
TransactionRecordQuery. - Transaction
Response - Response from
Transaction::execute. - Transfer
- A transfer of
Hbarthat occured within aTransaction
Enums§
- AnyMirror
Query Response - Represents the response of any possible query to the mirror network.
- AnyQuery
Response - Common response type for all queries.
- Error
- Represents any possible error from a fallible function in the Hiero SDK.
- Ethereum
Data - Data for an
EthereumTransaction. - Fee
- Represents the possible fee types.
- FeeAssessment
Method - Enum for the fee assessment method.
- FeeData
Type - Possible
FeeDatasubtypes. - Freeze
Type - What type of freeze should be executed?
- Hbar
Unit - Common units of hbar; for the most part they follow SI prefix conventions.
- Key
- Any method that can be used to authorize an operation on Hiero.
- Mnemonic
Entropy Error - Failed to convert a
Mnemonicto aPrivateKey - Mnemonic
Parse Error - Failed to parse a mnemonic.
- Request
Type - The functionality provided by Hiero.
- Status
- An enumeration of possible response codes.
Returned in
TransactionReceipt,Error::PreCheckStatus, andError::ReceiptStatus. - Token
KeyValidation - Types of validation strategies for token keys.
Defaults to
FullValidation. - Token
Supply Type - Possible token supply types.
Can be used to restrict supply to a set maximum.
Defaults to
Infinite. - Token
Type - Possible token types.
Type Aliases§
- Account
Allowance Approve Transaction - Creates one or more hbar/token approved allowances relative to the owner account specified in the allowances of this transaction.
- Account
Allowance Delete Transaction - Deletes one or more non-fungible approved allowances from an owner’s account. This operation
will remove the allowances granted to one or more specific non-fungible token serial numbers. Each owner account
listed as wiping an allowance must sign the transaction. Hbar and fungible token allowances
can be removed by setting the amount to zero in
AccountAllowanceApproveTransaction. - Account
Balance Query - Get the balance of a cryptocurrency account.
- Account
Create Transaction - Create a new Hiero™ account.
- Account
Delete Transaction - Mark an account as deleted, moving all its current hbars to another account.
- Account
Info Query - Get all the information about an account, including the balance.
- Account
Records Query - Get all the records for an account for any transfers into it and out of it, that were above the threshold, during the last 25 hours.
- Account
Update Transaction - Change properties for the given account.
- AllProxy
Stakers - Response from [
AccountStakersQuery][crate::AccountStakersQuery]. - AnyCustom
Fee - Any
CustomFee. - AnyMirror
Query - Represents any possible query to the mirror network.
- AnyQuery
- Any possible query that may be executed on the Hiero network.
- AnyTransaction
- Any possible transaction that may be executed on the Hiero network.
- Batch
Transaction - Execute multiple transactions in a single consensus event. This allows for atomic execution of multiple transactions, where they either all succeed or all fail together.
- Contract
Bytecode Query - Get the runtime bytecode for a smart contract instance.
- Contract
Call Query - Call a function of the given smart contract instance. It will consume the entire given amount of gas.
- Contract
Create Transaction - Start a new smart contract instance.
- Contract
Delete Transaction - Marks a contract as deleted and transfers its remaining hBars, if any, to a designated receiver.
- Contract
Execute Transaction - Call a function of the given smart contract instance, giving it parameters as its inputs.
- Contract
Info Query - Get information about a smart contract instance.
- Contract
Update Transaction - Updates the fields of a smart contract to the given values.
- Ethereum
Transaction - Submit an Ethereum transaction.
- File
Append Transaction - Append the given contents to the end of the specified file.
- File
Contents Query - Get the contents of a file.
- File
Create Transaction - Create a new file, containing the given contents.
- File
Delete Transaction - Delete the given file.
- File
Info Query - Get all the information about a file.
- File
Update Transaction - Modify the metadata and/or the contents of a file.
- Fixed
Fee - A
FixedCustomFee. - Fractional
Fee - A fractional
CustomFee. - Freeze
Transaction - Sets the freezing period in which the platform will stop creating events and accepting transactions.
- Network
Version Info Query - Get information about the versions of protobuf and hedera.
- Node
Address Book Query - Query for an address book and return its nodes. The nodes are returned in ascending order by node ID.
- Node
Create Transaction - A transaction body to add a new consensus node to the network address book.
- Node
Delete Transaction - A transaction body to delete a node from the network address book.
- Node
Update Transaction - Transaction body to modify address book node attributes.
- Prng
Transaction - Random Number Generator Transaction.
- Result
Result<T, Error>- Royalty
Fee - A royalty
CustomFee. - Schedule
Create Transaction - Create a new schedule entity (or simply, schedule) in the network’s action queue.
- Schedule
Delete Transaction - Marks a schedule in the network’s action queue as deleted. Must be signed by the admin key of the target schedule. A deleted schedule cannot receive any additional signing keys, nor will it be executed.
- Schedule
Info Query - Get all the information about a schedule.
- Schedule
Sign Transaction - Adds zero or more signing keys to a schedule.
- System
Delete Transaction - Delete a file or smart contract - can only be done by a Hiero admin.
- System
Undelete Transaction - Undelete a file or smart contract that was deleted by a
SystemUndeleteTransaction. - Tinybar
- Type alias for
i64representingtinybar - Token
Airdrop Transaction - Airdrop one or more tokens to one or more accounts.
- Token
Associate Transaction - Associates the provided account with the provided tokens. Must be signed by the provided Account’s key.
- Token
Burn Transaction - Burns tokens from the Token’s treasury Account.
- Token
Cancel Airdrop Transaction - Token cancel airdrop Remove one or more pending airdrops from state on behalf of the sender(s) for each airdrop.
- Token
Claim Airdrop Transaction - Token claim airdrop Complete one or more pending transfers on behalf of the recipient(s) for an airdrop.
- Token
Create Transaction - Create a new token.
- Token
Delete Transaction - Marks a token as deleted, though it will remain in the ledger.
- Token
Dissociate Transaction - Dissociates the provided account with the provided tokens. Must be signed by the provided Account’s key.
- Token
FeeSchedule Update Transaction - At consensus, updates a token type’s fee schedule to the given list of custom fees.
- Token
Freeze Transaction - Freezes transfers of the specified token for the account. Must be signed by the Token’s freezeKey.
- Token
Grant KycTransaction - Grants KYC to the account for the given token. Must be signed by the Token’s kycKey.
- Token
Info Query - Gets information about Token instance.
- Token
Mint Transaction - Mints tokens to the Token’s treasury Account.
- Token
NftInfo Query - Gets info on an NFT for a given
TokenIDand serial number. - Token
Pause Transaction - Pauses the Token from being involved in any kind of Transaction until it is unpaused.
- Token
Reject Transaction - Reject undesired token(s) Transfer one or more token balances held by the requesting account to the treasury for each token type. Each transfer SHALL be one of the following
- Token
Revoke KycTransaction - Revokes KYC from the account for the given token.
- Token
Unfreeze Transaction - Unfreezes transfers of the specified token for the account. Must be signed by the Token’s freezeKey.
- Token
Unpause Transaction - Unpauses the Token. Must be signed with the Token’s pause key.
- Token
Update Nfts Transaction - At consensus, updates an already created Non Fungible Token to the given values.
- Token
Update Transaction - At consensus, updates an already created token to the given values.
- Token
Wipe Transaction - Wipes the provided amount of tokens from the specified Account. Must be signed by the Token’s Wipe key.
- Topic
Create Transaction - Create a topic to be used for consensus.
- Topic
Delete Transaction - Delete a topic.
- Topic
Info Query - Retrieve the latest state of a topic.
- Topic
Message Query - Query a stream of Hiero Consensus Service (HCS) messages for an HCS Topic via a specific (possibly open-ended) time range.
- Topic
Message Submit Transaction - Submit a message for consensus.
- Topic
Update Transaction - Change properties for the given topic.
- Transaction
Receipt Query - Get the receipt of a transaction, given its transaction ID.
- Transaction
Record Query - Get the record of a transaction, given its transaction ID.
- Transfer
Transaction - Transfers cryptocurrency among two or more accounts by making the desired adjustments to their balances.