Expand description
Hedera Rust SDK.
Modules§
- Flow for verifying signatures via account info.
Structs§
- Response from
AccountBalanceQuery
. - A unique identifier for a cryptocurrency account on Hedera.
- Response from
AccountInfoQuery
. - A custom transfer fee that was assessed during the handling of a
CryptoTransfer
. - Managed client for use on the Hedera network.
- Create a new smart contract
- Builder for encoding parameters for a Solidity contract constructor/function call.
- The result returned by a call to a smart contract function.
- A unique identifier for a smart contract on Hedera.
- Current information on a smart contract instance.
- The log information for an event returned by a smart contract function call. One function call may return several such events.
- Info about a contract account’s nonce value. The nonce for a contract is only incremented when that contract creates another contract.
- A transfer fee to assess during a
CryptoTransfer
that 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. - A unique identifier for a smart contract on Hedera.
- Data for an Eip 1559 ethereum transaction.
- The ID of an entity on the Hedera network.
- Flow for executing ethereum transactions.
- An address as implemented in the Ethereum Virtual Machine.
- Denotes a conversion between Hbars and cents (USD).
- The current and next exchange rates between
Hbar
and USD-cents. - The different components used for fee calculation.
- The total fees charged for a transaction, consisting of 3 parts: The node fee, the network fee, and the service fee.
- The fee schedules for hedera functionality and the time at which this fee schedule will expire.
- Contains the current and next
FeeSchedule
s. - Response from
FileContentsQuery
. - The unique identifier for a file on Hedera.
- Response from
FileInfoQuery
. - A fixed number of units (hbar or token) to assess as a fee during a
CryptoTransfer
that transfers units of the token to which this fixed fee is attached. - 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. - A quantity of
hbar
. - A list of keys with an optional threshold.
- The ID of a Hedera Ledger.
- Data for a legacy ethereum transaction.
- A query that can be executed on the Hedera mirror network.
BIP-39
24-word mnemonic phrase compatible with the Android and iOS mobile wallets.- Versions of Hedera Services, and the protobuf schema.
- The unique identifier for a token on Hedera.
- The data about a node, including its service endpoints and the Hedera account to be paid for services provided by the node (that is, queries answered and transactions submitted.).
- A list of nodes and their metadata.
- A private key on the Hedera network.
- Information about a single account that is proxy staking.
- A public key on the Hedera network.
- A query that can be executed on the Hedera network.
- A fee to assess during a
CryptoTransfer
that 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
. - The unique identifier for a scheduled transaction on Hedera.
- Response from
ScheduleInfoQuery
. - Hedera follows semantic versioning for both the HAPI protobufs and the Services software.
- Info related to account/contract staking settings.
- A token <-> account association.
- The unique identifier for a token on Hedera.
- Response from
TokenInfoQuery
. - Response from
TokenNftInfoQuery
. - Represents a transfer of an NFT from one account to another.
- The unique identifier for a topic on Hedera.
- Response from
TopicInfoQuery
. - Topic message records.
- A transaction that can be executed on the Hedera network.
- The fees for a specific transaction or query based on the fee data.
- The client-generated SHA-384 hash of a transaction that was submitted.
- The client-generated ID for a transaction.
- The summary of a transaction’s result so far, if the transaction has reached consensus. Response from
TransactionReceiptQuery
. - The complete record for a transaction on Hedera that has reached consensus. Response from
TransactionRecordQuery
. - Response from
Transaction::execute
. - A transfer of
Hbar
that occured within aTransaction
Enums§
- Represents the response of any possible query to the mirror network.
- Common response type for all queries.
- Represents any possible error from a fallible function in the Hedera SDK.
- Data for an
EthereumTransaction
. - Represents the possible fee types.
- Enum for the fee assessment method.
- Possible
FeeData
subtypes. - What type of freeze should be executed?
- Common units of hbar; for the most part they follow SI prefix conventions.
- Any method that can be used to authorize an operation on Hedera.
- Failed to convert a
Mnemonic
to aPrivateKey
- Failed to parse a mnemonic.
- The functionality provided by Hedera.
- Returned in
TransactionReceipt
,Error::PreCheckStatus
, andError::ReceiptStatus
. - Types of validation strategies for token keys. Defaults to
FullValidation
. - Possible token supply types. Can be used to restrict supply to a set maximum. Defaults to
Infinite
. - Possible token types.
Type Aliases§
- Creates one or more hbar/token approved allowances relative to the owner account specified in the allowances of this 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
. - Get the balance of a cryptocurrency account.
- Create a new Hedera™ account.
- Mark an account as deleted, moving all its current hbars to another account.
- Get all the information about an account, including the balance.
- 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.
- Get all the accounts that are proxy staking to this account. For each of them, give the amount currently staked.
- Change properties for the given account.
- Response from
AccountStakersQuery
. - Any
CustomFee
. - Represents any possible query to the mirror network.
- Any possible query that may be executed on the Hedera network.
- Any possible transaction that may be executed on the Hedera network.
- Get the runtime bytecode for a smart contract instance.
- Call a function of the given smart contract instance. It will consume the entire given amount of gas.
- Start a new smart contract instance.
- Marks a contract as deleted and transfers its remaining hBars, if any, to a designated receiver.
- Call a function of the given smart contract instance, giving it parameters as its inputs.
- Get information about a smart contract instance.
- Updates the fields of a smart contract to the given values.
- Submit an Ethereum transaction.
- Append the given contents to the end of the specified file.
- Get the contents of a file.
- Create a new file, containing the given contents.
- Delete the given file.
- Get all the information about a file.
- Modify the metadata and/or the contents of a file.
- A
FixedCustomFee
. - A fractional
CustomFee
. - Sets the freezing period in which the platform will stop creating events and accepting transactions.
- Get information about the versions of protobuf and hedera.
- Query for an address book and return its nodes. The nodes are returned in ascending order by node ID.
- Random Number Generator Transaction.
Result<T, Error>
- A royalty
CustomFee
. - Create a new schedule entity (or simply, schedule) in the network’s action queue.
- 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.
- Get all the information about a schedule.
- Adds zero or more signing keys to a schedule.
- Delete a file or smart contract - can only be done by a Hedera admin.
- Undelete a file or smart contract that was deleted by a
SystemUndeleteTransaction
. - Type alias for
i64
representingtinybar
- Associates the provided account with the provided tokens. Must be signed by the provided Account’s key.
- Burns tokens from the Token’s treasury Account.
- Create a new token.
- Marks a token as deleted, though it will remain in the ledger.
- Dissociates the provided account with the provided tokens. Must be signed by the provided Account’s key.
- At consensus, updates a token type’s fee schedule to the given list of custom fees.
- Freezes transfers of the specified token for the account. Must be signed by the Token’s freezeKey.
- Grants KYC to the account for the given token. Must be signed by the Token’s kycKey.
- Gets information about Token instance.
- Mints tokens to the Token’s treasury Account.
- Gets info on an NFT for a given
TokenID
and serial number. - Pauses the Token from being involved in any kind of Transaction until it is unpaused.
- Revokes KYC from the account for the given token.
- Unfreezes transfers of the specified token for the account. Must be signed by the Token’s freezeKey.
- Unpauses the Token. Must be signed with the Token’s pause key.
- At consensus, updates an already created Non Fungible Token to the given values.
- At consensus, updates an already created token to the given values.
- Wipes the provided amount of tokens from the specified Account. Must be signed by the Token’s Wipe key.
- Create a topic to be used for consensus.
- Delete a topic.
- Retrieve the latest state of a topic.
- Query a stream of Hedera Consensus Service (HCS) messages for an HCS Topic via a specific (possibly open-ended) time range.
- Submit a message for consensus.
- Change properties for the given topic.
- Get the receipt of a transaction, given its transaction ID.
- Get the record of a transaction, given its transaction ID.
- Transfers cryptocurrency among two or more accounts by making the desired adjustments to their balances.