Namespace Hiero

Classes

AbiTuple

Represents a tuple of values that can be used in smart contract calls.

AbortNetworkUpgradeExtensions

Extension methods for aborting a scheduled network upgrade.

AbortNetworkUpgradeParams

Transaction parameters for aborting a previously scheduled network upgrade.

AccountBalances

Extended Balance information for an Address, including Token Balances.

The information returned from the GetAccountDetailAsync ConsensusClient method call.
It represents the details concerning a Hedera Network Address, including the public key value to use in smart contract interaction.

AccountDetailExtensions

Extension methods for querying detailed account information.

AccountInfo

Information about a Hedera Address, including public key, evm address and other account related information.

AccountInfoExtensions

Extension methods for querying account information.

AddConsensusNodeExtensions

Extension methods for adding consensus nodes to the network address book.

AddConsensusNodeParams

Transaction Parameters for adding a new consensus node to the network address book.

Airdrop

Identifies a pending airdrop by its sender, receiver, and token.

AirdropAmount

The identifier of an airdrop token, sender and receiver paired with the amount of token(s) to be transferred.

AirdropExtensions

Extension methods for airdropping tokens and NFTs on the network.

AirdropParams

Transaction Parameters for airdropping tokens to one or more recipient accounts.

AirdropRecord

A transaction record containing information regarding one or more newly created airdrops.

AllowanceExtensions

Extension methods for allocating crypto, token, and NFT allowances.

AllowanceParams

Allowance Creation and Adjustment Parameters

AppendFileExtensions

Extension methods for appending content to network files.

AppendFileParams

File content append parameters.

AssociateTokenExtensions

Extension methods for associating tokens with accounts on the network.

AssociateTokenParams

Transaction Parameters for Token and NFT Association Requests.

Association

Identifies an account which has been associated with a given Token or NFT class and therefore holds a balance of that token or NFT.

BatchedTransactionMetadata

Represents a single transaction within a batch, identifying the transaction parameters, and other optional batch metadata.

BatchedTransactionParams

Submits a batch of transactions to the network for processing.

BurnNftExtensions

Extension methods for burning NFT instances on the network.

BurnNftParams

Transaction Parameters for Burning One or More NFT instances.

BurnTokenExtensions

Extension methods for burning fungible tokens from the treasury.

BurnTokenParams

Transaction Parameters for Burning Tokens from the treasury account.

BytesPseudoRandomNumberRecord

A transaction record containing information concerning the newly created unbounded 384 bit pseudo random number.

CallContractExtensions

Extension methods for calling smart contracts.

CallContractParams

Represents the parameters required to call a smart contract on the Hedera network.

CallContractRecord

Record produced from calling a contract.

CancelAirdropExtensions

Extension methods for cancelling pending airdrops on the network.

CancelAirdropParams

Transaction Parameters for cancelling one or more pending airdrops.

ClaimAirdropExtensions

Extension methods for claiming pending airdrops on the network.

ClaimAirdropParams

Transaction Parameters for claiming one or more pending airdrops.

ConfiscateNftExtensions

Extension methods for confiscating and destroying NFT instances from an account.

ConfiscateNftParams

Removes the holdings of given asset from the associated account and destroys them. Must be signed by the confiscate/wipe admin key.

ConfiscateTokenExtensions

Extension methods for confiscating fungible tokens from an account.

ConfiscateTokenParams

Transaction Parameters for Confiscating/Wiping Tokens from an arbitrary account.

ConsensusClient

Hiero Network Consensus (Gossip) Node Client

ConsensusException

Exception thrown when a network call was accepted by the gateway node but did not achieve network consensus before the expiration timeout of the transaction request occurred.

ConsensusNodeEndpoint

Represents a consensus node's network address, consisting of a node identifier and a gRPC endpoint URI for accessing the Hiero Network.

ConsensusNodeEndpointInfo

Represents a Hedera Node ConsensusNodeEndpoint IP Address and Port

ConsensusNodeInfo

Information regarding a node from the signed address book.

