Class Account

Account information at a given round.

Definition:
data/basics/userBalance.go : AccountData

Inheritance

object

Account

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Algorand.Algod.Model

Assembly: Algorand.dll

Syntax

[MessagePackObject(false)]
public class Account : IDisposable

Constructors

| Edit this page View Source

Account()

Generate a new, random account.

Declaration

public Account()

| Edit this page View Source

Account(KeyPair)

Create an account from a private key

Declaration

public Account(KeyPair keyPair)

Parameters

Type	Name	Description
KeyPair	keyPair

| Edit this page View Source

Account(byte[])

Generate a newc account with seed(master derivation key)

Declaration

public Account(byte[] seed)

Parameters

Type	Name	Description
byte[]	seed	seed(master derivation key)

| Edit this page View Source

Account(string)

Create a new account with mnemonic

Declaration

public Account(string mnemonic)

Parameters

Type	Name	Description
string	mnemonic	the mnemonic

Fields

| Edit this page View Source

_address

The account public address. When rekeyed, this is the original account address, and signing is done using the private key in the address.

Declaration

protected Address _address

Field Value

Type	Description
Address

| Edit this page View Source

_rekeyedTo

The account public address. When rekeyed, this is the original account address, and signing is done using the private key in the address.

Declaration

protected Address? _rekeyedTo

Field Value

Type	Description
Address

Properties

| Edit this page View Source

Address

Declaration

[JsonProperty("address", Required = Required.Always)]
[Key("address")]
[Required]
public Address Address { get; set; }

Property Value

Type	Description
Address

| Edit this page View Source

Amount

Declaration

[JsonProperty("amount", Required = Required.Always)]
[Key("amount")]
[Required]
public ulong Amount { get; set; }

Property Value

Type	Description
ulong

| Edit this page View Source

AmountWithoutPendingRewards

Declaration

[JsonProperty("amount-without-pending-rewards", Required = Required.Always)]
[Key("amount-without-pending-rewards")]
[Required]
public ulong AmountWithoutPendingRewards { get; set; }

Property Value

Type	Description
ulong

| Edit this page View Source

AppsLocalState

Declaration

