Class Client

Hedera Network Client

Inheritance

Object

Client

Implements

IAsyncDisposable

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Hashgraph

Assembly: Hashgraph.dll

Syntax

public sealed class Client : IAsyncDisposable

Remarks

This component facilitates interaction with the Hedera Network.
It manages the communication channels with the network and serialization of requests and responses. This library generally shields the client code from directly interacting with the underlying protobuf communication layer but does provide hooks allowing advanced low-level manipulation of messages if necessary.

Constructors

Client(Action<IContext>)

Creates a new instance of an Hedera Network Client.

Declaration

public Client(Action<IContext> configure = null)

Parameters

Type	Name	Description
Action<IContext>	configure	Optional configuration method that can set the location of the network node accessing the network and how transaction fees shall be paid for.

Remarks

Creating a new instance of a

Client

initializes a new instance of a client. It will have a separate cache of GRPC channels to the network and will maintain a separate configuration from other clients. The constructor takes an optional callback method that configures the details on how the client should connect to the network and what accounts generally pay transaction fees and other details. See the IContext documentation for configuration details.

Methods

AppendFileAsync(AppendFileParams, Action<IContext>)

Appends content to an existing file.

Declaration

public async Task<TransactionReceipt> AppendFileAsync(AppendFileParams appendParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
AppendFileParams	appendParameters	Configuration object identifying the file and contents to append.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating the success of the operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

AppendFileWithRecordAsync(AppendFileParams, Action<IContext>)

Appends content to an existing file.

Declaration

public async Task<TransactionRecord> AppendFileWithRecordAsync(AppendFileParams appendParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
AppendFileParams	appendParameters	Configuration object identifying the file and contents to append.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction receipt containing the details of the transaction & fees.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

AssociateTokenAsync(Address, Address, Signatory, Action<IContext>)

Provisions Storage associated with the Account for maintaining token balances for this account.

Declaration

public async Task<TransactionReceipt> AssociateTokenAsync(Address token, Address account, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier Address of the token to associate with the account.
Address	account	Address of the account to provision token balance storage.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Remarks

Since this action will result in higher account renewal costs, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

AssociateTokenAsync(Address, Address, Action<IContext>)

Provisions Storage associated with the Account for maintaining token balances for this account.

Declaration

public async Task<TransactionReceipt> AssociateTokenAsync(Address token, Address account, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier Address of the token to associate with the account.
Address	account	Address of the account to provision token balance storage.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Remarks

Since this action will result in higher account renewal costs, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token has already been associated.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

AssociateTokensAsync(IEnumerable<Address>, Address, Signatory, Action<IContext>)

Provisions Storage associated with the Account for maintaining token balances for the listed tokens.

Declaration

public async Task<TransactionReceipt> AssociateTokensAsync(IEnumerable<Address> tokens, Address account, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
IEnumerable<Address>	tokens	The identifier Addresses of the tokens to associate with the account.
Address	account	Address of the account to provision token balance storage.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Remarks

Since this action will result in higher account renewal costs, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

AssociateTokensAsync(IEnumerable<Address>, Address, Action<IContext>)

Provisions Storage associated with the Account for maintaining token balances for the listed tokens.

Declaration

public async Task<TransactionReceipt> AssociateTokensAsync(IEnumerable<Address> tokens, Address account, Action<IContext> configure = null)

Parameters

Type	Name	Description
IEnumerable<Address>	tokens	The identifier Addresses of the tokens to associate with the account.
Address	account	Address of the account to provision token balance storage.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Remarks

Since this action will result in higher account renewal costs, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token has already been associated.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

AssociateTokensWithRecordAsync(IEnumerable<Address>, Address, Signatory, Action<IContext>)

Provisions Storage associated with the Account for maintaining token balances for the listed tokens.

Declaration

public async Task<TransactionRecord> AssociateTokensWithRecordAsync(IEnumerable<Address> tokens, Address account, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
IEnumerable<Address>	tokens	The identifier Addresses of the tokens to associate with the account.
Address	account	Address of the account to provision token balance storage.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Remarks

Since this action will result in higher account renewal costs, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

AssociateTokensWithRecordAsync(IEnumerable<Address>, Address, Action<IContext>)

Provisions Storage associated with the Account for maintaining token balances for the listed tokens.

Declaration

public async Task<TransactionRecord> AssociateTokensWithRecordAsync(IEnumerable<Address> tokens, Address account, Action<IContext> configure = null)

Parameters

Type	Name	Description
IEnumerable<Address>	tokens	The identifier Addresses of the tokens to associate with the account.
Address	account	Address of the account to provision token balance storage.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Remarks

Since this action will result in higher account renewal costs, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

AssociateTokenWithRecordAsync(Address, Address, Signatory, Action<IContext>)

Provisions Storage associated with the Account for maintaining token balances for this account.

Declaration

public async Task<TransactionRecord> AssociateTokenWithRecordAsync(Address token, Address account, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier Address of the token to associate with the account.
Address	account	Address of the account to provision token balance storage.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Remarks

Since this action will result in higher account renewal costs, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

AssociateTokenWithRecordAsync(Address, Address, Action<IContext>)

Provisions Storage associated with the Account for maintaining token balances for this account.

Declaration

public async Task<TransactionRecord> AssociateTokenWithRecordAsync(Address token, Address account, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier Address of the token to associate with the account.
Address	account	Address of the account to provision token balance storage.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Remarks

Since this action will result in higher account renewal costs, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

BurnAssetAsync(Asset, Signatory, Action<IContext>)

Destroys an asset (NFT) instance.

Declaration

public async Task<TokenReceipt> BurnAssetAsync(Asset asset, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier of the asset to destory.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this asset (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

BurnAssetAsync(Asset, Action<IContext>)

Destroys an asset (NFT) instance.

Declaration

public async Task<TokenReceipt> BurnAssetAsync(Asset asset, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier of the asset to destory.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

BurnAssetsAsync(Address, IEnumerable<Int64>, Signatory, Action<IContext>)

Destroys multiple asset (NFT) instances.

Declaration

public async Task<TokenReceipt> BurnAssetsAsync(Address token, IEnumerable<long> serialNumbers, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier of the asset token type to destory.
IEnumerable<Int64>	serialNumbers	The serial numbers of the assets to destroy.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this asset (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

BurnAssetsAsync(Address, IEnumerable<Int64>, Action<IContext>)

Destroys multiple asset (NFT) instances.

Declaration

public async Task<TokenReceipt> BurnAssetsAsync(Address token, IEnumerable<long> serialNumbers, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier of the asset token type to destory.
IEnumerable<Int64>	serialNumbers	The serial numbers of the assets to destroy.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

BurnAssetsWithRecordAsync(Address, IEnumerable<Int64>, Signatory, Action<IContext>)

Destroys multiple asset (NFT) instances.

Declaration

public async Task<TokenRecord> BurnAssetsWithRecordAsync(Address token, IEnumerable<long> serialNumbers, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier of the asset token type to destory.
IEnumerable<Int64>	serialNumbers	The serial numbers of the assets to destroy.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this asset (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

BurnAssetsWithRecordAsync(Address, IEnumerable<Int64>, Action<IContext>)

Destroys multiple asset (NFT) instances.

Declaration

public async Task<TokenRecord> BurnAssetsWithRecordAsync(Address token, IEnumerable<long> serialNumbers, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier of the asset token type to destory.
IEnumerable<Int64>	serialNumbers	The serial numbers of the assets to destroy.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

BurnAssetWithRecordAsync(Asset, Signatory, Action<IContext>)

Destroys an asset (NFT) instance.

Declaration

public async Task<TokenRecord> BurnAssetWithRecordAsync(Asset asset, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier of the asset to destory.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this asset (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

BurnAssetWithRecordAsync(Asset, Action<IContext>)

Destroys an asset (NFT) instance.

Declaration

public async Task<TokenRecord> BurnAssetWithRecordAsync(Asset asset, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier of the asset to destory.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

BurnTokenAsync(Address, UInt64, Signatory, Action<IContext>)

Removes token coins from the treasury.

Declaration

public async Task<TokenReceipt> BurnTokenAsync(Address token, ulong amount, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to remove coins from.
UInt64	amount	The amount of coins to remove (specified in the smallest denomination).
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

BurnTokenAsync(Address, UInt64, Action<IContext>)

Removes token coins from the treasury.

Declaration

public async Task<TokenReceipt> BurnTokenAsync(Address token, ulong amount, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to remove coins from.
UInt64	amount	The amount of coins to remove (specified in the smallest denomination).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

BurnTokenWithRecordAsync(Address, UInt64, Signatory, Action<IContext>)

Removes token coins from the treasury.

Declaration

public async Task<TokenRecord> BurnTokenWithRecordAsync(Address token, ulong amount, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to remove coins from.
UInt64	amount	The amount of coins to remove (specified in the smallest denomination).
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

BurnTokenWithRecordAsync(Address, UInt64, Action<IContext>)

Removes token coins from the treasury.

Declaration

public async Task<TokenRecord> BurnTokenWithRecordAsync(Address token, ulong amount, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to remove coins from.
UInt64	amount	The amount of coins to remove (specified in the smallest denomination).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CallContractAsync(CallContractParams, Action<IContext>)

Calls a smart contract returning a receipt indicating success.
This can be used for contract calls that do not return data. If the contract returns data, call the CallContractWithRecordAsync(CallContractParams, Action<IContext>) call instead to retrieve the information returned from the function call.

Declaration

public async Task<TransactionReceipt> CallContractAsync(CallContractParams callParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CallContractParams	callParameters	An object identifying the function to call, any input parameters and the amount of gas that may be used to execute the request.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A contract transaction receipt indicating success, it does not include any output parameters sent from the contract.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CallContractWithRecordAsync(CallContractParams, Action<IContext>)

Calls a smart contract returning if successful. The CallContractReceipt will include the details of the results from the call, including the output parameters returned by the function call.

Declaration

public async Task<CallContractRecord> CallContractWithRecordAsync(CallContractParams callParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CallContractParams	callParameters	An object identifying the function to call, any input parameters and the amount of gas that may be used to execute the request.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<CallContractRecord>	A contract transaction record indicating success, it also any output parameters sent from the contract function.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

Clone(Action<IContext>)

Creates a new instance of the client having a shared base configuration with its parent. Changes to the parent’s configuration will reflect in this instances configuration while changes in this instances configuration will not be reflected in the parent configuration.

Declaration

public Client Clone(Action<IContext> configure = null)

Parameters

Type	Name	Description
Action<IContext>	configure	The callback method receiving the IContext object providing the configuration details of this client instance. Values can be retrieved and set within the context of the method invocation.

Returns

Type	Description
Client	A new instance of a client object.

Configure(Action<IContext>)

Updates the configuration of this instance of a client thru implementation of the supplied IContext callback method.

Declaration

public void Configure(Action<IContext> configure)

Parameters

Type	Name	Description
Action<IContext>	configure	The callback method receiving the IContext object providing the configuration details of this client instance. Values can be retrieved and set within the context of the method invocation.

ConfiscateAssetAsync(Asset, Address, Signatory, Action<IContext>)

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

Declaration

public async Task<TokenReceipt> ConfiscateAssetAsync(Asset asset, Address address, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier (Address & Serial Number) of the asset to confiscate.
Address	address	Address of the account holding the asset to remove.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this asset (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ConfiscateAssetAsync(Asset, Address, Action<IContext>)

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

Declaration

public async Task<TokenReceipt> ConfiscateAssetAsync(Asset asset, Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier (Address & Serial Number) of the asset to confiscate.
Address	address	Address of the account holding the asset to remove.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ConfiscateAssetsAsync(Address, IEnumerable<Int64>, Address, Signatory, Action<IContext>)

Removes the holdings of multiple assets from the associated account and destorys them. Must be signed by the confiscate/wipe admin key.

Declaration

public async Task<TokenReceipt> ConfiscateAssetsAsync(Address token, IEnumerable<long> serialNumbers, Address address, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	Address of the asset type.
IEnumerable<Int64>	serialNumbers	Serial Numbers of assets to confiscate.
Address	address	Address of the account holding the assets to remove.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this asset (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ConfiscateAssetsAsync(Address, IEnumerable<Int64>, Address, Action<IContext>)

Removes the holdings of multiple assets from the associated account and destorys them. Must be signed by the confiscate/wipe admin key.

Declaration

public async Task<TokenReceipt> ConfiscateAssetsAsync(Address token, IEnumerable<long> serialNumbers, Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	Address of the asset type.
IEnumerable<Int64>	serialNumbers	Serial Numbers of assets to confiscate.
Address	address	Address of the account holding the assets to remove.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ConfiscateAssetsWithRecordAsync(Address, IEnumerable<Int64>, Address, Signatory, Action<IContext>)

Removes the holdings of multiple assets from the associated account and destorys them. Must be signed by the confiscate/wipe admin key.

Declaration

public async Task<TokenRecord> ConfiscateAssetsWithRecordAsync(Address token, IEnumerable<long> serialNumbers, Address address, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	Address of the asset type.
IEnumerable<Int64>	serialNumbers	Serial Numbers of assets to confiscate.
Address	address	Address of the account holding the assets to remove.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this asset (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ConfiscateAssetsWithRecordAsync(Address, IEnumerable<Int64>, Address, Action<IContext>)

Removes the holdings of multiple assets from the associated account and destorys them. Must be signed by the confiscate/wipe admin key.

Declaration

public async Task<TokenRecord> ConfiscateAssetsWithRecordAsync(Address token, IEnumerable<long> serialNumbers, Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	Address of the asset type.
IEnumerable<Int64>	serialNumbers	Serial Numbers of assets to confiscate.
Address	address	Address of the account holding the assets to remove.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ConfiscateAssetWithRecordAsync(Asset, Address, Signatory, Action<IContext>)

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

Declaration

public async Task<TokenRecord> ConfiscateAssetWithRecordAsync(Asset asset, Address address, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier (Address & Serial Number) of the asset to confiscate.
Address	address	Address of the account holding the asset to remove.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this asset (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ConfiscateAssetWithRecordAsync(Asset, Address, Action<IContext>)

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

Declaration

public async Task<TokenRecord> ConfiscateAssetWithRecordAsync(Asset asset, Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier (Address & Serial Number) of the asset to confiscate.
Address	address	Address of the account holding the asset to remove.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ConfiscateTokensAsync(Address, Address, UInt64, Signatory, Action<IContext>)

Removes the holdings of given token from the associated account and returns them to the treasury. Must be signed by the confiscate/wipe admin key.

Declaration

public async Task<TokenReceipt> ConfiscateTokensAsync(Address token, Address address, ulong amount, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to confiscate.
Address	address	Address of the account holding the tokens to remove.
UInt64	amount	The amount of coins to confiscate (of the divisible denomination)
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ConfiscateTokensAsync(Address, Address, UInt64, Action<IContext>)

Removes the holdings of given token from the associated account and returns them to the treasury. Must be signed by the confiscate/wipe admin key.

Declaration

public async Task<TokenReceipt> ConfiscateTokensAsync(Address token, Address address, ulong amount, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to confiscate.
Address	address	Address of the account holding the tokens to remove.
UInt64	amount	The amount of coins to confiscate (of the divisible denomination)
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ConfiscateTokensWithRecordAsync(Address, Address, UInt64, Signatory, Action<IContext>)

Removes the holdings of given token from the associated account and returns them to the treasury. Must be signed by the confiscate/wipe admin key.

Declaration

public async Task<TokenRecord> ConfiscateTokensWithRecordAsync(Address token, Address address, ulong amount, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to confiscate.
Address	address	Address of the account holding the tokens to remove.
UInt64	amount	The amount of coins to confiscate (of the divisible denomination)
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ConfiscateTokensWithRecordAsync(Address, Address, UInt64, Action<IContext>)

Removes the holdings of given token from the associated account and returns them to the treasury. Must be signed by the confiscate/wipe admin key.

Declaration

public async Task<TokenRecord> ConfiscateTokensWithRecordAsync(Address token, Address address, ulong amount, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to confiscate.
Address	address	Address of the account holding the tokens to remove.
UInt64	amount	The amount of coins to confiscate (of the divisible denomination)
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CreateAccountAsync(CreateAccountParams, Action<IContext>)

Creates a new network account with a given initial balance and other values as indicated in the create parameters.

Declaration

public async Task<CreateAccountReceipt> CreateAccountAsync(CreateAccountParams createParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CreateAccountParams	createParameters	The account creation parameters, includes the initial balance, public key and values associated with the new account.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<CreateAccountReceipt>	A transaction recipt with a description of the newly created account.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CreateAccountWithRecordAsync(CreateAccountParams, Action<IContext>)

Creates a new network account with a given initial balance and other values as indicated in the create parameters.

Declaration

public async Task<CreateAccountRecord> CreateAccountWithRecordAsync(CreateAccountParams createParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CreateAccountParams	createParameters	The account creation parameters, includes the initial balance, public key and values associated with the new account.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<CreateAccountRecord>	A transaction record with a description of the newly created account and record information.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CreateContractAsync(CreateContractParams, Action<IContext>)

Creates a new contract instance with the given create parameters.

Declaration

public async Task<CreateContractReceipt> CreateContractAsync(CreateContractParams createParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CreateContractParams	createParameters	Details regarding the contract to instantiate.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<CreateContractReceipt>	A transaction receipt with a description of the newly created contract. and receipt information.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CreateContractWithRecordAsync(CreateContractParams, Action<IContext>)

Creates a new contract instance with the given create parameters returning a detailed record.

Declaration

public async Task<CreateContractRecord> CreateContractWithRecordAsync(CreateContractParams createParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CreateContractParams	createParameters	Details regarding the contract to instantiate.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<CreateContractRecord>	A transaction record with a description of the newly created contract. and receipt information.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CreateFileAsync(CreateFileParams, Action<IContext>)

Creates a new file with the given content.

Declaration

public async Task<FileReceipt> CreateFileAsync(CreateFileParams createParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CreateFileParams	createParameters	File creation parameters specifying contents and ownership of the file.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<FileReceipt>	A transaction receipt with a description of the newly created file. and record information.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CreateFileWithRecordAsync(CreateFileParams, Action<IContext>)

Creates a new file with the given content.

Declaration

public async Task<FileRecord> CreateFileWithRecordAsync(CreateFileParams createParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CreateFileParams	createParameters	File creation parameters specifying contents and ownership of the file.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<FileRecord>	A transaction record with a description of the newly created file & fees. and record information.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CreateNewTxId(Action<IContext>)

Creates a new Transaction Id

Declaration

public TxId CreateNewTxId(Action<IContext> configure = null)

Parameters

Type	Name	Description
Action<IContext>	configure

Returns

Type	Description
TxId

CreateTokenAsync(CreateAssetParams, Action<IContext>)

Creates a new asset (non fungible token) with the given create parameters.

Declaration

public async Task<CreateTokenReceipt> CreateTokenAsync(CreateAssetParams createParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CreateAssetParams	createParameters	Details regarding the asset to instantiate.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<CreateTokenReceipt>	A transaction receipt with a description of the newly created Asset.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CreateTokenAsync(CreateTokenParams, Action<IContext>)

Creates a new token with the given create parameters.

Declaration

public async Task<CreateTokenReceipt> CreateTokenAsync(CreateTokenParams createParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CreateTokenParams	createParameters	Details regarding the token to instantiate.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<CreateTokenReceipt>	A transaction receipt with a description of the newly created token.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CreateTokenWithRecordAsync(CreateAssetParams, Action<IContext>)

Creates a new Asset instance with the given create parameters.

Declaration

public async Task<CreateTokenRecord> CreateTokenWithRecordAsync(CreateAssetParams createParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CreateAssetParams	createParameters	Details regarding the Asset to instantiate.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<CreateTokenRecord>	A transaction record with a description of the newly created Asset.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CreateTokenWithRecordAsync(CreateTokenParams, Action<IContext>)

Creates a new token instance with the given create parameters.

Declaration

public async Task<CreateTokenRecord> CreateTokenWithRecordAsync(CreateTokenParams createParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CreateTokenParams	createParameters	Details regarding the token to instantiate.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<CreateTokenRecord>	A transaction record with a description of the newly created token.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CreateTopicAsync(CreateTopicParams, Action<IContext>)

Creates a new topic instance with the given create parameters.

Declaration

public async Task<CreateTopicReceipt> CreateTopicAsync(CreateTopicParams createParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CreateTopicParams	createParameters	Details regarding the topic to instantiate.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<CreateTopicReceipt>	A transaction receipt with a description of the newly created topic.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

CreateTopicWithRecordAsync(CreateTopicParams, Action<IContext>)

Creates a new topic instance with the given create parameters.

Declaration

public async Task<CreateTopicRecord> CreateTopicWithRecordAsync(CreateTopicParams createParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
CreateTopicParams	createParameters	Details regarding the topic to instantiate.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<CreateTopicRecord>	A transaction record with a description of the newly created topic.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeleteAccountAsync(Address, Address, Signatory, Action<IContext>)

Deletes an account from the network returning the remaining crypto balance to the specified account. Must be signed by the account being deleted.

Declaration

public async Task<TransactionReceipt> DeleteAccountAsync(Address addressToDelete, Address transferToAddress, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	addressToDelete	The address for account that will be deleted.
Address	transferToAddress	The account that will receive any remaining balance from the deleted account.
Signatory	signatory	The signatory containing any additional private keys or callbacks to meet the requirements for deleting the account and transferring the remaining crypto balance.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeleteAccountAsync(Address, Address, Action<IContext>)

Deletes an account from the network returning the remaining crypto balance to the specified account. Must be signed by the account being deleted.

Declaration

public async Task<TransactionReceipt> DeleteAccountAsync(Address addressToDelete, Address transferToAddress, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	addressToDelete	The address for account that will be deleted.
Address	transferToAddress	The account that will receive any remaining balance from the deleted account.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeleteContractAsync(Address, Address, Signatory, Action<IContext>)

Deletes a contract instance from the network returning the remaining crypto balance to the specified address. Must be signed by the admin key.

Declaration

public async Task<TransactionReceipt> DeleteContractAsync(Address contractToDelete, Address transferToAddress, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contractToDelete	The Contract instance that will be deleted.
Address	transferToAddress	The address that will receive any remaining balance from the deleted Contract.
Signatory	signatory	Additional signing key/callback matching the administrative endorsements associated with this contract (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the contract is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeleteContractAsync(Address, Address, Action<IContext>)

Deletes a contract instance from the network returning the remaining crypto balance to the specified address. Must be signed by the admin key.

Declaration

public async Task<TransactionReceipt> DeleteContractAsync(Address contractToDelete, Address transferToAddress, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contractToDelete	The Contract instance that will be deleted.
Address	transferToAddress	The address that will receive any remaining balance from the deleted Contract.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the contract is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeleteFileAsync(Address, Signatory, Action<IContext>)

Removes a file from the network.

Declaration

public async Task<TransactionReceipt> DeleteFileAsync(Address fileToDelete, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	fileToDelete	The address of the file to delete.
Signatory	signatory	Typically private key, keys or signing callback method that are needed to delete the file as per the requirements in the associated Endorsement.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the file deletion.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeleteFileAsync(Address, Action<IContext>)

Removes a file from the network.

Declaration

public async Task<TransactionReceipt> DeleteFileAsync(Address fileToDelete, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	fileToDelete	The address of the file to delete.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the file deletion.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeleteFileWithRecordAsync(Address, Signatory, Action<IContext>)

Removes a file from the network.

Declaration

public async Task<TransactionRecord> DeleteFileWithRecordAsync(Address fileToDelete, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	fileToDelete	The address of the file to delete.
Signatory	signatory	Typically private key, keys or signing callback method that are needed to delete the file as per the requirements in the associated Endorsement.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating success of the file deletion, fees & other transaction details.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeleteFileWithRecordAsync(Address, Action<IContext>)

Removes a file from the network.

Declaration

public async Task<TransactionRecord> DeleteFileWithRecordAsync(Address fileToDelete, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	fileToDelete	The address of the file to delete.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating success of the file deletion, fees & other transaction details.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeletePendingTransactionAsync(Address, Signatory, Action<IContext>)

Deletes a token from the network. Must be signed by the admin key.

Declaration

public async Task<TransactionReceipt> DeletePendingTransactionAsync(Address pending, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	pending	The identifier (Address) of the pending transaction to cancel.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeletePendingTransactionAsync(Address, Action<IContext>)

Deletes a pending transaction from the network. Must be signed by the admin key.

Declaration

public async Task<TransactionReceipt> DeletePendingTransactionAsync(Address pending, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	pending	The identifier (Address) of the pending transaction to cancel.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeleteTokenAsync(Address, Signatory, Action<IContext>)

Deletes a token from the network. Must be signed by the admin key.

Declaration

public async Task<TransactionReceipt> DeleteTokenAsync(Address token, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token instance that will be deleted.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeleteTokenAsync(Address, Action<IContext>)

Deletes a token instance from the network. Must be signed by the admin key.

Declaration

public async Task<TransactionReceipt> DeleteTokenAsync(Address token, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token instance that will be deleted.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeleteTopicAsync(Address, Signatory, Action<IContext>)

Deletes a topic instance from the network. Must be signed by the admin key.

Declaration

public async Task<TransactionReceipt> DeleteTopicAsync(Address topic, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	topic	The Topic instance that will be deleted.
Signatory	signatory	Additional signing key/callback matching the administrative endorsements associated with this topic (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the topic is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DeleteTopicAsync(Address, Action<IContext>)

Deletes a topic instance from the network. Must be signed by the admin key.

Declaration

public async Task<TransactionReceipt> DeleteTopicAsync(Address topic, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	topic	The Topic instance that will be deleted.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the topic is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DisposeAsync()

.NET Asynchronous dispose method.

Declaration

public ValueTask DisposeAsync()

Returns

Type	Description
ValueTask	An Async Task.

Remarks

Closes any GRPC channels solely owned by this

Client

instance.

DissociateTokenAsync(Address, Address, Signatory, Action<IContext>)

Removes Storage associated with the Account for maintaining token balances for this account.

Declaration

public async Task<TransactionReceipt> DissociateTokenAsync(Address token, Address account, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The Address of the token that will be dissociated.
Address	account	Address of the account that will be dissociated.
Signatory	signatory	Additional signing key matching the administrative endorsements dissociated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Remarks

Since this action modifies the account's records, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DissociateTokenAsync(Address, Address, Action<IContext>)

Removes Storage associated with the Account for maintaining token balances for this account.

Declaration

public async Task<TransactionReceipt> DissociateTokenAsync(Address token, Address account, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The Address of the token that will be dissociated.
Address	account	Address of the account that will be dissociated.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Remarks

Since this action modifies the account's records, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token has already been dissociated.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DissociateTokensAsync(IEnumerable<Address>, Address, Signatory, Action<IContext>)

Removes Storage associated with the Account for maintaining token balances for this account.

Declaration

public async Task<TransactionReceipt> DissociateTokensAsync(IEnumerable<Address> tokens, Address account, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
IEnumerable<Address>	tokens	The Address of the tokens that will be dissociated.
Address	account	Address of the account that will be dissociated.
Signatory	signatory	Additional signing key matching the administrative endorsements dissociated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Remarks

Since this action modifies the account's records, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DissociateTokensAsync(IEnumerable<Address>, Address, Action<IContext>)

Removes Storage associated with the Account for maintaining token balances for this account.

Declaration

public async Task<TransactionReceipt> DissociateTokensAsync(IEnumerable<Address> tokens, Address account, Action<IContext> configure = null)

Parameters

Type	Name	Description
IEnumerable<Address>	tokens	The Address of the tokens that will be dissociated.
Address	account	Address of the account that will be dissociated.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Remarks

Since this action modifies the account's records, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token has already been dissociated.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DissociateTokensWithRecordAsync(IEnumerable<Address>, Address, Signatory, Action<IContext>)

Removes Storage associated with the Account for maintaining token balances for this account.

Declaration

public async Task<TransactionRecord> DissociateTokensWithRecordAsync(IEnumerable<Address> tokens, Address account, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
IEnumerable<Address>	tokens	The Address of the tokens that will be dissociated.
Address	account	Address of the account that will be dissociated.
Signatory	signatory	Additional signing key matching the administrative endorsements dissociated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Remarks

Since this action modifies the account's records, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DissociateTokensWithRecordAsync(IEnumerable<Address>, Address, Action<IContext>)

Removes Storage associated with the Account for maintaining token balances for this account.

Declaration

public async Task<TransactionRecord> DissociateTokensWithRecordAsync(IEnumerable<Address> tokens, Address account, Action<IContext> configure = null)

Parameters

Type	Name	Description
IEnumerable<Address>	tokens	The Address of the tokens that will be dissociated.
Address	account	Address of the account that will be dissociated.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Remarks

Since this action modifies the account's records, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DissociateTokenWithRecordAsync(Address, Address, Signatory, Action<IContext>)

Removes Storage associated with the Account for maintaining token balances for this account.

Declaration

public async Task<TransactionRecord> DissociateTokenWithRecordAsync(Address token, Address account, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The Address of the token that will be dissociated.
Address	account	Address of the account that will be dissociated.
Signatory	signatory	Additional signing key matching the administrative endorsements dissociated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Remarks

Since this action modifies the account's records, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

DissociateTokenWithRecordAsync(Address, Address, Action<IContext>)

Removes Storage associated with the Account for maintaining token balances for this account.

Declaration

public async Task<TransactionRecord> DissociateTokenWithRecordAsync(Address token, Address account, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The Address of the token that will be dissociated.
Address	account	Address of the account that will be dissociated.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Remarks

Since this action modifies the account's records, it must be signed by the account's key.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

GetAccountBalanceAsync(Address, Action<IContext>)

Retrieves the balance in tinybars from the network for a given address.

Declaration

public async Task<ulong> GetAccountBalanceAsync(Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	address	The hedera network address to retrieve the balance of.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<UInt64>	The balance of the associated address.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GetAccountBalancesAsync(Address, Action<IContext>)

Retrieves the crypto and token blances from the network for a given address.

Declaration

public async Task<AccountBalances> GetAccountBalancesAsync(Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	address	The hedera network address to retrieve the balance of.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<AccountBalances>	An object containing the crypto balance associated with the account in addition to a list of all tokens held by the account with their balances.

GetAccountInfoAsync(Address, Action<IContext>)

Retrieves detailed information regarding a Hedera Network Account.

Declaration

public async Task<AccountInfo> GetAccountInfoAsync(Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	address	The Hedera Network Address to retrieve detailed information of.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<AccountInfo>	A detailed description of the account.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GetAccountRecordsAsync(Address, Action<IContext>)

Retrieves the account records associated with an account that are presently held within the network because they exceeded the receive or send threshold values for autogeneration of records.

Declaration

public async Task<TransactionRecord[]> GetAccountRecordsAsync(Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	address	The Hedera Network Address to retrieve associated records.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord[]>	A detailed description of the account.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GetAllReceiptsAsync(TxId, Action<IContext>)

Retreives all known receipts from the network having the given transaction ID. The method will wait for the disposition of at least one receipt to be known. Receipts with failure codes do not cause an exception to be raised.

Declaration

public async Task<ReadOnlyCollection<TransactionReceipt>> GetAllReceiptsAsync(TxId transaction, Action<IContext> configure = null)

Parameters

Type	Name	Description
TxId	transaction	Transaction identifier of the receipt.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<ReadOnlyCollection<TransactionReceipt>>	A list of receipts having the identified transaction. The list may be empty or contain multiple entries.

Exceptions

Type	Condition
ConsensusException	if the receipt is known to exist but has not reached consensus within the alloted time to wait for a return from this method or the network has been too busy to respond.

GetAllTransactionRecordsAsync(TxId, Action<IContext>)

Retrieves all records having the given transaction ID, including duplicates that were rejected or produced errors during execution. Typically there is only one record per transaction, but in some cases, deliberate or accidental there may be more than one for a given transaction ID.

Declaration

public async Task<ReadOnlyCollection<TransactionRecord>> GetAllTransactionRecordsAsync(TxId transaction, Action<IContext> configure = null)

Parameters

Type	Name	Description
TxId	transaction	Transaction identifier of the record
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<ReadOnlyCollection<TransactionRecord>>	An collection of all the transaction records known to the system at the time of query having the identified transaction id.

GetAssetInfoAsync(Asset, Action<IContext>)

Retrieves detailed information regarding a particular asset (NFT) instance.

Declaration

public async Task<AssetInfo> GetAssetInfoAsync(Asset asset, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier (Address and Serial Number) of the asset.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<AssetInfo>	A description of the asset instance, including metadata, created date and current owning account.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GetContractBalanceAsync(Address, Action<IContext>)

Retrieves the balance in tinybars from the network for a given contract.

Declaration

public async Task<ulong> GetContractBalanceAsync(Address contract, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contract	The hedera network contract address to retrieve the balance of.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<UInt64>	The balance of the associated contract.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GetContractBalancesAsync(Address, Action<IContext>)

Retrieves the crypto and token blances from the network for a given contract.

Declaration

public async Task<AccountBalances> GetContractBalancesAsync(Address contract, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contract
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<AccountBalances>	An object containing the crypto balance associated with the contract in addition to a list of all tokens held by the contract with their balances.

GetContractBytecodeAsync(Address, Action<IContext>)

Retrieves the bytecode for the specified contract.

Declaration

public async Task<ReadOnlyMemory<byte>> GetContractBytecodeAsync(Address contract, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contract	The Hedera Network Address of the Contract.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<ReadOnlyMemory<Byte>>	The bytecode for the specified contract instance.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GetContractInfoAsync(Address, Action<IContext>)

Retrieves detailed information regarding a Smart Contract Instance.

Declaration

public async Task<ContractInfo> GetContractInfoAsync(Address contract, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contract	The Hedera Network Address of the Contract instance to retrieve.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<ContractInfo>	A detailed description of the contract instance.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GetExecutionTimes(IEnumerable<TxId>, Action<IContext>)

Retrieves the time in nanoseconds spent by the gossip node in processing the identified transaction. The storage of this information varies by node and network configuration and may not be enabled on all networks.

Declaration

public async Task<IReadOnlyCollection<ulong>> GetExecutionTimes(IEnumerable<TxId> transactionIds, Action<IContext> configure = null)

Parameters

Type	Name	Description
IEnumerable<TxId>	transactionIds	Array of Transaction IDs to query.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<IReadOnlyCollection<UInt64>>	The executions time(s) in nano seconds for the requested transactions.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GetFileContentAsync(Address, Action<IContext>)

Retrieves the contents of a file from the network.

Declaration

public async Task<ReadOnlyMemory<byte>> GetFileContentAsync(Address file, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	file	The address of the file contents to retrieve.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<ReadOnlyMemory<Byte>>	The contents of the file as a blob of bytes.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

GetFileInfoAsync(Address, Action<IContext>)

Retrieves the details regarding a file stored on the network.

Declaration

public async Task<FileInfo> GetFileInfoAsync(Address file, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	file	Address of the file to query.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<FileInfo>	The details of the network file, excluding content.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GetPendingTransactionInfoAsync(Address, Action<IContext>)

Retrieves detailed information regarding a pending transaction by ID.

Declaration

public async Task<PendingTransactionInfo> GetPendingTransactionInfoAsync(Address pending, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	pending	The identifier (Address/Schedule ID) of the pending transaction to retrieve.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<PendingTransactionInfo>	A detailed description of the pending transaction, including the serialized pending transaction body itself.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GetReceiptAsync(TxId, Action<IContext>)

Retrieves the receipt from the network matching the transaction id. Will wait for the disposition of the receipt to be known.

Declaration

public async Task<TransactionReceipt> GetReceiptAsync(TxId transaction, Action<IContext> configure = null)

Parameters

Type	Name	Description
TxId	transaction	Transaction identifier of the receipt.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	The receipt matching the transaction id, if found and marked sucessfull, otherwise a TransactionException is not found or returns an error status.

Exceptions

Type	Condition
TransactionException	If the network has no record of the transaction or request has invalid or had missing data.

GetTokenInfoAsync(Address, Action<IContext>)

Retrieves detailed information regarding a Token.

Declaration

public async Task<TokenInfo> GetTokenInfoAsync(Address token, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to retrieve.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenInfo>	A detailed description of the contract instance.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GetTopicInfoAsync(Address, Action<IContext>)

Retrieves detailed information regarding a Topic Instance.

Declaration

public async Task<TopicInfo> GetTopicInfoAsync(Address topic, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	topic	The Hedera Network Address of the Topic instance to retrieve.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TopicInfo>	A detailed description of the contract instance.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GetTransactionRecordAsync(TxId, Action<IContext>)

Retrieves the transaction record for a given transaction ID that was successfully processed, otherwise the first one to reach consensus.

Declaration

public async Task<TransactionRecord> GetTransactionRecordAsync(TxId transaction, Action<IContext> configure = null)

Parameters

Type	Name	Description
TxId	transaction	Transaction identifier of the record
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record with the specified id, or an exception if not found.

Remarks

Generally there is only one record per transaction, but in certain cases where there is a transaction ID collision (deliberate or accidental) there may be more, the GetAllTransactionRecordsAsync(TxId, Action<IContext>) method may be used to retreive all records.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
TransactionException	If the network has no record of the transaction or request has invalid or had missing data.

GetVersionInfoAsync(Action<IContext>)

Retrieves version information from the node.

Declaration

public async Task<VersionInfo> GetVersionInfoAsync(Action<IContext> configure = null)

Parameters

Type	Name	Description
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<VersionInfo>	Version information regarding the gossip network node.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.

GrantTokenKycAsync(Address, Address, Signatory, Action<IContext>)

Grants KYC status to the associated account's relating to the specified token.

Declaration

public async Task<TransactionReceipt> GrantTokenKycAsync(Address token, Address address, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to grant KYC.
Address	address	Address of the account to suspend.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

GrantTokenKycAsync(Address, Address, Action<IContext>)

Grants KYC status to the associated account's relating to the specified token.

Declaration

public async Task<TransactionReceipt> GrantTokenKycAsync(Address token, Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to grant KYC.
Address	address	Address of the account to suspend.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

GrantTokenKycWithRecordAsync(Address, Address, Signatory, Action<IContext>)

Grants KYC status to the associated account's relating to the specified token.

Declaration

public async Task<TransactionRecord> GrantTokenKycWithRecordAsync(Address token, Address address, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to grant KYC.
Address	address	Address of the account to suspend.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

GrantTokenKycWithRecordAsync(Address, Address, Action<IContext>)

Grants KYC status to the associated account's relating to the specified token.

Declaration

public async Task<TransactionRecord> GrantTokenKycWithRecordAsync(Address token, Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to grant KYC.
Address	address	Address of the account to suspend.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

MintAssetAsync(Address, IEnumerable<ReadOnlyMemory<Byte>>, Signatory, Action<IContext>)

Adds asset coins to the treasury.

Declaration

public async Task<AssetMintReceipt> MintAssetAsync(Address asset, IEnumerable<ReadOnlyMemory<byte>> metadata, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	asset	The identifier (Address/Symbol) of the asset to add coins to.
IEnumerable<ReadOnlyMemory<Byte>>	metadata	A list of metadata, a series of bytes (not to exceed 100), one for each asset that is created.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this asset (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<AssetMintReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

MintAssetAsync(Address, IEnumerable<ReadOnlyMemory<Byte>>, Action<IContext>)

Adds asset coins to the treasury.

Declaration

public async Task<AssetMintReceipt> MintAssetAsync(Address asset, IEnumerable<ReadOnlyMemory<byte>> metadata, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	asset	The identifier (Address/Symbol) of the asset to add coins to.
IEnumerable<ReadOnlyMemory<Byte>>	metadata	A list of metadata, a series of bytes (not to exceed 100), one for each asset that is created.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<AssetMintReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

MintAssetWithRecordAsync(Address, IEnumerable<ReadOnlyMemory<Byte>>, Signatory, Action<IContext>)

Adds asset coins to the treasury.

Declaration

public async Task<AssetMintRecord> MintAssetWithRecordAsync(Address asset, IEnumerable<ReadOnlyMemory<byte>> metadata, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	asset	The identifier (Address/Symbol) of the asset to add coins to.
IEnumerable<ReadOnlyMemory<Byte>>	metadata	A list of metadata, a series of bytes (not to exceed 100), one for each asset that is created.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this asset (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<AssetMintRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

MintAssetWithRecordAsync(Address, IEnumerable<ReadOnlyMemory<Byte>>, Action<IContext>)

Adds asset coins to the treasury.

Declaration

public async Task<AssetMintRecord> MintAssetWithRecordAsync(Address asset, IEnumerable<ReadOnlyMemory<byte>> metadata, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	asset	The identifier (Address/Symbol) of the asset to add coins to.
IEnumerable<ReadOnlyMemory<Byte>>	metadata	A list of metadata, a series of bytes (not to exceed 100), one for each asset that is created.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<AssetMintRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the asset is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

MintTokenAsync(Address, UInt64, Signatory, Action<IContext>)

Adds token coins to the treasury.

Declaration

public async Task<TokenReceipt> MintTokenAsync(Address token, ulong amount, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to add coins to.
UInt64	amount	The amount of coins to add (of the divisible denomination)
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

MintTokenAsync(Address, UInt64, Action<IContext>)

Adds token coins to the treasury.

Declaration

public async Task<TokenReceipt> MintTokenAsync(Address token, ulong amount, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to add coins to.
UInt64	amount	The amount of coins to add (of the divisible denomination)
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

MintTokenWithRecordAsync(Address, UInt64, Signatory, Action<IContext>)

Adds token coins to the treasury.

Declaration

public async Task<TokenRecord> MintTokenWithRecordAsync(Address token, ulong amount, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to add coins to.
UInt64	amount	The amount of coins to add (of the divisible denomination)
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

MintTokenWithRecordAsync(Address, UInt64, Action<IContext>)

Adds token coins to the treasury.

Declaration

public async Task<TokenRecord> MintTokenWithRecordAsync(Address token, ulong amount, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to add coins to.
UInt64	amount	The amount of coins to add (of the divisible denomination)
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TokenRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

QueryContractAsync(QueryContractParams, Action<IContext>)

Calls a smart contract function locally on the gateway node.

Declaration

public async Task<ContractCallResult> QueryContractAsync(QueryContractParams queryParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
QueryContractParams	queryParameters	The parameters identifying the contract and function method to call.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<ContractCallResult>	The results from the local contract query call.

Remarks

This is performed locally on the gateway node. It cannot change the state of the contract instance (and so, cannot spend anything from the instance's cryptocurrency account). It will not have a consensus timestamp nor a record or a receipt. The response will contain the output returned by the function call.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ContractException	If the request was accepted by the network but the cotnract failed for some reason. Contains additional information returned from the contract virual machine. Only thrown if the ThrowOnFail is set to true , the default, otherwise the method returns a ContractCallResult with the same information.

ResumeTokenAsync(Address, Address, Signatory, Action<IContext>)

Resumes the associated account's ability to send or receive the specified token.

Declaration

public async Task<TransactionReceipt> ResumeTokenAsync(Address token, Address address, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to resume/unfreeze.
Address	address	Address of the account to suspend.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ResumeTokenAsync(Address, Address, Action<IContext>)

Resumes the associated account's ability to send or receive the specified token.

Declaration

public async Task<TransactionReceipt> ResumeTokenAsync(Address token, Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to resume/unfreeze.
Address	address	Address of the account to suspend.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ResumeTokenWithRecordAsync(Address, Address, Signatory, Action<IContext>)

Resumes the associated account's ability to send or receive the specified token.

Declaration

public async Task<TransactionRecord> ResumeTokenWithRecordAsync(Address token, Address address, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to resume/unfreeze.
Address	address	Address of the account to suspend.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

ResumeTokenWithRecordAsync(Address, Address, Action<IContext>)

Resumes the associated account's ability to send or receive the specified token.

Declaration

public async Task<TransactionRecord> ResumeTokenWithRecordAsync(Address token, Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to resume/unfreeze.
Address	address	Address of the account to suspend.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

RevokeTokenKycAsync(Address, Address, Signatory, Action<IContext>)

Revokes KYC status from the associated account's relating to the specified token. receive the specified token.

Declaration

public async Task<TransactionReceipt> RevokeTokenKycAsync(Address token, Address address, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to revoke KYC status.
Address	address	Address of the account to suspend.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

RevokeTokenKycAsync(Address, Address, Action<IContext>)

Revokes KYC status from the associated account's relating to the specified token.

Declaration

public async Task<TransactionReceipt> RevokeTokenKycAsync(Address token, Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to revoke KYC status.
Address	address	Address of the account to suspend.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

RevokeTokenKycWithRecordAsync(Address, Address, Signatory, Action<IContext>)

Revokes KYC status from the associated account's relating to the specified token. receive the specified token.

Declaration

public async Task<TransactionRecord> RevokeTokenKycWithRecordAsync(Address token, Address address, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to revoke KYC status.
Address	address	Address of the account to suspend.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

RevokeTokenKycWithRecordAsync(Address, Address, Action<IContext>)

Revokes KYC status from the associated account's relating to the specified token. receive the specified token.

Declaration

public async Task<TransactionRecord> RevokeTokenKycWithRecordAsync(Address token, Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to revoke KYC status.
Address	address	Address of the account to suspend.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SignPendingTransactionAsync(Address, Signatory, Action<IContext>)

Adds a signature to a pending transaction record. The Scheduled Transaction executes this signature completes the list of required signatures for execution.

Declaration

public async Task<TransactionReceipt> SignPendingTransactionAsync(Address pending, Signatory signatory = null, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	pending	The identifier (Address/Schedule ID) of the pending transaction to sign.
Signatory	signatory	The signatory containing any additional private keys or callbacks to meet the key signing requirements for participants.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A Receipt indicating success.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SignPendingTransactionWithRecordAsync(Address, Signatory, Action<IContext>)

Adds a signature to a pending transaction record. The Scheduled Transaction executes this signature completes the list of required signatures for execution.

Declaration

public async Task<TransactionRecord> SignPendingTransactionWithRecordAsync(Address pending, Signatory signatory = null, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	pending	The identifier (Address/Schedule ID) of the pending transaction to sign.
Signatory	signatory	The signatory containing any additional private keys or callbacks to meet the key signing requirements for participants.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A Record for the transaction indicating success.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SubmitMessageAsync(Address, ReadOnlyMemory<Byte>, Signatory, Action<IContext>)

Sends a message to the network for a given consensus topic.

Declaration

public async Task<SubmitMessageReceipt> SubmitMessageAsync(Address topic, ReadOnlyMemory<byte> message, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	topic	The address of the topic for the message.
ReadOnlyMemory<Byte>	message	The value of the message, limited to the 4K total Network Transaction Size.
Signatory	signatory	The signatory containing any additional private keys or callbacks to meet the key signing requirements for participants.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<SubmitMessageReceipt>	A Submit Message Receipt indicating success, includes information about the sequence number of the message and its running hash.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SubmitMessageAsync(Address, ReadOnlyMemory<Byte>, Action<IContext>)

Sends a message to the network for a given consensus topic.

Declaration

public async Task<SubmitMessageReceipt> SubmitMessageAsync(Address topic, ReadOnlyMemory<byte> message, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	topic	The address of the topic for the message.
ReadOnlyMemory<Byte>	message	The value of the message, limited to the 4K total Network Transaction Size.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<SubmitMessageReceipt>	A Submit Message Receipt indicating success, includes information about the sequence number of the message and its running hash.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SubmitMessageAsync(SubmitMessageParams, Action<IContext>)

Sends a segment of a message to the network for a given consensus topic. The caller of this method is responsible for managing the segment of the message and associated metadata.

Declaration

public async Task<SubmitMessageReceipt> SubmitMessageAsync(SubmitMessageParams submitParams, Action<IContext> configure = null)

Parameters

Type	Name	Description
SubmitMessageParams	submitParams	Details of the message segment to upload, including the metadata corresponding to this segment.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<SubmitMessageReceipt>	A Submit Message Receipt indicating success, includes information about the sequence number of the message and its running hash.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SubmitMessageWithRecordAsync(Address, ReadOnlyMemory<Byte>, Signatory, Action<IContext>)

Sends a message to the network for a given consensus topic.

Declaration

public async Task<SubmitMessageRecord> SubmitMessageWithRecordAsync(Address topic, ReadOnlyMemory<byte> message, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	topic	The address of the topic for the message.
ReadOnlyMemory<Byte>	message	The value of the message, limited to the 4K total Network Transaction Size.
Signatory	signatory	The signatory containing any additional private keys or callbacks to meet the key signing requirements for participants.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<SubmitMessageRecord>	A Submit Message Record indicating success, includes information about the sequence number of the message and its running hash.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SubmitMessageWithRecordAsync(Address, ReadOnlyMemory<Byte>, Action<IContext>)

Sends a message to the network for a given consensus topic.

Declaration

public async Task<SubmitMessageRecord> SubmitMessageWithRecordAsync(Address topic, ReadOnlyMemory<byte> message, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	topic	The address of the topic for the message.
ReadOnlyMemory<Byte>	message	The value of the message, limited to the 4K total Network Transaction Size.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<SubmitMessageRecord>	A Submit Message Receipt indicating success, includes information about the sequence number of the message and its running hash.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SubmitMessageWithRecordAsync(SubmitMessageParams, Action<IContext>)

Sends a message to the network for a given consensus topic.

Declaration

public async Task<SubmitMessageRecord> SubmitMessageWithRecordAsync(SubmitMessageParams submitParams, Action<IContext> configure = null)

Parameters

Type	Name	Description
SubmitMessageParams	submitParams	Details of the message segment to upload, including the metadata corresponding to this segment.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<SubmitMessageRecord>	A Submit Message Record indicating success, includes information about the sequence number of the message and its running hash.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SubmitUnsafeTransactionAsync(ReadOnlyMemory<Byte>, Action<IContext>)

Submits an arbitrary type-un-checked message to the network. Typically requires a paying account having super-user privilege access to the network. The transaction is still signed via the usual means, but the transaction contents itself must be encoded manually by calling code.

Declaration

public async Task<TransactionReceipt> SubmitUnsafeTransactionAsync(ReadOnlyMemory<byte> transaction, Action<IContext> configure = null)

Parameters

Type	Name	Description
ReadOnlyMemory<Byte>	transaction	The serialized protobuf encoded bytes of a Gossip Network Transaction. These bytes must be manually created from calling code having a knowledge of how to construct the transaction.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A Submit Message Receipt of the encoded transaction indicating success. Depending on the contents of the message, the instance may be a derived class of TransactionReceipt .

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SubmitUnsafeTransactionWithRecordAsync(ReadOnlyMemory<Byte>, Action<IContext>)

Submits an arbitrary type-un-checked message to the network. Typically requires a paying account having super-user privilege access to the network. The transaction is still signed via the usual means, but the transaction contents itself must be encoded manually by calling code.

Declaration

public async Task<TransactionRecord> SubmitUnsafeTransactionWithRecordAsync(ReadOnlyMemory<byte> transaction, Action<IContext> configure = null)

Parameters

Type	Name	Description
ReadOnlyMemory<Byte>	transaction	The serialized protobuf encoded bytes of a Gossip Network Transaction. These bytes must be manually created from calling code having a knowledge of how to construct the transaction.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A Submit Message Record of the encoded transaction indicating success. Depending on the contents of the message, the instance may be a derived class of TransactionReceipt .

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SuspendNetworkAsync(SuspendNetworkParams, Action<IContext>)

Set the period of time where the network will suspend 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.

Declaration

public async Task<TransactionReceipt> SuspendNetworkAsync(SuspendNetworkParams suspendParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
SuspendNetworkParams	suspendParameters	The details of the suspend request, includes the time to wait before suspension, the duration of the suspension and optionally to include an update file.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A Submit Message Receipt indicating success.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SuspendTokenAsync(Address, Address, Signatory, Action<IContext>)

Suspends the associated account's ability to send or receive the specified token.

Declaration

public async Task<TransactionReceipt> SuspendTokenAsync(Address token, Address address, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to suspend/freeze.
Address	address	Address of the account to suspend.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SuspendTokenAsync(Address, Address, Action<IContext>)

Suspends the associated account's ability to send or receive the specified token.

Declaration

public async Task<TransactionReceipt> SuspendTokenAsync(Address token, Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to suspend/freeze.
Address	address	Address of the account to suspend.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SuspendTokenWithRecordAsync(Address, Address, Signatory, Action<IContext>)

Suspends the associated account's ability to send or receive the specified token.

Declaration

public async Task<TransactionRecord> SuspendTokenWithRecordAsync(Address token, Address address, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to suspend/freeze.
Address	address	Address of the account to suspend.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SuspendTokenWithRecordAsync(Address, Address, Action<IContext>)

Suspends the associated account's ability to send or receive the specified token.

Declaration

public async Task<TransactionRecord> SuspendTokenWithRecordAsync(Address token, Address address, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to suspend/freeze.
Address	address	Address of the account to suspend.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemDeleteContractAsync(Address, Action<IContext>)

Removes a contract from the network via Administrative Delete

Declaration

public async Task<TransactionReceipt> SystemDeleteContractAsync(Address contractToDelete, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contractToDelete	The address of the contract to delete.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the contract deletion.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemDeleteContractWithRecordAsync(Address, Signatory, Action<IContext>)

Removes a contract from the network via Administrative Delete

Declaration

public async Task<TransactionRecord> SystemDeleteContractWithRecordAsync(Address contractToDelete, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contractToDelete	The address of the contract to delete.
Signatory	signatory	Typically private key, keys or signing callback method that are needed to delete the contract as per the requirements in the associated Endorsement.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating success of the contract deletion, fees & other transaction details.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemDeleteContractWithRecordAsync(Address, Action<IContext>)

Removes a contract from the network via Administrative Delete

Declaration

public async Task<TransactionRecord> SystemDeleteContractWithRecordAsync(Address contractToDelete, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contractToDelete	The address of the contract to delete.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating success of the contract deletion, fees & other transaction details.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemDeleteFileAsync(Address, Signatory, Action<IContext>)

Removes a file from the network via Administrative Delete

Declaration

public async Task<TransactionReceipt> SystemDeleteFileAsync(Address file, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	file	The address of the file to delete.
Signatory	signatory	Typically private key, keys or signing callback method that are needed to delete the file as per the requirements in the associated Endorsement.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the file deletion.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemDeleteFileAsync(Address, Action<IContext>)

Removes a file from the network via Administrative Delete

Declaration

public async Task<TransactionReceipt> SystemDeleteFileAsync(Address file, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	file	The address of the file to delete.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the file deletion.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemDeleteFileWithRecordAsync(Address, Signatory, Action<IContext>)

Removes a file from the network via Administrative Delete

Declaration

public async Task<TransactionRecord> SystemDeleteFileWithRecordAsync(Address file, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	file	The address of the file to delete.
Signatory	signatory	Typically private key, keys or signing callback method that are needed to delete the file as per the requirements in the associated Endorsement.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating success of the file deletion, fees & other transaction details.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemDeleteFileWithRecordAsync(Address, Action<IContext>)

Removes a file from the network via Administrative Delete

Declaration

public async Task<TransactionRecord> SystemDeleteFileWithRecordAsync(Address file, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	file	The address of the file to delete.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating success of the file deletion, fees & other transaction details.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemRestoreContractAsync(Address, Action<IContext>)

Restores a contract to the network via Administrative Restore

Declaration

public async Task<TransactionReceipt> SystemRestoreContractAsync(Address contractToRestore, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contractToRestore	The address of the contract to restore.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the contract deletion.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemRestoreContractWithRecordAsync(Address, Signatory, Action<IContext>)

Restores a contract to the network via Administrative Restore

Declaration

public async Task<TransactionRecord> SystemRestoreContractWithRecordAsync(Address contractToRestore, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contractToRestore	The address of the contract to restore.
Signatory	signatory	Typically private key, keys or signing callback method that are needed to delete the contract as per the requirements in the associated Endorsement.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating success of the contract deletion, fees & other transaction details.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemRestoreContractWithRecordAsync(Address, Action<IContext>)

Restores a contract to the network via Administrative Restore

Declaration

public async Task<TransactionRecord> SystemRestoreContractWithRecordAsync(Address contractToRestore, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contractToRestore	The address of the contract to restore.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating success of the contract deletion, fees & other transaction details.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemRestoreFileAsync(Address, Signatory, Action<IContext>)

Undeletes a file from the network via Administrative Restore

Declaration

public async Task<TransactionReceipt> SystemRestoreFileAsync(Address file, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	file	The address of the file to restore.
Signatory	signatory	Typically private key, keys or signing callback method that are needed to delete the file as per the requirements in the associated Endorsement.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the file deletion.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemRestoreFileAsync(Address, Action<IContext>)

Undeletes a file from the network via Administrative Restore

Declaration

public async Task<TransactionReceipt> SystemRestoreFileAsync(Address file, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	file	The address of the file to restore.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the file deletion.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemRestoreFileWithRecordAsync(Address, Signatory, Action<IContext>)

Undeletes a file from the network via Administrative Restore

Declaration

public async Task<TransactionRecord> SystemRestoreFileWithRecordAsync(Address file, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	file	The address of the file to restore.
Signatory	signatory	Typically private key, keys or signing callback method that are needed to delete the file as per the requirements in the associated Endorsement.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating success of the file deletion, fees & other transaction details.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SystemRestoreFileWithRecordAsync(Address, Action<IContext>)

Undeletes a file from the network via Administrative Restore

Declaration

public async Task<TransactionRecord> SystemRestoreFileWithRecordAsync(Address file, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	file	The address of the file to restore.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating success of the file deletion, fees & other transaction details.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SytemDeleteContractAsync(Address, Signatory, Action<IContext>)

Removes a contract from the network via Administrative Delete

Declaration

public async Task<TransactionReceipt> SytemDeleteContractAsync(Address contractToDelete, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contractToDelete	The address of the contract to delete.
Signatory	signatory	Typically private key, keys or signing callback method that are needed to delete the contract as per the requirements in the associated Endorsement.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the contract deletion.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

SytemRestoreContractAsync(Address, Signatory, Action<IContext>)

Restores a contract to the network via Administrative Restore

Declaration

public async Task<TransactionReceipt> SytemRestoreContractAsync(Address contractToRestore, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	contractToRestore	The address of the contract to restore.
Signatory	signatory	Typically private key, keys or signing callback method that are needed to delete the contract as per the requirements in the associated Endorsement.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the contract deletion.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferAssetAsync(Asset, Address, Address, Signatory, Action<IContext>)

Transfer assets (NFTs) from one account to another.

Declaration

public async Task<TransactionReceipt> TransferAssetAsync(Asset asset, Address fromAddress, Address toAddress, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier of the asset to transfer (shard, realm, num, serial).
Address	fromAddress	The address to transfer the assets from. Ensure that a signatory either in the context or passed with this call can fulfill the signing requrements to transfer crypto out of the account identified by this address.
Address	toAddress	The address receiving the assets.
Signatory	signatory	The signatory containing any additional private keys or callbacks to meet the requirements for the sending and receiving accounts.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transfer receipt indicating success of the operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferAssetAsync(Asset, Address, Address, Action<IContext>)

Transfer assets (NFTs) from one account to another.

Declaration

public async Task<TransactionReceipt> TransferAssetAsync(Asset asset, Address fromAddress, Address toAddress, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier of the asset to transfer (shard, realm, num, serial).
Address	fromAddress	The address to transfer the assets from. Ensure that a signatory either in the context or passed with this call can fulfill the signing requrements to transfer assets out of the account identified by this address.
Address	toAddress	The address receiving the assets.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transfer receipt indicating success of the operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferAssetWithRecordAsync(Asset, Address, Address, Signatory, Action<IContext>)

Transfer assets (NFTs) from one account to another.

Declaration

public async Task<TransactionRecord> TransferAssetWithRecordAsync(Asset asset, Address fromAddress, Address toAddress, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier of the asset to transfer (shard, realm, num, serial).
Address	fromAddress	The address to transfer the assets from. Ensure that a signatory either in the context or passed with this call can fulfill the signing requrements to transfer crypto out of the account identified by this address.
Address	toAddress	The address receiving the assets.
Signatory	signatory	The signatory containing any additional private keys or callbacks to meet the requirements for the sending and receiving accounts.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transfer record describing the details of the concensus transaction.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferAssetWithRecordAsync(Asset, Address, Address, Action<IContext>)

Transfer assets (NFTs) from one account to another.

Declaration

public async Task<TransactionRecord> TransferAssetWithRecordAsync(Asset asset, Address fromAddress, Address toAddress, Action<IContext> configure = null)

Parameters

Type	Name	Description
Asset	asset	The identifier of the asset to transfer (shard, realm, num, serial).
Address	fromAddress	The address to transfer the assets from. Ensure that a signatory either in the context can fulfill the signing requrements to transfer crypto out of the account identified by this address.
Address	toAddress	The address receiving the assets.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transfer record describing the details of the concensus transaction.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferAsync(Address, Address, Int64, Signatory, Action<IContext>)

Transfer tinybars from one account to another.

Declaration

public async Task<TransactionReceipt> TransferAsync(Address fromAddress, Address toAddress, long amount, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	fromAddress	The address to transfer the tinybars from. Ensure that a signatory either in the context or passed with this call can fulfill the signing requrements to transfer crypto out of the account identified by this address.
Address	toAddress	The address receiving the tinybars.
Int64	amount	The amount of tinybars to transfer.
Signatory	signatory	The signatory containing any additional private keys or callbacks to meet the requirements for the sending and receiving accounts.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transfer receipt indicating success of the operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferAsync(Address, Address, Int64, Action<IContext>)

Transfer tinybars from one account to another.

Declaration

public async Task<TransactionReceipt> TransferAsync(Address fromAddress, Address toAddress, long amount, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	fromAddress	The address to transfer the tinybars from. Ensure that a signatory either in the context or passed with this call can fulfill the signing requrements to transfer crypto out of the account identified by this address.
Address	toAddress	The address receiving the tinybars.
Int64	amount	The amount of tinybars to transfer.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transfer receipt indicating success of the operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferAsync(TransferParams, Action<IContext>)

Transfer cryptocurrency and tokens in the same transaction atomically among multiple hedera accounts and contracts.

Declaration

public async Task<TransactionReceipt> TransferAsync(TransferParams transfers, Action<IContext> configure = null)

Parameters

Type	Name	Description
TransferParams	transfers	A transfers parameter object holding lists of crypto and token transfers to perform.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transfer receipt indicating success of the consensus operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferTokensAsync(Address, Address, Address, Int64, Signatory, Action<IContext>)

Transfer tokens from one account to another.

Declaration

public async Task<TransactionReceipt> TransferTokensAsync(Address token, Address fromAddress, Address toAddress, long amount, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to transfer.
Address	fromAddress	The address to transfer the tokens from. Ensure that a signatory either in the context or passed with this call can fulfill the signing requrements to transfer crypto out of the account identified by this address.
Address	toAddress	The address receiving the tokens.
Int64	amount	The amount of tokens to transfer.
Signatory	signatory	The signatory containing any additional private keys or callbacks to meet the requirements for the sending and receiving accounts.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transfer receipt indicating success of the operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferTokensAsync(Address, Address, Address, Int64, Action<IContext>)

Transfer tokens from one account to another.

Declaration

public async Task<TransactionReceipt> TransferTokensAsync(Address token, Address fromAddress, Address toAddress, long amount, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to transfer.
Address	fromAddress	The address to transfer the tokens from. Ensure that a signatory either in the context or passed with this call can fulfill the signing requrements to transfer tokens out of the account identified by this address.
Address	toAddress	The address receiving the tokens.
Int64	amount	The amount of tokens to transfer.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transfer receipt indicating success of the operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferTokensWithRecordAsync(Address, Address, Address, Int64, Signatory, Action<IContext>)

Transfer tokens from one account to another.

Declaration

public async Task<TransactionRecord> TransferTokensWithRecordAsync(Address token, Address fromAddress, Address toAddress, long amount, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to transfer.
Address	fromAddress	The address to transfer the tokens from. Ensure that a signatory either in the context or passed with this call can fulfill the signing requrements to transfer crypto out of the account identified by this address.
Address	toAddress	The address receiving the tokens.
Int64	amount	The amount of tokens to transfer.
Signatory	signatory	The signatory containing any additional private keys or callbacks to meet the requirements for the sending and receiving accounts.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transfer record describing the details of the concensus transaction.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferTokensWithRecordAsync(Address, Address, Address, Int64, Action<IContext>)

Transfer tokens from one account to another.

Declaration

public async Task<TransactionRecord> TransferTokensWithRecordAsync(Address token, Address fromAddress, Address toAddress, long amount, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The identifier (Address/Symbol) of the token to transfer.
Address	fromAddress	The address to transfer the tokens from. Ensure that a signatory either in the context can fulfill the signing requrements to transfer crypto out of the account identified by this address.
Address	toAddress	The address receiving the tokens.
Int64	amount	The amount of tokens to transfer.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transfer record describing the details of the concensus transaction.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferWithRecordAsync(Address, Address, Int64, Signatory, Action<IContext>)

Transfer tinybars from one account to another.

Declaration

public async Task<TransactionRecord> TransferWithRecordAsync(Address fromAddress, Address toAddress, long amount, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	fromAddress	The address to transfer the tinybars from. Ensure that a signatory either in the context or passed with this call can fulfill the signing requrements to transfer crypto out of the account identified by this address.
Address	toAddress	The address receiving the tinybars.
Int64	amount	The amount of tinybars to transfer.
Signatory	signatory	The signatory containing any additional private keys or callbacks to meet the requirements for the sending and receiving accounts.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transfer record describing the details of the concensus transaction.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferWithRecordAsync(Address, Address, Int64, Action<IContext>)

Transfer tinybars from one account to another.

Declaration

public async Task<TransactionRecord> TransferWithRecordAsync(Address fromAddress, Address toAddress, long amount, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	fromAddress	The address to transfer the tinybars from. Ensure that a signatory either in the context can fulfill the signing requrements to transfer crypto out of the account identified by this address.
Address	toAddress	The address receiving the tinybars.
Int64	amount	The amount of tinybars to transfer.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transfer record describing the details of the concensus transaction.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

TransferWithRecordAsync(TransferParams, Action<IContext>)

Transfer cryptocurrency and tokens in the same transaction atomically among multiple hedera accounts and contracts.

Declaration

public async Task<TransactionRecord> TransferWithRecordAsync(TransferParams transfers, Action<IContext> configure = null)

Parameters

Type	Name	Description
TransferParams	transfers	A transfers parameter object holding lists of crypto and token transfers to perform.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transfer receipt indicating success of the consensus operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateAccountAsync(UpdateAccountParams, Action<IContext>)

Updates the changeable properties of a hedera network account.

Declaration

public async Task<TransactionReceipt> UpdateAccountAsync(UpdateAccountParams updateParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
UpdateAccountParams	updateParameters	The account update parameters, includes a required Address reference to the account to update plus a number of changeable properties of the account.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the operation. of the request.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateAccountWithRecordAsync(UpdateAccountParams, Action<IContext>)

Updates the changeable properties of a hedera network account.

Declaration

public async Task<TransactionRecord> UpdateAccountWithRecordAsync(UpdateAccountParams updateParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
UpdateAccountParams	updateParameters	The account update parameters, includes a required Address reference to the account to update plus a number of changeable properties of the account.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record containing the details of the results. of the request.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateContractAsync(UpdateContractParams, Action<IContext>)

Updates the changeable properties of a hedera network contract.

Declaration

public async Task<TransactionReceipt> UpdateContractAsync(UpdateContractParams updateParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
UpdateContractParams	updateParameters	The contract update parameters, includes a required Address reference to the Contract to update plus a number of changeable properties of the Contract.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the operation. of the request.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateContractWithRecordAsync(UpdateContractParams, Action<IContext>)

Updates the changeable properties of a hedera network Contract.

Declaration

public async Task<TransactionRecord> UpdateContractWithRecordAsync(UpdateContractParams updateParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
UpdateContractParams	updateParameters	The Contract update parameters, includes a required Address reference to the Contract to update plus a number of changeable properties of the Contract.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record containing the details of the results. of the request.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateFileAsync(UpdateFileParams, Action<IContext>)

Updates the properties or contents of an existing file stored in the network.

Declaration

public async Task<TransactionReceipt> UpdateFileAsync(UpdateFileParams updateParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
UpdateFileParams	updateParameters	Update parameters indicating the file to update and what properties such as the access key or content that should be updated.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating the operation was successful.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateFileWithRecordAsync(UpdateFileParams, Action<IContext>)

Updates the properties or contents of an existing file stored in the network.

Declaration

public async Task<TransactionRecord> UpdateFileWithRecordAsync(UpdateFileParams updateParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
UpdateFileParams	updateParameters	Update parameters indicating the file to update and what properties such as the access key or content that should be updated.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record describing the details of the operation including fees and transaction hash.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateRoyaltiesAsync(Address, IEnumerable<IRoyalty>, Signatory, Action<IContext>)

Updates (replaces) the royalties (custom fees) associated with a token, must be signed by the RoyaltiesEndorsment private key(s).

Declaration

public async Task<TransactionReceipt> UpdateRoyaltiesAsync(Address token, IEnumerable<IRoyalty> royalties, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The address of the token definition to update.
IEnumerable<IRoyalty>	royalties	The list of royalties to apply to token transactions, may be a blank list or null, this list replaces the previous list of royalties in full.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateRoyaltiesAsync(Address, IEnumerable<IRoyalty>, Action<IContext>)

Updates (replaces) the royalties (custom fees) associated with a token, must be signed by the RoyaltiesEndorsment private key(s).

Declaration

public async Task<TransactionReceipt> UpdateRoyaltiesAsync(Address token, IEnumerable<IRoyalty> royalties, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The address of the token definition to update.
IEnumerable<IRoyalty>	royalties	The list of royalties to apply to token transactions, may be a blank list or null, this list replaces the previous list of royalties in full.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateRoyaltiesWithRecordAsync(Address, IEnumerable<IRoyalty>, Signatory, Action<IContext>)

Updates (replaces) the royalties (custom fees) associated with a token, must be signed by the RoyaltiesEndorsment private key(s).

Declaration

public async Task<TransactionRecord> UpdateRoyaltiesWithRecordAsync(Address token, IEnumerable<IRoyalty> royalties, Signatory signatory, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The address of the token definition to update.
IEnumerable<IRoyalty>	royalties	The list of royalties to apply to token transactions, may be a blank list or null, this list replaces the previous list of royalties in full.
Signatory	signatory	Additional signing key matching the administrative endorsements associated with this token (if not already added in the context).
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateRoyaltiesWithRecordAsync(Address, IEnumerable<IRoyalty>, Action<IContext>)

Updates (replaces) the royalties (custom fees) associated with a token, must be signed by the RoyaltiesEndorsment private key(s).

Declaration

public async Task<TransactionRecord> UpdateRoyaltiesWithRecordAsync(Address token, IEnumerable<IRoyalty> royalties, Action<IContext> configure = null)

Parameters

Type	Name	Description
Address	token	The address of the token definition to update.
IEnumerable<IRoyalty>	royalties	The list of royalties to apply to token transactions, may be a blank list or null, this list replaces the previous list of royalties in full.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record indicating a successful operation.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission, for example of the token is already deleted.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateTokenAsync(UpdateTokenParams, Action<IContext>)

Updates the changeable properties of a Hedera Fungable Token.

Declaration

public async Task<TransactionReceipt> UpdateTokenAsync(UpdateTokenParams updateParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
UpdateTokenParams	updateParameters	The Token update parameters, includes a required Address or Symbol reference to the Token to update plus a number of changeable properties of the Token.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the operation. of the request.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateTokenWithRecordAsync(UpdateTokenParams, Action<IContext>)

Updates the changeable properties of a hedera network Token.

Declaration

public async Task<TransactionRecord> UpdateTokenWithRecordAsync(UpdateTokenParams updateParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
UpdateTokenParams	updateParameters	The Token update parameters, includes a required Address or Symbol reference to the Token to update plus a number of changeable properties of the Token.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record containing the details of the results. of the request.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateTopicAsync(UpdateTopicParams, Action<IContext>)

Updates the changeable properties of a Hedera Network Topic.

Declaration

public async Task<TransactionReceipt> UpdateTopicAsync(UpdateTopicParams updateParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
UpdateTopicParams	updateParameters	The Topic update parameters, includes a required Address reference to the Topic to update plus a number of changeable properties of the Topic.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionReceipt>	A transaction receipt indicating success of the operation. of the request.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

UpdateTopicWithRecordAsync(UpdateTopicParams, Action<IContext>)

Updates the changeable properties of a hedera network Topic.

Declaration

public async Task<TransactionRecord> UpdateTopicWithRecordAsync(UpdateTopicParams updateParameters, Action<IContext> configure = null)

Parameters

Type	Name	Description
UpdateTopicParams	updateParameters	The Topic update parameters, includes a required Address reference to the Topic to update plus a number of changeable properties of the Topic.
Action<IContext>	configure	Optional callback method providing an opportunity to modify the execution configuration for just this method call. It is executed prior to submitting the request to the network.

Returns

Type	Description
Task<TransactionRecord>	A transaction record containing the details of the results. of the request.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node create rejected the request upon submission.
ConsensusException	If the network was unable to come to consensus before the duration of the transaction expired.
TransactionException	If the network rejected the create request as invalid or had missing data.

Implements

System.IAsyncDisposable

Extension Methods

AddressBookExtension.GetAddressBookAsync(Client, Action<IContext>)

ExchangeRateExtension.GetExchangeRatesAsync(Client, Action<IContext>)

FeeScheduleExtension.GetFeeScheduleAsync(Client, Action<IContext>)

GetTokenBalanceExtension.GetAccountTokenBalanceAsync(Client, Address, Address, Action<IContext>)

GetTokenBalanceExtension.GetContractTokenBalanceAsync(Client, Address, Address, Action<IContext>)

SubmitLargeMessageExtension.SubmitLargeMessageAsync(Client, Address, ReadOnlyMemory<Byte>, Int32, Signatory, Action<IContext>)