ConsensusNodeInfoExtensions

Extension methods for retrieving consensus node address book information from the network.

ConsensusNodeReceipt

The receipt returned from a successful Create Node transaction, containing the newly assigned node identifier.

ConsensusNodeRecord

The consensus record from a successful Create Node transaction, containing the newly assigned node identifier.

ContinueTokenExtensions

Extension methods for un-pausing a token on the network.

ContinueTokenParams

Transaction Parameters for Continuing (Un-Pausing) a Token.

ContractBalancesExtensions

Extension methods for querying account and contract balances.

ContractCallResult

Represents the results returned from a contract call.

ContractEvent

Represents the log events returned by a contract function call.

ContractException

Represents an error with a contract query that passed the gateway node pre-check and was processed by the gossip node but did not succeed. It includes additional information returned by the hedera contract virtual machine. Transaction fees will have been spent.

ContractInfo

The information returned from the GetContractInfoAsync ConsensusClient method call.
It represents the details concerning a Hedera Network Contract instance, including the public key value to use in smart contract interaction.

ContractInfoExtensions

Extension methods for querying smart contract information and bytecode.

CreateAccountExtensions

Extension methods for creating cryptocurrency accounts.

CreateAccountParams

Address creation parameters.

CreateAccountReceipt

A transaction receipt containing information concerning the newly created account.

CreateAccountRecord

A transaction record containing information concerning the newly created account.

CreateContractExtensions

Extension methods for creating smart contracts.

CreateContractParams

Smart Contract creation properties.

CreateContractReceipt

Receipt produced from creating a new contract.

CreateContractRecord

Record produced from creating a new contract.

CreateFileExtensions

Extension methods for creating network files.

CreateFileParams

File creation parameters.

CreateNftExtensions

Extension methods for creating new NFT token definitions on the network.

CreateNftParams

NFT Token Type Creation Parameters.

CreateTokenExtensions

Extension methods for creating new fungible token definitions on the network.

CreateTokenParams

Token Creation Parameters.

CreateTokenReceipt

Receipt produced from creating a new token.

CreateTokenRecord

Record produced from creating a new token.

CreateTopicExtensions

Extension methods for creating consensus topics.

CreateTopicParams

Consensus Topics Creation Parameters.

CreateTopicReceipt

Receipt produced from creating a new consensus message topic.

CreateTopicRecord

Record produced from creating a new consensus message topic.

CryptoAllowance

Represents an allowance allocation permitting a spender account privileges of spending the specified amount of hBars from the owning account.

CryptoBalance

Represents the balance of a crypto token held by an account.

CryptoTransfer

Represents a crypto transfer (Address, Amount)

DeleteAccountExtensions

Extension methods for deleting cryptocurrency accounts.

DeleteAccountParams

Represents the parameters required to delete an account from the hedera network.

DeleteContractExtensions

Extension methods for deleting smart contracts.

DeleteContractParams

Represents the parameters required to delete a contract from the hedera network.

DeleteFileExtensions

Extension methods for deleting network files.

DeleteFileParams

File deletion parameters.

DeleteScheduleExtensions

Extension methods for deleting scheduled transactions from the network.

DeleteScheduleParams

Transaction Parameters for deleting an existing scheduled transaction from the network.

DeleteTokenExtensions

Extension methods for deleting a token from the network.

DeleteTokenParams

Transaction Parameters for Deleting a Token.

DeleteTopicExtensions

Extension methods for deleting consensus topics.

DeleteTopicParams

Transaction Parameters for Deleting a Consensus Topic.

DissociateTokenExtensions

Extension methods for dissociating tokens from accounts on the network.

DissociateTokenParams

Transaction Parameters for Token and NFT Dissociation Requests.

EncodedParams

Provides services to decode smart contract ABI data into .NET primitives. Typically represents data returned from a smart contract invocation.

Endorsement

Represents the key signing requirements for various transactions available within the network.

EntityId

Identifies a Hedera Address, Token, File, Topics, or Contract, typically
in the native format of

