Class UpdateTokenParams

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

null

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

Inheritance

Object

UpdateTokenParams

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 UpdateTokenParams

Properties

Administrator

Replace this Tokens's current administrative key signing rquirements with new signing requirements.

Declaration

public Endorsement Administrator { get; set; }

Property Value

Type	Description
Endorsement

Remarks

For this request to be accepted by the network, both the current private key(s) for this account and the new private key(s) must sign the transaction.
The existing key must sign for security and the new key must sign as a safeguard to avoid accidentally changing the key to an invalid value.

ConfiscateEndorsement

Changes the administrator key for signing transaction that completely remove tokens from an crypto address.

Declaration

public Endorsement ConfiscateEndorsement { get; set; }

Property Value

Type	Description
Endorsement

Expiration

If specified, changes to expiration new date, fees will be charged as appropriate.

Declaration

public DateTime? Expiration { get; set; }

Property Value

Type	Description
Nullable<DateTime>

GrantKycEndorsement

Changes the administrator key for signing transactions updating the grant or revoke KYC status of an account.

Declaration

public Endorsement GrantKycEndorsement { get; set; }

Property Value

Type	Description
Endorsement

Memo

If specified, updates the publicly visible memo to be associated with the token.

Declaration

public string Memo { get; set; }

Property Value

Type	Description
String

Name

If specified, replaces the current name of this token with the new name.

Declaration

public string Name { get; set; }

Property Value

Type	Description
String

RenewAccount

If specified updates the address of the account supporting the auto renewal of the token at expiration time. The topic lifetime will be extended by the RenewPeriod at expiration time if this account contains sufficient funds. The private key associated with this account must sign the transaction if RenewAccount is specified. Setting the value to

Address.None

clears the renewal account.

Declaration

public Address RenewAccount { get; set; }

Property Value

Type	Description
Address

RenewPeriod

If specified, update the interval of the topic and auto-renewal period. If the associated renewal account does not have sufficient funds to renew at the expiration time, it will be renewed for a period of time the remaining funds can support. If no funds remain, the topic instance will be deleted.

Declaration

public TimeSpan? RenewPeriod { get; set; }

Property Value

Type	Description
Nullable<TimeSpan>

RoyaltiesEndorsement

Changes the administrator key for signing transactions updating the royalties (custom transfer fees) associated with this token.

Declaration

public Endorsement RoyaltiesEndorsement { get; set; }

Property Value

Type	Description
Endorsement

Signatory

Additional private key, keys or signing callback method required to update this token. Typically matches the Administrator endorsement associated with this token.

Declaration

public Signatory Signatory { get; set; }

Property Value

Type	Description
Signatory

Remarks

Keys/callbacks added here will be combined with those already identified in the client object's context when signing this transaction to change the state of this account. They will not be asked to sign transactions to retrieve the record if the "WithRecord" form of the method call is made. The client will rely on the Signatory from the context to sign the transaction requesting the record.

SupplyEndorsement

Changes the administrator key for signing transactions for minting or unminting tokens in the treasury account.

Declaration

public Endorsement SupplyEndorsement { get; set; }

Property Value

Type	Description
Endorsement

SuspendEndorsement

Changes the administrator key for signing transactions for freezing or unfreezing an account's ability to transfer tokens.

Declaration

public Endorsement SuspendEndorsement { get; set; }

Property Value

Type	Description
Endorsement

Symbol

If specified, replaces the current symbol for this token with the new Symbol.

Declaration

public string Symbol { get; set; }

Property Value

Type	Description
String

Token

The identifier (Address/Symbol) of the token to update.

Declaration

public Address Token { get; set; }

Property Value

Type	Description
Address

Treasury

If specified, changes the treasury account holding the reserve balance of tokens.

Declaration

public Address Treasury { get; set; }

Property Value

Type	Description
Address