• Api Documentation
Show / Hide Table of Contents
  • Algorand
    • Address
    • ApiException
    • ApiException<TResult>
    • Digest
    • HttpClientConfigurator
    • LogicsigSignature
    • MultisigAddress
    • MultisigSignature
    • MultisigSubsig
    • ParticipationPublicKey
    • Signature
    • TEALProgram
    • TxGroup
    • VRFPublicKey
  • Algorand.Algod
    • DefaultApi
    • DefaultApi.ObjectResponseResult<T>
    • IDefaultApi
  • Algorand.Algod.Model
    • Account
    • AccountApplicationResponse
    • AccountAssetResponse
    • AccountBalanceRecord
    • AccountDeltas
    • AccountParticipation
    • AccountSigType
    • AccountStateDelta
    • AccountTotals
    • Application
    • ApplicationLocalState
    • ApplicationParams
    • ApplicationStateSchema
    • AppResourceRecord
    • Asset
    • AssetHolding
    • AssetParams
    • AssetResourceRecord
    • Block
    • BlockHashResponse
    • Box
    • BoxDescriptor
    • BoxesResponse
    • BuildVersion
    • CertifiedBlock
    • CompileResponse
    • DisassembleResponse
    • DryrunRequest
    • DryrunResponse
    • DryrunSource
    • DryrunState
    • DryrunTxnResult
    • ErrorResponse
    • EvalDelta
    • EvalDeltaKeyValue
    • FileParameter
    • Format
    • GetSyncRoundResponse
    • KvDelta
    • LedgerStateDelta
    • LightBlockHeaderProof
    • ModifiedApp
    • ModifiedAsset
    • NodeStatusResponse
    • ParticipationKey
    • PendingTransactions
    • PostTransactionsResponse
    • ProofResponse
    • SimulateResponse
    • SimulateTransactionGroupResult
    • SimulateTransactionResult
    • StateDelta
    • StateProof
    • StateProofMessage
    • SupplyResponse
    • TealKeyValue
    • TealValue
    • TransactionParametersResponse
    • TransactionProofResponse
    • TxLease
    • Version
  • Algorand.Algod.Model.Transactions
    • ApplicationCallTransaction
    • ApplicationClearStateTransaction
    • ApplicationCloseOutTransaction
    • ApplicationCreateTransaction
    • ApplicationDeleteTransaction
    • ApplicationNoopTransaction
    • ApplicationOptInTransaction
    • ApplicationUpdateTransaction
    • AssetAcceptTransaction
    • AssetChangeTransaction
    • AssetClawbackTransaction
    • AssetConfigurationTransaction
    • AssetCreateTransaction
    • AssetDestroyTransaction
    • AssetFreezeTransaction
    • AssetMovementsTransaction
    • AssetTransferTransaction
    • AssetUpdateTransaction
    • IReturnableTransaction
    • KeyRegisterOfflineTransaction
    • KeyRegisterOnlineTransaction
    • KeyRegistrationTransaction
    • OnCompletion
    • PaymentTransaction
    • SignedTransaction
    • StateSchema
    • Transaction
  • Algorand.Algod.Test
    • TestHttpMessageHandler
  • Algorand.Crypto
    • KeyPair
  • Algorand.Indexer
    • CommonApi
    • CommonApi.ObjectResponseResult<T>
    • ICommonApi
    • ILookupApi
    • ISearchApi
    • LookupApi
    • LookupApi.ObjectResponseResult<T>
    • SearchApi
    • SearchApi.ObjectResponseResult<T>
  • Algorand.Indexer.Model
    • Account
    • AccountParticipation
    • AccountResponse
    • AccountsResponse
    • AccountStateDelta
    • Application
    • ApplicationLocalState
    • ApplicationLocalStatesResponse
    • ApplicationLogData
    • ApplicationLogsResponse
    • ApplicationParams
    • ApplicationResponse
    • ApplicationsResponse
    • ApplicationStateSchema
    • Asset
    • AssetBalancesResponse
    • AssetHolding
    • AssetHoldingsResponse
    • AssetParams
    • AssetResponse
    • AssetsResponse
    • Block
    • BlockRewards
    • BlockUpgradeState
    • BlockUpgradeVote
    • ErrorResponse
    • EvalDelta
    • EvalDeltaKeyValue
    • HealthCheck
    • MiniAssetHolding
    • StateSchema
    • TealKeyValue
    • TealValue
    • Transaction
    • TransactionApplication
    • TransactionAssetConfig
    • TransactionAssetFreeze
    • TransactionAssetTransfer
    • TransactionKeyreg
    • TransactionPayment
    • TransactionResponse
    • TransactionSignature
    • TransactionSignatureLogicsig
    • TransactionSignatureMultisig
    • TransactionSignatureMultisigSubsignature
    • TransactionsResponse
  • Algorand.KMD
    • Api
    • Api.ObjectResponseResult<T>
    • ApiException
    • ApiException<TResult>
    • APIV1DELETEKeyResponse
    • APIV1DELETEMultisigResponse
    • APIV1GETWalletsResponse
    • APIV1POSTKeyExportResponse
    • APIV1POSTKeyImportResponse
    • APIV1POSTKeyListResponse
    • APIV1POSTKeyResponse
    • APIV1POSTMasterKeyExportResponse
    • APIV1POSTMultisigExportResponse
    • APIV1POSTMultisigImportResponse
    • APIV1POSTMultisigListResponse
    • APIV1POSTMultisigProgramSignResponse
    • APIV1POSTMultisigTransactionSignResponse
    • APIV1POSTProgramSignResponse
    • APIV1POSTTransactionSignResponse
    • APIV1POSTWalletInfoResponse
    • APIV1POSTWalletInitResponse
    • APIV1POSTWalletReleaseResponse
    • APIV1POSTWalletRenameResponse
    • APIV1POSTWalletRenewResponse
    • APIV1POSTWalletResponse
    • APIV1Wallet
    • APIV1WalletHandle
    • CreateWalletRequest
    • DeleteKeyRequest
    • DeleteMultisigRequest
    • ExportKeyRequest
    • ExportMasterKeyRequest
    • ExportMultisigRequest
    • GenerateKeyRequest
    • IApi
    • ImportKeyRequest
    • ImportMultisigRequest
    • InitWalletHandleTokenRequest
    • ListKeysRequest
    • ListMultisigRequest
    • MultisigSig
    • MultisigSubsig
    • ReleaseWalletHandleTokenRequest
    • RenameWalletRequest
    • RenewWalletHandleTokenRequest
    • SignMultisigRequest
    • SignProgramMultisigRequest
    • SignProgramRequest
    • SignTransactionRequest
    • VersionsResponse
    • WalletInfoRequest
  • Algorand.Utils
    • ByteConstBlock
    • BytesConverter
    • Digester
    • Encoder
    • IntConstBlock
    • Logic
    • Logic.Uvarint
    • Mnemonic
    • MultisigAddressConverter
    • OrderedContractResolver
    • ProgramData
    • ReturnedTransactionConverter
    • Utils
    • VarintResult
    • Wordlist
  • Algorand.Utils.Crypto
    • FixedSecureRandom

