Crate hedera

Hedera Rust SDK.

Modules

• account_info_flow
  Flow for verifying signatures via account info.

Structs

• AccountBalance
  Response from AccountBalanceQuery.
• AccountId
  A unique identifier for a cryptocurrency account on Hedera.
• AccountInfo
  Response from AccountInfoQuery.
• AssessedCustomFee
  A custom transfer fee that was assessed during the handling of a CryptoTransfer.
• Client
  Managed client for use on the Hedera network.
• ContractCreateFlow
  Create a new smart contract
• ContractFunctionParameters
  Builder for encoding parameters for a Solidity contract constructor/function call.
• ContractFunctionResult
  The result returned by a call to a smart contract function.
• ContractId
  A unique identifier for a smart contract on Hedera.
• ContractInfo
  Current information on a smart contract instance.
• ContractLogInfo
  The log information for an event returned by a smart contract function call. One function call may return several such events.
• ContractNonceInfo
  Info about a contract account’s nonce value. The nonce for a contract is only incremented when that contract creates another contract.
• CustomFee
  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.
• DelegateContractId
  A unique identifier for a smart contract on Hedera.
• Eip1559EthereumData
  Data for an Eip 1559 ethereum transaction.
• EntityId
  The ID of an entity on the Hedera network.
• EthereumFlow
  Flow for executing ethereum transactions.
• EvmAddress
  An address as implemented in the Ethereum Virtual Machine.
• ExchangeRate
  Denotes a conversion between Hbars and cents (USD).
• ExchangeRates
  The current and next exchange rates between Hbar and 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.
• FileContentsResponse
  Response from FileContentsQuery.
• FileId
  The unique identifier for a file on Hedera.
• FileInfo
  Response from FileInfoQuery.
• FixedFeeData
  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.
• FractionalFeeData
  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 given maximum_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.
• LedgerId
  The ID of a Hedera Ledger.
• LegacyEthereumData
  Data for a legacy ethereum transaction.
• MirrorQuery
  A query that can be executed on the Hedera mirror network.
• Mnemonic
  BIP-39 24-word mnemonic phrase compatible with the Android and iOS mobile wallets.
• NetworkVersionInfo
  Versions of Hedera Services, and the protobuf schema.
• NftId
  The unique identifier for a token on Hedera.
• NodeAddress
  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.).
• NodeAddressBook
  A list of nodes and their metadata.
• PrivateKey
  A private key on the Hedera network.
• ProxyStaker
  Information about a single account that is proxy staking.
• PublicKey
  A public key on the Hedera network.
• Query
  A query that can be executed on the Hedera network.
• RoyaltyFeeData
  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 type NON_FUNGIBLE_UNIQUE.
• ScheduleId
  The unique identifier for a scheduled transaction on Hedera.
• ScheduleInfo
  Response from ScheduleInfoQuery.
• SemanticVersion
  Hedera follows semantic versioning for both the HAPI protobufs and the Services software.
• StakingInfo
  Info related to account/contract staking settings.
• TokenAssociation
  A token <-> account association.
• TokenId
  The unique identifier for a token on Hedera.
• TokenInfo
  Response from TokenInfoQuery.
• TokenNftInfo
  Response from TokenNftInfoQuery.
• TokenNftTransfer
  Represents a transfer of an NFT from one account to another.
• TopicId
  The unique identifier for a topic on Hedera.
• TopicInfo
  Response from TopicInfoQuery.
• TopicMessage
  Topic message records.
• Transaction
  A transaction that can be executed on the Hedera network.
• TransactionFeeSchedule
  The fees for a specific transaction or query based on the fee data.
• TransactionHash
  The client-generated SHA-384 hash of a transaction that was submitted.
• TransactionId
  The client-generated ID for a transaction.
• TransactionReceipt
  The summary of a transaction’s result so far, if the transaction has reached consensus. Response from TransactionReceiptQuery.
• TransactionRecord
  The complete record for a transaction on Hedera that has reached consensus. Response from TransactionRecordQuery.
• TransactionResponse
  Response from Transaction::execute.
• Transfer
  A transfer of Hbar that occured within a Transaction

Enums

• AnyMirrorQueryResponse
  Represents the response of any possible query to the mirror network.
• AnyQueryResponse
  Common response type for all queries.
• Error
  Represents any possible error from a fallible function in the Hedera SDK.
• EthereumData
  Data for an EthereumTransaction.
• Fee
  Represents the possible fee types.
• FeeAssessmentMethod
  Enum for the fee assessment method.
• FeeDataType
  Possible FeeData subtypes.
• FreezeType
  What type of freeze should be executed?
• HbarUnit
  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 Hedera.
• MnemonicEntropyError
  Failed to convert a Mnemonic to a PrivateKey
• MnemonicParseError
  Failed to parse a mnemonic.
• RequestType
  The functionality provided by Hedera.
• Status
  Returned in TransactionReceipt, Error::PreCheckStatus, and Error::ReceiptStatus.
• TokenSupplyType
  Possible token supply types. Can be used to restrict supply to a set maximum. Defaults to Infinite.
• TokenType
  Possible token types.

Type Aliases

• AccountAllowanceApproveTransaction
  Creates one or more hbar/token approved allowances relative to the owner account specified in the allowances of this transaction.
• AccountAllowanceDeleteTransaction
  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.
• AccountBalanceQuery
  Get the balance of a cryptocurrency account.