shard.realm.num

, but can also hold a Key Alias or EVM Payer if such an Entity TransactionId type is required.

EvmAddress

Represents 20-byte EVM Address for Hedera Virtual Machine.

EvmTransactionExtensions

Extension methods for submitting Ethereum-compatible EVM transactions.

EvmTransactionInput

Helper class used to orchestrate the creation of an RLP encoded Ethereum transaction to be submitted to the network using the Hedera Ethereum Transaction HAPI endpoint.

EvmTransactionParams

Represents a transaction submitted to the hedera network through the native HAPI Ethereum gateway feature.

EvmTransactionRecord

Record produced from an Ethereum transaction call.

ExchangeRate

Exchange rate information as known by the Hedera network. Values returned in receipts.

ExchangeRates

Object containing the current and next exchange rate returned from the network.

ExchangeRatesExtensions

Extension methods for retrieving exchange rate information from the network.

ExternalExtensions

Extension methods for querying and preparing externally constructed transactions.

ExternalTransactionParams

Transaction Parameters for Sending an Externally Created Transaction to the network for processing and optionally waiting for a receipt.

ExternalTransactionParamsExtensions

Extension methods for submitting externally created transactions to the network.

FeeSchedule

Contains a dictionary holding the fee calculation parameters for various network functions.

FeeSchedules

Object containing the current and next fee schedule returned from the network.

FeeSchedulesExtensions

Extension methods for retrieving fee schedule information from the network.

FileInfo

Detailed description of a network file.

FileInfoExtensions

Extension methods for querying network file information and content.

FileReceipt

A transaction receipt containing information concerning the newly created file.

FileRecord

A transaction record containing information concerning the newly created file.

FixedRoyalty

The definition of a single Fixed Royalty applied to the transaction as a whole when transferring an NFT or token.

GrantTokenKycExtensions

Extension methods for granting KYC status to token-holding accounts.

GrantTokenKycParams

Transaction Parameters for Granting KYC status to an account associated with a Token.

Hex

Helper class for converting between bytes and Hex encoded string values.

Hook

Represents a unique hook identified by its owning entity (account or contract) and a numeric identifier.

HookCall

Represents a hook call specification, including the hook's numeric identifier, call data, gas limit, and invocation mode.

HookMetadata

Represents the metadata required to create a new hook on an account or contract.

HookStorageEntry

Represents a single storage entry for an EVM hook, either a direct storage slot or an entry within a Solidity mapping.

KeyDerivationPath

Enumerates known HD Key Derivation paths for various Key formats and Wallets in the Hedera ecosystem.

MessageSegmentInfo

Optional metadata that may be attached to a segmented HCS message identifying the index of the segment and which parent message this segment correlates with.

MintNftExtensions

Extension methods for minting new NFT instances on the network.

MintNftParams

Transaction Parameters for Minting (Creating) a new NFT for a given class of NFTs.

MintTokenExtensions

Extension methods for minting fungible tokens to the treasury.

MintTokenParams

Transaction Parameters for Minting Tokens to the treasury account.

MirrorGrpcClient

Hedera Network Mirror Streaming Client

MirrorGrpcException

Represents an unexpected termination or exception received from a mirror stream.

MirrorRestClient

The Mirror Node REST Client.

Mnemonic

Helper class to produce public and private key values from mnemonic word phrases.

Nft

Represents a unique Hedera Non-Fungible Token (NFT) identified by its token ID and serial number.

NftAllowance

Represents an allowance allocation permitting a spender account privileges of spending the specified NFT(s) from the owning account.

NftInfo

The information returned from the GetNftInfo ConsensusClient method call. It represents the details concerning a Hedera Non-Fungible Token (NFT).

NftInfoExtensions

Extension methods for querying NFT instance information from the network.

NftMintReceipt

A transaction receipt containing information regarding the newly minted NFTs, typically returned from methods that can affect a change on the total NFT circulation supply.

NftMintRecord