[JsonProperty("apps-local-state", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("apps-local-state")]
public ICollection<ApplicationLocalState> AppsLocalState { get; set; }

Property Value

Type	Description
ICollection<ApplicationLocalState>

| Edit this page View Source

AppsTotalExtraPages

Declaration

[JsonProperty("apps-total-extra-pages", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("apps-total-extra-pages")]
public ulong? AppsTotalExtraPages { get; set; }

Property Value

Type	Description
ulong?

| Edit this page View Source

AppsTotalSchema

Declaration

[JsonProperty("apps-total-schema", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("apps-total-schema")]
public ApplicationStateSchema AppsTotalSchema { get; set; }

Property Value

Type	Description
ApplicationStateSchema

| Edit this page View Source

Assets

Declaration

[JsonProperty("assets", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("assets")]
public ICollection<AssetHolding> Assets { get; set; }

Property Value

Type	Description
ICollection<AssetHolding>

| Edit this page View Source

AuthAddr

Declaration

[JsonProperty("auth-addr", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("auth-addr")]
public Address AuthAddr { get; set; }

Property Value

Type	Description
Address

| Edit this page View Source

CreatedApps

Declaration

[JsonProperty("created-apps", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("created-apps")]
public ICollection<Application> CreatedApps { get; set; }

Property Value

Type	Description
ICollection<Application>

| Edit this page View Source

CreatedAssets

Declaration

[JsonProperty("created-assets", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("created-assets")]
public ICollection<Asset> CreatedAssets { get; set; }

Property Value

Type	Description
ICollection<Asset>

| Edit this page View Source

IncentiveEligible

Declaration

[JsonProperty("incentive-eligible", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("incentive-eligible")]
public bool? IncentiveEligible { get; set; }

Property Value

Type	Description
bool?

| Edit this page View Source

KeyPair

Declaration

[JsonIgnore]
[IgnoreMember]
public KeyPair KeyPair { get; }

Property Value

Type	Description
KeyPair

| Edit this page View Source

LastHeartbeat

Declaration

[JsonProperty("last-heartbeat", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("last-heartbeat")]
public ulong? LastHeartbeat { get; set; }

Property Value

Type	Description
ulong?

| Edit this page View Source

LastProposed

Declaration

[JsonProperty("last-proposed", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("last-proposed")]
public ulong? LastProposed { get; set; }

Property Value

Type	Description
ulong?

| Edit this page View Source

MinBalance

Declaration

[JsonProperty("min-balance", Required = Required.Always)]
[Key("min-balance")]
[Required]
public ulong MinBalance { get; set; }

Property Value

Type	Description
ulong

| Edit this page View Source

OriginalAddress

Declaration

[JsonIgnore]
[IgnoreMember]
public Address? OriginalAddress { get; }

Property Value

Type	Description
Address

| Edit this page View Source

Participation

Declaration

[JsonProperty("participation", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("participation")]
public AccountParticipation Participation { get; set; }

Property Value

Type	Description
AccountParticipation

| Edit this page View Source

PendingRewards

Declaration

[JsonProperty("pending-rewards", Required = Required.Always)]
[Key("pending-rewards")]
[Required]
public ulong PendingRewards { get; set; }

Property Value

Type	Description
ulong

| Edit this page View Source

RekeyedTo

Declaration

[JsonIgnore]
[IgnoreMember]
public Address? RekeyedTo { get; set; }

Property Value

Type	Description
Address

| Edit this page View Source

RewardBase

Declaration

[JsonProperty("reward-base", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("reward-base")]
public ulong? RewardBase { get; set; }

Property Value

Type	Description
ulong?

| Edit this page View Source

Rewards

Declaration

[JsonProperty("rewards", Required = Required.Always)]
[Key("rewards")]
[Required]
public ulong Rewards { get; set; }

Property Value

Type	Description
ulong

| Edit this page View Source

Round

Declaration

[JsonProperty("round", Required = Required.Always)]
[Key("round")]
[Required]
public ulong Round { get; set; }

Property Value

Type	Description
ulong

| Edit this page View Source

SigType

Indicates what type of signature is used by this account, must be one of:
* sig
* msig
* lsig

Declaration

[JsonProperty("sig-type", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("sig-type")]
[JsonConverter(typeof(StringEnumConverter))]
public AccountSigType? SigType { get; set; }

Property Value

Type	Description
AccountSigType?

| Edit this page View Source

Status

Declaration

[JsonProperty("status", Required = Required.Always)]
[Key("status")]
[Required]
public string Status { get; set; }

Property Value

Type	Description
string

| Edit this page View Source

TotalAppsOptedIn

Declaration

[JsonProperty("total-apps-opted-in", Required = Required.Always)]
[Key("total-apps-opted-in")]
[Required]
public ulong TotalAppsOptedIn { get; set; }

Property Value

Type	Description
ulong

| Edit this page View Source

TotalAssetsOptedIn

Declaration

[JsonProperty("total-assets-opted-in", Required = Required.Always)]
[Key("total-assets-opted-in")]
[Required]
public ulong TotalAssetsOptedIn { get; set; }

Property Value

Type	Description
ulong

| Edit this page View Source

TotalBoxBytes

Declaration

[JsonProperty("total-box-bytes", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("total-box-bytes")]
public ulong? TotalBoxBytes { get; set; }

Property Value

Type	Description
ulong?

| Edit this page View Source

TotalBoxes

Declaration

[JsonProperty("total-boxes", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
[Key("total-boxes")]
public ulong? TotalBoxes { get; set; }

Property Value

Type	Description
ulong?

| Edit this page View Source

TotalCreatedApps

Declaration

[JsonProperty("total-created-apps", Required = Required.Always)]
[Key("total-created-apps")]
[Required]
public ulong TotalCreatedApps { get; set; }

Property Value

Type	Description
ulong

| Edit this page View Source

TotalCreatedAssets

Declaration

[JsonProperty("total-created-assets", Required = Required.Always)]
[Key("total-created-assets")]
[Required]
public ulong TotalCreatedAssets { get; set; }

Property Value

Type	Description
ulong

Methods

| Edit this page View Source

Dispose()

Best-effort wipe of this account's private key material. See Dispose() for what this can and cannot guarantee.

Declaration

public void Dispose()

| Edit this page View Source

MakeAssetTransferTo(Address, ulong, ulong, string, DefaultApi)

Declaration

public Task<PostTransactionsResponse> MakeAssetTransferTo(Address address, ulong amount, ulong assetId, string note, DefaultApi algodApi)

Parameters

Type	Name	Description
Address	address
ulong	amount
ulong	assetId
string	note
DefaultApi	algodApi

Returns

Type	Description
Task<PostTransactionsResponse>

| Edit this page View Source

MakePaymentTo(Address, ulong, string, DefaultApi)

Declaration

public Task<PostTransactionsResponse> MakePaymentTo(Address address, ulong amount, string note, DefaultApi algodApi)

Parameters

Type	Name	Description
Address	address
ulong	amount
string	note
DefaultApi	algodApi

Returns

Type	Description
Task<PostTransactionsResponse>

| Edit this page View Source

SignBytes(byte[])

Declaration

public Signature SignBytes(byte[] bytes)

Parameters

Type	Name	Description
byte[]	bytes

Returns

Type	Description
Signature

| Edit this page View Source

SignRawBytes(byte[])

Declaration

public Signature SignRawBytes(byte[] bytes)

Parameters

Type	Name	Description
byte[]	bytes

Returns

Type	Description
Signature

| Edit this page View Source

TealSign(byte[], Address)

Creates Signature compatible with ed25519verify TEAL opcode from data and contract address(program hash).

Declaration

public Signature TealSign(byte[] data, Address contractAddress)

Parameters

Type	Name	Description
byte[]	data	data byte[]
Address	contractAddress

Returns

Type	Description
Signature	Signature

| Edit this page View Source

ToMnemonic()

Declaration

public string ToMnemonic()

Returns

Type	Description
string

| Edit this page View Source

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.