• Api Documentation
Show / Hide Table of Contents
  • AVM.ClientGenerator
    • ClientGeneratorAnalyzer
    • ProxyBase
    • ProxyException
    • SignatureBase
  • AVM.ClientGenerator.ABI.ARC32
    • AbiMethodDefaultArgument
    • AppDescription
    • AppDescriptionConverter
    • ArgumentDefaultSource
    • CallConfig
    • CallConfigSpec
    • ConstantDefaultArgument
    • DefaultArgumentConverter
    • DefaultArgumentSpec
    • HintSpec
    • StateDefaultArgument
    • StateDescription
    • StorageElement
    • StorageSection
  • AVM.ClientGenerator.ABI.ARC4
    • ArgumentDescription
    • ContractDescription
    • MethodDescription
    • NetworkAppId
    • ReturnTypeDescription
  • AVM.ClientGenerator.ABI.ARC4.Types
    • Address
    • Application
    • Asset
    • Bool
    • Byte
    • FixedArray<T>
    • String
    • StructArray<T>
    • Tuple
    • UFixed
    • UInt
    • UInt128
    • UInt16
    • UInt24
    • UInt256
    • UInt32
    • UInt48
    • UInt512
    • UInt64
    • VariableArray<T>
    • WireType
  • AVM.ClientGenerator.ABI.ARC56
    • AppDescriptionArc56
    • BareActions
    • CompilerInfo
    • CompilerVersion
    • ContractState
    • DefaultValue
    • Event
    • EventArgument
    • Method
    • MethodActions
    • MethodArgument
    • MethodReturn
    • NetworkInfo
    • ProgramSource
    • ProgramSourceInfo
    • RecommendationBox
    • Recommendations
    • Schema
    • SchemaValues
    • ScratchVariable
    • SourceInfo
    • SourceInfoArgument
    • StorageKey
    • StorageMap
    • StructField
    • TemplateVariable
  • AVM.ClientGenerator.Clients
    • ContractUtilities
    • ProxyException
    • ProxyGenerator
    • SmartSignatureUtilities
  • AVM.ClientGenerator.Compiler
    • TealTypeUtils
    • Utilities
  • AVM.ClientGenerator.Core
    • AccountReference
    • AppCall
    • AppCallTransactionReference
    • AssetAccept
    • AssetClawback
    • AssetClawbackTransactionReference
    • AssetConfiguration
    • AssetConfigurationTransactionReference
    • AssetFreeze
    • AssetFreezeTransactionReference
    • AssetReference
    • AssetTransfer
    • AssetTransferTransactionReference
    • BigIntegerExtensions
    • ByteArrayExtensions
    • Constants
    • IAlgorandCommonPredefineds
    • ICompiledContract
    • ICompiledSignature
    • ISmartContractPredefineds
    • ISmartSignaturePredefineds
    • InnerTransaction
    • IntegerExtensions
    • IntentionallyNotImplementedException
    • KeyRegistration
    • KeyRegistrationTransactionReference
    • OnCompleteType
    • Payment
    • PaymentTransactionReference
    • SmartContract
    • SmartContractLibrary
    • SmartContractReference
    • SmartSignature
    • StorageType
    • StringExtensions
    • TransactionReference
    • VariableType
  • AVM.ClientGenerator.Core.Attributes
    • ABIFixedSizeAttribute
    • ABIStructAttribute
    • ABITypeDecoratorAttribute
    • InnerTransactionCallAttribute
    • SmartContractMethodAttribute
    • SmartSignatureMethodAttribute
    • StorageAttribute
  • AVM.ClientGenerator.Optimisers
    • CompiledLine
    • ICompilerMemento
    • IOptimiser
  • Algorand
    • Address
    • ApiException
    • ApiException<TResult>
    • Digest
    • HttpClientConfigurator
    • LogicsigSignature
    • MultisigAddress
    • MultisigSignature
    • MultisigSubsig
    • ParticipationPublicKey
    • Signature
    • TEALProgram
    • TxGroup
    • VRFPublicKey
  • Algorand.AVM.ClientGenerator.ABI.ARC32
    • SourceDescription
  • Algorand.AVM.ClientGenerator.ABI.ARC56
    • AVMObjectType
    • ClientGeneratorARC56
  • Algorand.AVM.ClientGenerator.Extensions
    • StringExtensions
  • Algorand.Algod
    • AlgodClient
    • AlgodConfiguration
    • DefaultApi
    • DefaultApi.ObjectResponseResult<T>
    • FundAccount
    • IAlgodClient
    • IDefaultApi
  • Algorand.Algod.Model
    • Account
    • AccountApplicationResource
    • AccountApplicationResponse
    • AccountApplicationsInformationResponse
    • AccountAssetHolding
    • AccountAssetResponse
    • AccountAssetsInformationResponse
    • AccountBalanceRecord
    • AccountDeltas
    • AccountParticipation
    • AccountSigType
    • AccountStateDelta
    • AccountTotals
    • AppCallLogs
    • AppResourceRecord
    • Application
    • ApplicationInitialStates
    • ApplicationKVStorage
    • ApplicationLocalReference
    • ApplicationLocalState
    • ApplicationParams
    • ApplicationStateOperation
    • ApplicationStateSchema
    • Asset
    • AssetHolding
    • AssetHoldingReference
    • AssetParams
    • AssetResourceRecord
    • AvmKeyValue
    • AvmValue
    • Block
    • BlockCert
    • BlockCertProp
    • BlockCertVote
    • BlockCertVoteCred
    • BlockCertVoteSig
    • BlockHashConverter
    • BlockHashResponse
    • BlockHeaderResponse
    • BlockLogsResponse
    • BlockTxidsResponse
    • Box
    • BoxDescriptor
    • BoxRef
    • BoxReference
    • BoxesResponse
    • BuildVersion
    • CertifiedBlock
    • CompileResponse
    • DisassembleResponse
    • DryrunRequest
    • DryrunResponse
    • DryrunSource
    • DryrunState
    • DryrunTxnResult
    • ErrorResponse
    • EvalDelta
    • EvalDeltaKeyValue
    • FileParameter
    • Format
    • Genesis
    • GenesisAllocation
    • GetBlockTimeStampOffsetResponse
    • GetSyncRoundResponse
    • HeartBeat
    • KvDelta
    • LedgerStateDelta
    • LedgerStateDeltaForTransactionGroup
    • LightBlockHeaderProof
    • ModifiedApp
    • ModifiedAsset
    • NodeStatusResponse
    • ParticipationKey
    • PendingTransactions
    • PostTransactionsResponse
    • ProofResponse
    • ReturnedTransaction
    • ScratchChange
    • SimulateInitialStates
    • SimulateRequest
    • SimulateRequestTransactionGroup
    • SimulateResponse
    • SimulateTraceConfig
    • SimulateTransactionGroupResult
    • SimulateTransactionResult
    • SimulateUnnamedResourcesAccessed
    • SimulationEvalOverrides
    • SimulationOpcodeTraceUnit
    • SimulationTransactionExecTrace
    • StateDelta
    • StateProof
    • StateProofMessage
    • StateProofTrackingData
    • SupplyResponse
    • TealKeyValue
    • TealValue
    • TransactionGroupLedgerStateDeltasForRoundResponse
    • TransactionParametersResponse
    • TransactionProofResponse
    • TxLease
    • Version
  • Algorand.Algod.Model.Agreement
    • ProposalValue
    • RawVote
    • Vote
  • Algorand.Algod.Model.Converters.Json
    • BlockCertVoteSigConverterJson
    • ParticipationPublicKeyConverterJson
    • UlongDictionaryConverterJson<T>
    • VRFPublicKeyConverterJson
    • ValueDeltaBytesConverterJson
  • Algorand.Algod.Model.Converters.MsgPack
    • AddressFormatterMsgPack
    • Deserializer
    • DigestFormatterMsgPack
    • NoDefaultsFormatter<T>
    • NullableStringFormatterMsgPack
    • ParticipationPublicKeyFormatterMsgPack
    • TEALProgramFormatterMsgPack
    • VRFPublicKeyFormatterMsgPack
    • ValueDeltaFormatterMsgPack
  • Algorand.Algod.Model.Exceptions
    • UnnamedResourceException
  • Algorand.Algod.Model.Transactions
    • ApplicationCallTransaction
    • ApplicationClearStateTransaction
    • ApplicationCloseOutTransaction
    • ApplicationCreateTransaction
    • ApplicationDeleteTransaction
    • ApplicationNoopTransaction
    • ApplicationOptInTransaction
    • ApplicationUpdateTransaction
    • AssetAcceptTransaction
    • AssetChangeTransaction
    • AssetClawbackTransaction
    • AssetCloseTransaction
    • AssetConfigurationTransaction
    • AssetCreateTransaction
    • AssetDestroyTransaction
    • AssetFreezeTransaction
    • AssetMovementsTransaction
    • AssetTransferTransaction
    • AssetUpdateTransaction
    • HeartBeatTransaction
    • IReturnableTransaction
    • KeyRegisterOfflineTransaction
    • KeyRegisterOnlineTransaction
    • KeyRegistrationTransaction
    • OnCompletion
    • PaymentTransaction
    • SignedTransaction
    • SignedTransactionDetail
    • StateProofTransaction
    • StateSchema
    • Transaction
    • TransactionsExtensions
    • ValueDelta
  • Algorand.Algod.Test
    • TestHttpMessageHandler
  • Algorand.Crypto
    • KeyPair
  • Algorand.Gossip
    • DnsSrvRecord
    • DnsSrvResolver
    • GossipHttpClient
    • GossipHttpConfiguration
    • GossipNetwork
    • GossipNodePurpose
    • GossipWebsocketClient
    • GossipWebsocketClient.AgreementVoteReceivedEventHandler
    • GossipWebsocketClient.MsgDigestSkipReceivedEventHandler
    • GossipWebsocketClient.MsgOfInterestReceivedEventHandler
    • GossipWebsocketClient.NetPrioResponseReceivedEventHandler
    • GossipWebsocketClient.PingReceivedEventHandler
    • GossipWebsocketClient.PingReplyReceivedEventHandler
    • GossipWebsocketClient.ProposalPayloadReceivedEventHandler
    • GossipWebsocketClient.StateProofSigReceivedEventHandler
    • GossipWebsocketClient.TopicMsgRespReceivedEventHandler
    • GossipWebsocketClient.TransactionReceivedEventHandler
    • GossipWebsocketClient.UniEnsBlockReqReceivedEventHandler
    • GossipWebsocketClient.VoteBundleReceivedEventHandler
    • GossipWebsocketClientConfiguration
  • Algorand.Gossip.Model
    • Tag
    • Topic
    • Topics
  • Algorand.Indexer
    • CommonApi
    • CommonApi.ObjectResponseResult<T>
    • ICommonApi
    • ILookupApi
    • ISearchApi
    • LookupApi
    • LookupApi.ObjectResponseResult<T>
    • SearchApi
    • SearchApi.ObjectResponseResult<T>
  • Algorand.Indexer.Model
    • Account
    • AccountParticipation
    • AccountResponse
    • AccountStateDelta
    • AccountsResponse
    • Application
    • ApplicationLocalState
    • ApplicationLocalStatesResponse
    • ApplicationLogData
    • ApplicationLogsResponse
    • ApplicationParams
    • ApplicationResponse
    • ApplicationStateSchema
    • ApplicationsResponse
    • 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
    • APIV1DELETEKeyResponse
    • APIV1DELETEMultisigResponse
    • APIV1GETWalletsResponse
    • APIV1POSTKeyExportResponse
    • APIV1POSTKeyImportResponse
    • APIV1POSTKeyListResponse
    • APIV1POSTKeyResponse
    • APIV1POSTMasterKeyExportResponse
    • APIV1POSTMultisigExportResponse
    • APIV1POSTMultisigImportResponse
    • APIV1POSTMultisigListResponse
    • APIV1POSTMultisigProgramSignResponse
    • APIV1POSTMultisigTransactionSignResponse
    • APIV1POSTProgramSignResponse
    • APIV1POSTTransactionSignResponse
    • APIV1POSTWalletInfoResponse
    • APIV1POSTWalletInitResponse
    • APIV1POSTWalletReleaseResponse
    • APIV1POSTWalletRenameResponse
    • APIV1POSTWalletRenewResponse
    • APIV1POSTWalletResponse
    • APIV1Wallet
    • APIV1WalletHandle
    • Api
    • Api.ObjectResponseResult<T>
    • ApiException
    • ApiException<TResult>
    • 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
    • SourceMap
    • SourceMap.VLQDecoder
    • Utils
    • VarintResult
    • Wordlist
  • Algorand.Utils.Crypto
    • FixedSecureRandom

