Class Account
Account information at a given round. Definition: data/basics/userBalance.go : AccountData
Inheritance
Inherited Members
Namespace: Algorand.V2.Model
Assembly: Algorand.dll
Syntax
[DataContract]
public class Account : IEquatable<Account>, IValidatableObject
Constructors
| Improve this Doc View SourceAccount()
Initializes a new instance of the Account class.
Declaration
[JsonConstructor]
protected Account()
Account(String, Nullable<Int64>, Nullable<Int64>, List<ApplicationLocalState>, ApplicationStateSchema, List<AssetHolding>, List<Application>, List<Asset>, AccountParticipation, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, String, Nullable<Account.SigTypeEnum>, String)
Initializes a new instance of the Account class.
Declaration
public Account(string address = null, long? amount = default(long? ), long? amountWithoutPendingRewards = default(long? ), List<ApplicationLocalState> appsLocalState = null, ApplicationStateSchema appsTotalSchema = null, List<AssetHolding> assets = null, List<Application> createdApps = null, List<Asset> createdAssets = null, AccountParticipation participation = null, long? pendingRewards = default(long? ), long? rewardBase = default(long? ), long? rewards = default(long? ), long? round = default(long? ), string status = null, Account.SigTypeEnum? sigType = default(Account.SigTypeEnum? ), string authAddr = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | address | the account public key (required). |
| System.Nullable<System.Int64> | amount | \[algo\] total number of MicroAlgos in the account (required). |
| System.Nullable<System.Int64> | amountWithoutPendingRewards | specifies the amount of MicroAlgos in the account, without the pending rewards. (required). |
| System.Collections.Generic.List<ApplicationLocalState> | appsLocalState | \[appl\] applications local data stored in this account. Note the raw object uses |
| ApplicationStateSchema | appsTotalSchema | \[tsch\] stores the sum of all of the local schemas and global schemas in this account. Note: the raw account uses |
| System.Collections.Generic.List<AssetHolding> | assets | \[asset\] assets held by this account. Note the raw object uses |
| System.Collections.Generic.List<Application> | createdApps | \[appp\] parameters of applications created by this account including app global data. Note: the raw account uses |
| System.Collections.Generic.List<Asset> | createdAssets | \[apar\] parameters of assets created by this account. Note: the raw account uses |
| AccountParticipation | participation | participation. |
| System.Nullable<System.Int64> | pendingRewards | amount of MicroAlgos of pending rewards in this account. (required). |
| System.Nullable<System.Int64> | rewardBase | \[ebase\] used as part of the rewards computation. Only applicable to accounts which are participating.. |
| System.Nullable<System.Int64> | rewards | \[ern\] total rewards of MicroAlgos the account has received, including pending rewards. (required). |
| System.Nullable<System.Int64> | round | The round for which this information is relevant. (required). |
| System.String | status | \[onl\] delegation status of the account's MicroAlgos * Offline - indicates that the associated account is delegated. * Online - indicates that the associated account used as part of the delegation pool. * NotParticipating - indicates that the associated account is neither a delegator nor a delegate. (required). |
| System.Nullable<Account.SigTypeEnum> | sigType | Indicates what type of signature is used by this account, must be one of: * sig * msig * lsig. |
| System.String | authAddr | \[spend\] the address against which signing should be checked. If empty, the address of the current account is used. This field can be updated in any transaction by setting the RekeyTo field.. |
Properties
| Improve this Doc View SourceAddress
the account public key
Declaration
[DataMember(Name = "address", EmitDefaultValue = false)]
public string Address { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | the account public key |
Amount
\[algo\] total number of MicroAlgos in the account
Declaration
[DataMember(Name = "amount", EmitDefaultValue = false)]
public long? Amount { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> | \[algo\] total number of MicroAlgos in the account |
AmountWithoutPendingRewards
specifies the amount of MicroAlgos in the account, without the pending rewards.
Declaration
[DataMember(Name = "amount-without-pending-rewards", EmitDefaultValue = false)]
public long? AmountWithoutPendingRewards { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> | specifies the amount of MicroAlgos in the account, without the pending rewards. |
AppsLocalState
\[appl\] applications local data stored in this account. Note the raw object uses map[int] -> AppLocalState for this type.
Declaration
[DataMember(Name = "apps-local-state", EmitDefaultValue = false)]
public List<ApplicationLocalState> AppsLocalState { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<ApplicationLocalState> | \[appl\] applications local data stored in this account. Note the raw object uses |
AppsTotalSchema
\[tsch\] stores the sum of all of the local schemas and global schemas in this account. Note: the raw account uses StateSchema for this type.
Declaration
[DataMember(Name = "apps-total-schema", EmitDefaultValue = false)]
public ApplicationStateSchema AppsTotalSchema { get; set; }
Property Value
| Type | Description |
|---|---|
| ApplicationStateSchema | \[tsch\] stores the sum of all of the local schemas and global schemas in this account. Note: the raw account uses |
Assets
\[asset\] assets held by this account. Note the raw object uses map[int] -> AssetHolding for this type.
Declaration
[DataMember(Name = "assets", EmitDefaultValue = false)]
public List<AssetHolding> Assets { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<AssetHolding> | \[asset\] assets held by this account. Note the raw object uses |
AuthAddr
\[spend\] the address against which signing should be checked. If empty, the address of the current account is used. This field can be updated in any transaction by setting the RekeyTo field.
Declaration
[DataMember(Name = "auth-addr", EmitDefaultValue = false)]
public string AuthAddr { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | \[spend\] the address against which signing should be checked. If empty, the address of the current account is used. This field can be updated in any transaction by setting the RekeyTo field. |
CreatedApps
\[appp\] parameters of applications created by this account including app global data. Note: the raw account uses map[int] -> AppParams for this type.
Declaration
[DataMember(Name = "created-apps", EmitDefaultValue = false)]
public List<Application> CreatedApps { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<Application> | \[appp\] parameters of applications created by this account including app global data. Note: the raw account uses |
CreatedAssets
\[apar\] parameters of assets created by this account. Note: the raw account uses map[int] -> Asset for this type.
Declaration
[DataMember(Name = "created-assets", EmitDefaultValue = false)]
public List<Asset> CreatedAssets { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<Asset> | \[apar\] parameters of assets created by this account. Note: the raw account uses |
Participation
Gets or Sets Participation
Declaration
[DataMember(Name = "participation", EmitDefaultValue = false)]
public AccountParticipation Participation { get; set; }
Property Value
| Type | Description |
|---|---|
| AccountParticipation |
PendingRewards
amount of MicroAlgos of pending rewards in this account.
Declaration
[DataMember(Name = "pending-rewards", EmitDefaultValue = false)]
public long? PendingRewards { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> | amount of MicroAlgos of pending rewards in this account. |
RewardBase
\[ebase\] used as part of the rewards computation. Only applicable to accounts which are participating.
Declaration
[DataMember(Name = "reward-base", EmitDefaultValue = false)]
public long? RewardBase { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> | \[ebase\] used as part of the rewards computation. Only applicable to accounts which are participating. |
Rewards
\[ern\] total rewards of MicroAlgos the account has received, including pending rewards.
Declaration
[DataMember(Name = "rewards", EmitDefaultValue = false)]
public long? Rewards { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> | \[ern\] total rewards of MicroAlgos the account has received, including pending rewards. |
Round
The round for which this information is relevant.
Declaration
[DataMember(Name = "round", EmitDefaultValue = false)]
public long? Round { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> | The round for which this information is relevant. |
SigType
Indicates what type of signature is used by this account, must be one of: * sig * msig * lsig
Declaration
[DataMember(Name = "sig-type", EmitDefaultValue = false)]
public Account.SigTypeEnum? SigType { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<Account.SigTypeEnum> | Indicates what type of signature is used by this account, must be one of: * sig * msig * lsig |
Status
\[onl\] delegation status of the account's MicroAlgos * Offline - indicates that the associated account is delegated. * Online - indicates that the associated account used as part of the delegation pool. * NotParticipating - indicates that the associated account is neither a delegator nor a delegate.
Declaration
[DataMember(Name = "status", EmitDefaultValue = false)]
public string Status { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String | \[onl\] delegation status of the account's MicroAlgos * Offline - indicates that the associated account is delegated. * Online - indicates that the associated account used as part of the delegation pool. * NotParticipating - indicates that the associated account is neither a delegator nor a delegate. |
Methods
| Improve this Doc View SourceEquals(Account)
Returns true if Account instances are equal
Declaration
public bool Equals(Account input)
Parameters
| Type | Name | Description |
|---|---|---|
| Account | input | Instance of Account to be compared |
Returns
| Type | Description |
|---|---|
| System.Boolean | Boolean |
Equals(Object)
Returns true if objects are equal
Declaration
public override bool Equals(object input)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | input | Object to be compared |
Returns
| Type | Description |
|---|---|
| System.Boolean | Boolean |
Overrides
GetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| System.Int32 | Hash code |
Overrides
ToJson()
Returns the JSON string presentation of the object
Declaration
public virtual string ToJson()
Returns
| Type | Description |
|---|---|
| System.String | JSON string presentation of the object |
ToString()
Returns the string presentation of the object
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| System.String | String presentation of the object |
Overrides
Explicit Interface Implementations
| Improve this Doc View SourceIValidatableObject.Validate(ValidationContext)
To validate all properties of the instance
Declaration
IEnumerable<ValidationResult> IValidatableObject.Validate(ValidationContext validationContext)
Parameters
| Type | Name | Description |
|---|---|---|
| System.ComponentModel.DataAnnotations.ValidationContext | validationContext | Validation context |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> | Validation Result |