A transaction record containing information regarding the newly minted NFTs, typically returned from methods that can affect a change on the total NFT circulation supply.

NftRoyalty

Represents a Royalty type computed from value given in exchange for receiving an NFT.

NftTransfer

Represents a NFT transfer.

PauseTokenExtensions

Extension methods for pausing a token on the network.

PauseTokenParams

Transaction Parameters for Pausing a token preventing all accounts from sending or receiving the specified token.

PrecheckException

Represents the condition where a submitted transaction failed the pre-check validation by the network gateway node.

PrepareNetworkUpgradeExtensions

Extension methods for preparing a network upgrade.

PrepareNetworkUpgradeParams

Transaction parameters for preparing the network for a software upgrade.

PseudoRandomNumberExtensions

Extension methods for generating pseudo-random numbers on the network.

PseudoRandomNumberParams

Creates a Pseudo Random Number request from the Hedera Network.

QueryContractExtensions

Extension methods for querying smart contract functions locally.

QueryContractParams

Provides the details of the request to the client when invoking a contract local query function.

RangedPseudoRandomNumberRecord

A transaction record containing information concerning the newly created ranged pseudo random number.

RelinquishTokenExtensions

Extension methods for relinquishing tokens and NFTs back to the treasury.

RelinquishTokensParams

Transaction Parameters for relinquishing one or more tokens, returning their full balance (or specific NFT instances) to the token treasury.

RemoveConsensusNodeExtensions

Extension methods for removing consensus nodes from the network address book.

RemoveConsensusNodeParams

Transaction Parameters for removing a consensus node from the network address book.

ResumeTokenExtensions

Extension methods for resuming a suspended account's ability to transact a token.

ResumeTokenParams

Token parameters for resuming an account's ability to send or receive the specified token.

RevokeNftAllowanceExtensions

Extension methods for revoking NFT allowances.

RevokeNftAllowanceParams

Removes approved spending allowance(s) for specific NFTs.

RevokeTokenKycExtensions

Extension methods for revoking KYC status from token-holding accounts.

RevokeTokenKycParams

Transaction Parameters for Revoking KYC status from an account associated with a Token.

Rlp

Utility class for Recursive Length Prefix (RLP) encoding and decoding, used for serializing data in EVM-compatible transactions.

RoyaltyTransfer

Represents a token or hBar transfer (Token, Payer, Amount, Address) fulfilling a royalty payment for the transfer of a token or asset.

ScheduleExtensions

Extension methods for creating scheduled transactions on the network.

ScheduleInfo

Information regarding a scheduled transaction held by the network that is either awaiting additional signatures or is awaiting its appointed execution consensus time.

ScheduleInfoExtensions

Extension methods for querying scheduled transaction information from the network.

ScheduleNetworkUpgradeExtensions

Extension methods for scheduling a network upgrade.

ScheduleNetworkUpgradeParams

Transaction parameters for scheduling a previously prepared network upgrade.

ScheduleParams

Parameters for creating a scheduled transaction on the network. The inner transaction will be held by the network and executed when all required signatures are collected, or optionally delayed until the specified expiration time.

ScheduleReceipt

Receipt produced from creating a new scheduled transaction.

ScheduleRecord

Record produced from creating a new scheduled transaction.

ScheduleTelemetryUpgradeExtensions

Extension methods for scheduling a telemetry upgrade.

ScheduleTelemetryUpgradeParams

Transaction parameters for scheduling a telemetry services upgrade.

SemanticVersion

Represents a Semantic Version Number (major, minor, patch)

SignScheduleExtensions

Extension methods for adding signatures to scheduled transactions.

SignScheduleParams

Transaction Parameters for adding signatures to an existing scheduled transaction.

Signatory

Represents a keyholder or group of keyholders that can sign a transaction for crypto transfer to support file creation, contract creation and execution or pay for consensus services among other network tasks.

SignatureMapExtensions

Extension methods for working with protobuf signature maps.

StakingInfo

The staking information returned from the CryptoGetInfo or ContractGetInfo queries.

