Show / Hide Table of Contents

Namespace Hashgraph

Classes

AccountBalances

Extended Balance information for an Account, including Token Balances.

AccountInfo

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

Address

Represents a Hedera Network Account Address.

AppendFileParams

File content append parameters.

Asset

Class representing an asset instance. An asset instance is an non fungible token address in addition to an instance serial number.

AssetInfo

The information returned from the GetTokenInfo Client method call. It represents the details concerning a Hedera Fungable Token.

AssetMintReceipt

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

AssetMintRecord

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

AssetRoyalty

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

AssetTransfer

Represents a token transfer (Token, Account, Amount)

Association

Identifies which assets/tokens and accounts were associated as the result of a transaciton.

CallContractParams

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

CallContractRecord

Record produced from creating a new contract.

Client

Hedera Network 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.

ContractCallResult

The results returned from a contract call.

ContractCallResultData

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

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 by this query.

ContractInfo

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

CreateAccountParams

Account creation parameters.

CreateAccountReceipt

A transaction record containing information concerning the newly created account.

CreateAccountRecord

A transaction record containing information concerning the newly created account.

CreateAssetParams

Asset Creation Parameters.

CreateContractParams

Smart Contract creation properties.

CreateContractReceipt

Receipt produced from creating a new contract.

CreateContractRecord

Record produced from creating a new contract.

CreateFileParams

File creation parameters.

CreateTokenParams

Token Creation Parameters.

CreateTokenReceipt

Receipt produced from creating a new token.

CreateTokenRecord

Record produced from creating a new token.

CreateTopicParams

Consensus Topic Creation Parameters.

CreateTopicReceipt

Receipt produced from creating a new contract.

CreateTopicRecord

Record produced from creating a new contract.

CryptoBalance

Endorsement

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

ExchangeRate

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

FileInfo

Detailed description of a network file.

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 asset or token.

Gateway

Class representing the Network Address and Node Account address for gaining access to the Hedera Network.

Hex

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

MessageSegmentInfo

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

MirrorClient

Hedera Network Client

MirrorException

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

PendingParams

Pending (Scheduled) Transaction Parameters. Used for creating a Signatory signaling that the transaction should be accepted but not immediately executed. It includes optional details descrbing the details of how the transaction is to be scheduled for execution.

PendingTransaction

Information identifying a pending transaction, includes the address of the pending transaction record, plus the transaction id that will exist representing the executed transaction if it is ultimately executed (and not timed out or delted).

PendingTransactionInfo

The information returned from the GetPendingTransactionInfo Client method call. It represents the details concerning a pending (scheduled, not yet executed) transaction held by the network awaiting signatures.

PrecheckException

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

QueryContractParams

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

RoyaltyTransfer

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

SemanticVersion

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

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.

SubmitMessageParams

Advanced Submit Message Parameters, includes Segment Information.

SubmitMessageReceipt

Receipt produced from creating a new contract.

SubmitMessageRecord

Record produced from creating a new contract.

SubscribeTopicParams

SuspendNetworkParams

Parameters to set the period of time where the network will suspened will stop creating events and accepting transactions. This can be used to safely shut down the platform for maintenance and for upgrades if the file information is included.

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 Client method call. It represents the details concerning Tokens and Assets.

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 echanged, or an exise amount taken from the sender of the fungible token.

TokenTransfer

Represents a token transfer (Token, Account, Amount)

TopicInfo

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

TopicMessage

Represents a Topic Message retrieved from a mirror node.

TransactionException

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

TransactionReceipt

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

TransactionRecord

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

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.

TxId

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

TxId
implements the equitable interface and can be

compared to other transaction ids returned from the library.

UpdateAccountParams

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

null
on this object when submitted to the UpdateAccountAsync(UpdateAccountParams, Action<IContext>) method will be left unchanged by the system. Certain additional condidions apply to certain propertites such as the signing key are described below.

UpdateContractParams

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

null
on this object when submitted to the UpdateContractAsync(UpdateContractParams, Action<IContext>) 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 imutable and cannot be changed.

UpdateFileParams

Input parameters describing how to update a network file.

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(UpdateTokenParams, Action<IContext>) 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 imutable and cannot be changed.

UpdateTopicParams

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

null
on this object when submitted to the UpdateTopicAsync(UpdateTopicParams, Action<IContext>) 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 imutable and cannot be changed.

VersionInfo

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

Interfaces

IContext

A Client instance’s configuration.

IInvoice

Represents a pre-signed transaction 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 netwwork. Typically, the signatory will use its private key to sign the TxBytes serialized representation of the transaciton request.
This is the same series of bytes that are sent to the network along with the signatures collected from the signatories.

IMirrorContext

A MirrorClient instance’s configuration.

IRoyalty

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

Enums

KeyType

Identifies the type of Signatory or Endorsement. Typically these objects a 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 validat a transaction. For signatories, the list type represents simply a collection of keys, all of which sill 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.

MirrorExceptionCode

Pre-Check and Receipt Response Codes - 1to1 mapping with protobuf ResponseCodeEnum

ResponseCode

Pre-Check and Receipt Response Codes - 1to1 mapping with protobuf ResponseCodeEnum

RoyaltyType

The known types of Royalties applied to token and asset transfers.

TokenKycStatus

KYC Status of a Token

TokenTradableStatus

The Frozen Status of a Token

TokenType

The type of token.

In This Article
Back to top .NET Client Library for Hedera Hashgraph