Class Address

Address represents a serializable 32-byte length Algorand address.

Inheritance
object
Address
Inherited Members
object.Equals(object, object)
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
Namespace: Algorand
Assembly: Algorand.dll
Syntax
[JsonConverter(typeof(BytesConverter))]
public class Address

Constructors

| Improve this Doc View Source

Address()

default values for serializer to ignore

Declaration
public Address()
| Improve this Doc View Source

Address(byte[])

Create a new address from a byte array.

Declaration
[JsonConstructor]
public Address(byte[] bytes)
Parameters
Type Name Description
byte[] bytes

array of 32 bytes

| Improve this Doc View Source

Address(string)

Create a new address from an encoded string(encoded by encodeAsString)

Declaration
public Address(string encodedAddress)
Parameters
Type Name Description
string encodedAddress

Encoded Address

Fields

| Improve this Doc View Source

LEN_BYTES

The length of an address. Equal to the size of a SHA256 checksum.

Declaration
public const int LEN_BYTES = 32
Field Value
Type Description
int

Properties

| Improve this Doc View Source

Bytes

the underlying bytes

Declaration
public byte[] Bytes { get; }
Property Value
Type Description
byte[]

Methods

| Improve this Doc View Source

EncodeAsString()

EncodeAsString converts the address to a human-readable representation, with a 4-byte checksum appended at the end, using SHA256. Note that string representations of addresses generated by different SDKs may not be compatible.

Declaration
public string EncodeAsString()
Returns
Type Description
string

the encoded address string

| Improve this Doc View Source

Equals(object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
object.Equals(object)
| Improve this Doc View Source

ForApplication(ulong)

Get the escrow address of an application.

Declaration
public static Address ForApplication(ulong appID)
Parameters
Type Name Description
ulong appID

appID The ID of the application

Returns
Type Description
Address

The address corresponding to that application's escrow account.

| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()
| Improve this Doc View Source

IsValid(string)

check if the address is valid

Declaration
public static bool IsValid(string encodedAddress)
Parameters
Type Name Description
string encodedAddress

Address

Returns
Type Description
bool

valid or not

| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()
| Improve this Doc View Source

VerifyBytes(byte[], Signature)

verifyBytes verifies that the signature for the message is valid for the public key. The message should have been prepended with "MX" when signing.

Declaration
public bool VerifyBytes(byte[] message, Signature signature)
Parameters
Type Name Description
byte[] message

the message that was signed

Signature signature

signature

Returns
Type Description
bool

true if the signature is valid

  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