• AccountCreateTransaction
  Create a new Hedera™ account.
• AccountDeleteTransaction
  Mark an account as deleted, moving all its current hbars to another account.
• AccountInfoQuery
  Get all the information about an account, including the balance.
• AccountRecordsQuery
  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.
• AccountStakersQuery
  Get all the accounts that are proxy staking to this account. For each of them, give the amount currently staked.
• AccountUpdateTransaction
  Change properties for the given account.
• AllProxyStakers
  Response from AccountStakersQuery.
• AnyCustomFee
  Any CustomFee.
• AnyMirrorQuery
  Represents any possible query to the mirror network.
• AnyQuery
  Any possible query that may be executed on the Hedera network.
• AnyTransaction
  Any possible transaction that may be executed on the Hedera network.
• ContractBytecodeQuery
  Get the runtime bytecode for a smart contract instance.
• ContractCallQuery
  Call a function of the given smart contract instance. It will consume the entire given amount of gas.
• ContractCreateTransaction
  Start a new smart contract instance.
• ContractDeleteTransaction
  Marks a contract as deleted and transfers its remaining hBars, if any, to a designated receiver.
• ContractExecuteTransaction
  Call a function of the given smart contract instance, giving it parameters as its inputs.
• ContractInfoQuery
  Get information about a smart contract instance.
• ContractUpdateTransaction
  Updates the fields of a smart contract to the given values.
• EthereumTransaction
  Submit an Ethereum transaction.
• FileAppendTransaction
  Append the given contents to the end of the specified file.
• FileContentsQuery
  Get the contents of a file.
• FileCreateTransaction
  Create a new file, containing the given contents.
• FileDeleteTransaction
  Delete the given file.
• FileInfoQuery
  Get all the information about a file.
• FileUpdateTransaction
  Modify the metadata and/or the contents of a file.
• FixedFee
  A FixedCustomFee.
• FractionalFee
  A fractional CustomFee.
• FreezeTransaction
  Sets the freezing period in which the platform will stop creating events and accepting transactions.
• NetworkVersionInfoQuery
  Get information about the versions of protobuf and hedera.
• NodeAddressBookQuery
  Query for an address book and return its nodes. The nodes are returned in ascending order by node ID.
• PrngTransaction
  Random Number Generator Transaction.
• Result
  Result<T, Error>
• RoyaltyFee
  A royalty CustomFee.
• ScheduleCreateTransaction
  Create a new schedule entity (or simply, schedule) in the network’s action queue.
• ScheduleDeleteTransaction
  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.
• ScheduleInfoQuery
  Get all the information about a schedule.
• ScheduleSignTransaction
  Adds zero or more signing keys to a schedule.
• SystemDeleteTransaction
  Delete a file or smart contract - can only be done by a Hedera admin.
• SystemUndeleteTransaction
  Undelete a file or smart contract that was deleted by a SystemUndeleteTransaction.
• Tinybar
  Type alias for i64 representing tinybar
• TokenAssociateTransaction
  Associates the provided account with the provided tokens. Must be signed by the provided Account’s key.
• TokenBurnTransaction
  Burns tokens from the Token’s treasury Account.
• TokenCreateTransaction
  Create a new token.
• TokenDeleteTransaction
  Marks a token as deleted, though it will remain in the ledger.
• TokenDissociateTransaction
  Dissociates the provided account with the provided tokens. Must be signed by the provided Account’s key.
• TokenFeeScheduleUpdateTransaction
  At consensus, updates a token type’s fee schedule to the given list of custom fees.
• TokenFreezeTransaction
  Freezes transfers of the specified token for the account. Must be signed by the Token’s freezeKey.
• TokenGrantKycTransaction
  Grants KYC to the account for the given token. Must be signed by the Token’s kycKey.
• TokenInfoQuery
  Gets information about Token instance.
• TokenMintTransaction
  Mints tokens to the Token’s treasury Account.
• TokenNftInfoQuery
  Gets info on an NFT for a given TokenID and serial number.
• TokenPauseTransaction
  Pauses the Token from being involved in any kind of Transaction until it is unpaused.
• TokenRevokeKycTransaction
  Revokes KYC from the account for the given token.
• TokenUnfreezeTransaction
  Unfreezes transfers of the specified token for the account. Must be signed by the Token’s freezeKey.
• TokenUnpauseTransaction
  Unpauses the Token. Must be signed with the Token’s pause key.
• TokenUpdateTransaction
  At consensus, updates an already created token to the given values.
• TokenWipeTransaction
  Wipes the provided amount of tokens from the specified Account. Must be signed by the Token’s Wipe key.
• TopicCreateTransaction
  Create a topic to be used for consensus.
• TopicDeleteTransaction
  Delete a topic.
• TopicInfoQuery
  Retrieve the latest state of a topic.
• TopicMessageQuery
  Query a stream of Hedera Consensus Service (HCS) messages for an HCS Topic via a specific (possibly open-ended) time range.
• TopicMessageSubmitTransaction
  Submit a message for consensus.
• TopicUpdateTransaction
  Change properties for the given topic.
• TransactionReceiptQuery
  Get the receipt of a transaction, given its transaction ID.
• TransactionRecordQuery
  Get the record of a transaction, given its transaction ID.
• TransferTransaction
  Transfers cryptocurrency among two or more accounts by making the desired adjustments to their balances.