Class ProxyBase

Inheritance
object
ProxyBase
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: AVM.ClientGenerator
Assembly: Algorand.dll
Syntax
public class ProxyBase

Constructors

| Edit this page View Source

ProxyBase(DefaultApi, ulong)

Declaration
public ProxyBase(DefaultApi algodApi, ulong appId)
Parameters
Type Name Description
DefaultApi algodApi
ulong appId

Properties

| Edit this page View Source

App

Declaration
public virtual AppDescriptionArc56 App { get; set; }
Property Value
Type Description
AppDescriptionArc56
| Edit this page View Source

AppAddress

Declaration
public Address AppAddress { get; }
Property Value
Type Description
Address
| Edit this page View Source

ExtraProgramPages

Up to 3 extensions to the program size

Declaration
protected virtual ulong? ExtraProgramPages { get; set; }
Property Value
Type Description
ulong?
| Edit this page View Source

GlobalNumByteSlices

Number of maximum global byte[] variables

Declaration
protected virtual ulong? GlobalNumByteSlices { get; set; }
Property Value
Type Description
ulong?
| Edit this page View Source

GlobalNumUints

Number of maximum global uint64 variables

Declaration
protected virtual ulong? GlobalNumUints { get; set; }
Property Value
Type Description
ulong?
| Edit this page View Source