SubmitMessageExtensions

Extension methods for submitting messages to consensus topics.

SubmitMessageParams

Submit Message Parameters, optionally including message segment information.

SubmitMessageReceipt

Receipt produced from submitting a new message.

SubmitMessageRecord

Record produced from submitting a new message.

SubscribeTopicParams

Parameters for subscribing to a consensus topic message stream from a mirror node.

SuspendNetworkExtensions

Extension methods for suspending network operations.

SuspendNetworkParams

Transaction parameters for suspending network operations at a specified consensus time.

SuspendTokenExtensions

Extension methods for suspending an account's ability to transact a token.

SuspendTokenParams

Token parameters for suspending an account's ability to send or receive the specified token.

SystemDeleteContractExtensions

Extension methods for administratively deleting a contract from the network.

SystemDeleteContractParams

Transaction parameters for administratively deleting a contract from the network.

SystemDeleteFileExtensions

Extension methods for administratively deleting a file from the network.

SystemDeleteFileParams

Transaction parameters for administratively deleting a file from the network.

SystemRestoreContractExtensions

Extension methods for administratively restoring a deleted contract.

SystemRestoreContractParams

Transaction parameters for administratively restoring a previously deleted contract.

SystemRestoreFileExtensions

Extension methods for administratively restoring a deleted file.

SystemRestoreFileParams

Transaction parameters for administratively restoring a previously deleted file.

TokenAllowance

Represents an allowance allocation permitting a delegate account privileges of spending the specified amount of tokens from the owning account.

TokenBalance

The token balance information associated with an account, including the amount of coins held, KYC status and Freeze status.

TokenInfo

The information returned from the GetTokenInfo ConsensusClient method call. It represents the details concerning Tokens and Assets.

TokenInfoExtensions

Extension methods for querying token information from the network.

TokenReceipt

A transaction receipt containing information regarding new token coin balance, typically returned from methods that can affect a change on the total circulation supply.

TokenRecord

A transaction record containing information regarding new token coin balance, typically returned from methods that can affect a change on the total circulation supply.

TokenRoyalty

The definition of a Royalty computed from the amount of Fungible token exchanged, can be in the form as a deduction of the token exchanged, or an excise amount taken from the sender of the fungible token.

TokenTransfer

Represents a token transfer (Token, Address, Amount)

TopicInfo

The information returned from the GetTopicInfo ConsensusClient method call. It represents the details concerning a Hedera Network Consensus Topic.

TopicInfoExtensions

Extension methods for querying consensus topic information.

TopicMessage

Represents a Topic Message retrieved from a mirror node.

TransactionBatchParamsExtensions

Extension methods for submitting batched transactions to the network.

TransactionException

Represents an error with a transaction that passed the gateway node pre-check and was processed by the network but did not succeed.

TransactionId

Represents the transaction id associated with a network request.
This is generated by the library automatically for each request.

TransactionId

implements the equitable interface and can be compared to other transaction ids returned from the library.

TransactionParams

A General Marker abstract class for transactions parameters.

TransactionParams<TReceipt>

A Transaction Receipt Specific Marker abstract class for transactions parameters.

TransactionReceipt

The details returned from the network after consensus has been reached for a network request.

TransactionReceiptExtensions

Extension methods for retrieving transaction receipts from the network.

TransactionRecord

The details returned from the network after consensus has been reached for a network request.

TransactionRecordExtensions

Extension methods for retrieving transaction records from the network.

TransferExtensions

Extension methods for transferring crypto, tokens, and NFTs.

TransferParams

Supports complex atomic multi-party multi-token and crypto transfers requests. Can support multi-account crypto transfers and/or multi-account token transfers in the same transaction. The crypto transfer list or token transfer list may be null if not used, however at least one transfer of some type must be defined to be valid.

TreasuryTransfer

Represents a change of Treasury for an NFT token .

UpdateAccountExtensions

Extension methods for updating cryptocurrency account properties.

UpdateAccountParams

