Class GrantTokenKycExtensions

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

Inheritance

object

GrantTokenKycExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero

Assembly: Hiero.dll

Syntax

public static class GrantTokenKycExtensions

Methods

| Edit this page View Source

GrantTokenKycAsync(ConsensusClient, EntityId, EntityId, Action<IConsensusContext>?)

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

Declaration

public static Task<TransactionReceipt> GrantTokenKycAsync(this ConsensusClient client, EntityId token, EntityId holder, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the kyc grant.
EntityId	token	The identifier of the token to grant KYC.
EntityId	holder	Holder to grant KYC status to.
Action<IConsensusContext>	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.

Examples

// Mark a holder as KYC-approved for this token. Only tokens created
// with a GrantKycEndorsement support KYC gating; on those tokens,
// transfers are rejected until the holder's KYC flag is granted.
var receipt = await client.GrantTokenKycAsync(token, holder);
Console.WriteLine($"KYC grant status: {receipt.Status}");

Exceptions

Type	Condition
ArgumentException	If required arguments are missing or invalid.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node refused the transaction. Only a code about the transaction itself proves it did not execute; any other code leaves the outcome unknown, so settle it by its transaction id on a mirror node rather than resubmitting it (see PrecheckException).
ConsensusException	If the outcome could not be confirmed: the transaction may have executed, so settle it by its transaction id on a mirror node rather than resubmitting it.
TransactionException	If the network rejected the request as invalid or had missing data.

| Edit this page View Source

GrantTokenKycAsync(ConsensusClient, GrantTokenKycParams, Action<IConsensusContext>?)

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

Declaration

public static Task<TransactionReceipt> GrantTokenKycAsync(this ConsensusClient client, GrantTokenKycParams grantTokenKycParams, Action<IConsensusContext>? configure = null)

Parameters

Type	Name	Description
ConsensusClient	client	The Consensus Node Client orchestrating the kyc grant.
GrantTokenKycParams	grantTokenKycParams	The parameters containing the token and account to grant KYC.
Action<IConsensusContext>	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.

Examples

// Mark a holder as KYC-approved for this token. Only tokens created
// with a GrantKycEndorsement support KYC gating; on those tokens,
// transfers are rejected until the holder's KYC flag is granted.
var receipt = await client.GrantTokenKycAsync(token, holder);
Console.WriteLine($"KYC grant status: {receipt.Status}");

Exceptions

Type	Condition
ArgumentException	If required arguments are missing or invalid.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node refused the transaction. Only a code about the transaction itself proves it did not execute; any other code leaves the outcome unknown, so settle it by its transaction id on a mirror node rather than resubmitting it (see PrecheckException).
ConsensusException	If the outcome could not be confirmed: the transaction may have executed, so settle it by its transaction id on a mirror node rather than resubmitting it.
TransactionException	If the network rejected the request as invalid or had missing data.