LastCallLogs

The raw logs (including any ARC-28 event logs) produced by the most recent CallApp/SimApp invocation. Generated ARC56 clients emit an Events.<Name>Event.Decode(log)/Matches(log) helper per contract event; callers can filter these logs against those helpers to recover the emitted events.

Declaration
public ICollection<byte[]> LastCallLogs { get; protected set; }
Property Value
Type Description
ICollection<byte[]>
| Edit this page View Source

LocalNumByteSlices

Number of maximum local byte[] variables

Declaration
protected virtual ulong? LocalNumByteSlices { get; set; }
Property Value
Type Description
ulong?
| Edit this page View Source

LocalNumUints

Number of maximum local uint64 variables

Declaration
protected virtual ulong? LocalNumUints { get; set; }
Property Value
Type Description
ulong?
| Edit this page View Source

SourceApproval

Base64 TEAL code of approval program

Declaration
protected virtual string SourceApproval { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SourceApprovalAVM

Base64 AVM code of approval program

Declaration
protected virtual string SourceApprovalAVM { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SourceClear

Base64 TEAL code of clear state program

Declaration
protected virtual string SourceClear { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SourceClearAVM

Base64 AVM code of clear state program

Declaration
protected virtual string SourceClearAVM { get; set; }
Property Value
Type Description
string
| Edit this page View Source

TransParamsOverride

Developers can set the override for the tx params response, so that when creating new transactions the parameters are not fetched.

When user will request multiple transactions from the client or the user wants to rewrite the tx params, he can supply the tx params here.

Declaration
public TransactionParametersResponse? TransParamsOverride { get; set; }
Property Value
Type Description
TransactionParametersResponse
| Edit this page View Source

appId

Declaration
public ulong appId { get; protected set; }
Property Value
Type Description
ulong

Methods

| Edit this page View Source

CallApp(List<object>, Account, ulong?, string, ulong, List<BoxRef>?, List<Transaction>?, List<ulong>?, List<ulong>?, List<Address>?, OnCompleteType)

Declaration
protected Task<ICollection<byte[]>> CallApp(List<object> args, Account _tx_sender, ulong? _tx_fee, string _tx_note, ulong _tx_roundValidity, List<BoxRef>? _tx_boxes = null, List<Transaction>? _tx_transactions = null, List<ulong>? _tx_assets = null, List<ulong>? _tx_apps = null, List<Address>? _tx_accounts = null, OnCompleteType _tx_callType = OnCompleteType.NoOp)
Parameters
Type Name Description
List<object> args
Account _tx_sender
ulong? _tx_fee
string _tx_note
ulong _tx_roundValidity
List<BoxRef> _tx_boxes
List<Transaction> _tx_transactions
List<ulong> _tx_assets
List<ulong> _tx_apps
List<Address> _tx_accounts
OnCompleteType _tx_callType
Returns
Type Description
Task<ICollection<byte[]>>
| Edit this page View Source

GetBigIntegerFromByte(byte[])

Declaration
protected BigInteger GetBigIntegerFromByte(byte[] bytes)
Parameters
Type Name Description
byte[] bytes
Returns
Type Description
BigInteger
| Edit this page View Source

GetDecimalFromBytes(byte[])

Declaration
protected decimal GetDecimalFromBytes(byte[] resultBytes)
Parameters
Type Name Description
byte[] resultBytes
Returns
Type Description
decimal
| Edit this page View Source

GetGlobalByteSlice(string)

Declaration
protected Task<byte[]> GetGlobalByteSlice(string key)
Parameters
Type Name Description
string key
Returns
Type Description
Task<byte[]>
| Edit this page View Source

GetGlobalUInt(string)

Declaration
protected Task<ulong> GetGlobalUInt(string key)
Parameters
Type Name Description
string key
Returns
Type Description
Task<ulong>
| Edit this page View Source

GetLocalByteSlice(Account, string)

Declaration
protected Task<byte[]> GetLocalByteSlice(Account caller, string key)
Parameters
Type Name Description
Account caller
string key
Returns
Type Description
Task<byte[]>
| Edit this page View Source

GetLocalUInt(Account, string)

Declaration
protected Task<ulong> GetLocalUInt(Account caller, string key)
Parameters
Type Name Description
Account caller
string key
Returns
Type Description
Task<ulong>
| Edit this page View Source

MakeArc4TransactionList(List<Transaction>, ulong?, OnCompleteType, ulong, string, Account, byte[], List<WireType>, List<ulong>, List<ulong>, List<Address>, List<BoxRef>)

Declaration
protected Task<List<Transaction>> MakeArc4TransactionList(List<Transaction> preTransactions, ulong? fee, OnCompleteType onComplete, ulong roundValidity, string note, Account sender, byte[] selector, List<WireType> args, List<ulong> foreignApps, List<ulong> foreignAssets, List<Address> accounts, List<BoxRef> boxes = null)
Parameters
Type Name Description
List<Transaction> preTransactions
ulong? fee
OnCompleteType onComplete
ulong roundValidity
string note
Account sender
byte[] selector
List<WireType> args
List<ulong> foreignApps
List<ulong> foreignAssets
List<Address> accounts
List<BoxRef> boxes
Returns
Type Description
Task<List<Transaction>>
| Edit this page View Source

MakeTransactionList(List<object>, Account, ulong?, string, ulong, List<BoxRef>?, List<Transaction>?, List<ulong>?, List<ulong>?, List<Address>?, OnCompleteType)

Declaration
protected Task<List<Transaction>> MakeTransactionList(List<object> args, Account _tx_sender, ulong? _tx_fee, string _tx_note, ulong _tx_roundValidity, List<BoxRef>? _tx_boxes = null, List<Transaction>? _tx_transactions = null, List<ulong>? _tx_assets = null, List<ulong>? _tx_apps = null, List<Address>? _tx_accounts = null, OnCompleteType _tx_callType = OnCompleteType.NoOp)
Parameters
Type Name Description
List<object> args
Account _tx_sender
ulong? _tx_fee
string _tx_note
ulong _tx_roundValidity
List<BoxRef> _tx_boxes
List<Transaction> _tx_transactions
List<ulong> _tx_assets
List<ulong> _tx_apps
List<Address> _tx_accounts
OnCompleteType _tx_callType
Returns
Type Description
Task<List<Transaction>>
| Edit this page View Source

ReverseIfLittleEndian(byte[])

Declaration
protected byte[] ReverseIfLittleEndian(byte[] bytes)
Parameters
Type Name Description
byte[] bytes
Returns
Type Description
byte[]
| Edit this page View Source

SimApp(List<object>, Account, ulong?, string, ulong, List<BoxRef>?, List<Transaction>?, List<ulong>?, List<ulong>?, List<Address>?, OnCompleteType)

Declaration
protected Task<ICollection<byte[]>> SimApp(List<object> args, Account _tx_sender, ulong? _tx_fee, string _tx_note, ulong _tx_roundValidity, List<BoxRef>? _tx_boxes = null, List<Transaction>? _tx_transactions = null, List<ulong>? _tx_assets = null, List<ulong>? _tx_apps = null, List<Address>? _tx_accounts = null, OnCompleteType _tx_callType = OnCompleteType.NoOp)
Parameters
Type Name Description
List<object> args
Account _tx_sender
ulong? _tx_fee
string _tx_note
ulong _tx_roundValidity
List<BoxRef> _tx_boxes
List<Transaction> _tx_transactions
List<ulong> _tx_assets
List<ulong> _tx_apps
List<Address> _tx_accounts
OnCompleteType _tx_callType
Returns
Type Description
Task<ICollection<byte[]>>
  • Edit this page
  • View Source
☀
☾
In this article
Back to top
Generated by DocFX
☀
☾