Represents the properties on an account that can be changed.
Any property set to

null

on this object when submitted to the UpdateAccountAsync(ConsensusClient, UpdateAccountParams, Action<IConsensusContext>?) method will be left unchanged by the system. Certain additional conditions apply to certain properties such as the signing key are described below.

UpdateConsensusNodeExtensions

Extension methods for updating consensus nodes in the network address book.

UpdateConsensusNodeParams

Transaction Parameters for updating an existing consensus node in the network address book.

UpdateContractExtensions

Extension methods for updating smart contract properties.

UpdateContractParams

Represents the properties on a contract that can be changed.
Any property set to

null

on this object when submitted to the UpdateContractAsync(ConsensusClient, UpdateContractParams, Action<IConsensusContext>?) method will be left unchanged by the system. The transaction must be appropriately signed as described by the original Administrator endorsement in order to make changes. If there is no administrator endorsement specified, the contract is immutable and cannot be changed.

UpdateFileExtensions

Extension methods for updating network file properties and content.

UpdateFileParams

Input parameters describing how to update a network file.

UpdateHookStorageExtensions

Extension methods for updating EVM hook storage.

UpdateHookStorageParams

Represents the parameters required to update the storage of an EVM hook on the Hedera network.

UpdateNftsExtensions

Extension methods for updating NFT instance metadata on the network.

UpdateNftsParams

Transaction Parameters for updating the metadata of one or more NFT instances.

UpdateRoyaltiesExtensions

Extension methods for updating token royalties (custom fees) on the network.

UpdateRoyaltiesParams

Transaction Parameters for updating the royalties (custom fees) associated with a token.

UpdateTokenExtensions

Extension methods for updating token properties on the network.

UpdateTokenParams

Represents the properties on a token definition that can be changed.
Any property set to

null

on this object when submitted to the UpdateTokenAsync(ConsensusClient, UpdateTokenParams, Action<IConsensusContext>?) method will be left unchanged by the system. The transaction must be appropriately signed as described by the original Administrator endorsement in order to make changes. If there is no administrator endorsement specified, the token is immutable and cannot be changed.

UpdateTopicExtensions

Extension methods for updating consensus topics.

UpdateTopicParams

Represents the properties on a topic that can be changed.
Any property set to

null

on this object when submitted to the UpdateTopicAsync(ConsensusClient, UpdateTopicParams, Action<IConsensusContext>?) method will be left unchanged by the system. The transaction must be appropriately signed as described by the original Administrator endorsement in order to make changes. If there is no administrator endorsement specified, the topic is immutable and cannot be changed.

UtilityExtensions

Extension methods providing general-purpose utility operations on the consensus client.

VersionInfo

Contains version information identifying the Hedera Services version and API Protobuf version implemented by the node being queried.

VersionInfoExtensions

Extension methods for retrieving version information from the network.

Structs

ConsensusTimeStamp

Represents a consensus timestamp value to the resolution of nanoseconds.

Interfaces

IConsensusContext

A ConsensusClient instance’s configuration.

IInvoice

Represents a transaction signing request.
This structure is passed to each configured Signatory and signatory callback method to be given the opportunity to sign the request before submitting it to the network. Typically, the signatory will use its private key to sign the TransactionBytes serialized representation of the transaction request.
This is the same series of bytes that are sent to the network along with the signatures collected from the signatories.

IMirrorGrpcContext

A MirrorGrpcClient instance’s configuration.

IRoyalty

Represents a royalty (fee or royalty) associated with transfers of a token or asset.

Enums

HookCallMode

Specifies when a hook is invoked relative to the transaction.

KeyFormat

Identifies the desired public key output format.

KeyType

Identifies the type of Signatory or Endorsement. Typically these objects represent a public key or a list of child keys. For endorsements a list type can represent an n of m number of child keys that must sign to validate a transaction. For signatories, the list type represents simply a collection of keys, all of which will sign a given transaction. Presently this library natively supports individual key types of Ed25519, for signing with other keys, the Signatory should use the callback form.