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

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
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node rejected the request upon submission, for example, if 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 request as invalid or had missing data.

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
ArgumentOutOfRangeException	If required arguments are missing.
InvalidOperationException	If required context configuration is missing.
PrecheckException	If the gateway node rejected the request upon submission, for example, if 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 request as invalid or had missing data.