LodashClient

Defined in: packages/store-kit/src/lodash/client.ts:656

A client to make calls to the Lodash smart contract

Constructors

new LodashClient()

new LodashClient(appClient): LodashClient

Defined in: packages/store-kit/src/lodash/client.ts:667

Creates a new instance of LodashClient

Parameters

appClient

AppClient

An AppClient instance which has been created with the Lodash app spec

Returns

LodashClient

new LodashClient()

new LodashClient(params): LodashClient

Defined in: packages/store-kit/src/lodash/client.ts:673

Creates a new instance of LodashClient

Parameters

params

Omit<AppClientParams, "appSpec">

The parameters to initialise the app client with

Returns

LodashClient

Properties

appClient

readonly appClient: AppClient

Defined in: packages/store-kit/src/lodash/client.ts:660

The underlying AppClient for when you want to have more flexibility

createTransaction

readonly createTransaction: object

Defined in: packages/store-kit/src/lodash/client.ts:932

Create transactions for the current app

clearState()

clearState: (params?) => Promise<Transaction>

Makes a clear_state call to an existing instance of the Lodash smart contract.

Parameters

params?

The params for the bare (raw) call

accountReferences?

(string | Address)[]

Any account addresses to add to the accounts array.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

args?

Uint8Array<ArrayBufferLike>[]

Any arguments to pass to the smart contract call.

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

(BoxReference | BoxIdentifier)[]

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

extraFee?

AlgoAmount

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

AlgoAmount

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

rekeyTo?

string | Address

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender?

string | Address

The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.

signer?

TransactionSigner | TransactionSignerAccount

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

AlgoAmount

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

Promise<Transaction>

The clearState result

concat()

concat: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Makes a call to the Lodash smart contract using the concat(string,string)void ABI method.

Concatenates a value to an existing box.

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

The call transaction

delete

delete: object

Gets available delete methods

delete.bare()

bare: (params?) => Promise<Transaction>

Deletes an existing instance of the Lodash smart contract using a bare call.

Parameters

params?

The params for the bare (raw) call

accountReferences?

(string | Address)[]

Any account addresses to add to the accounts array.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

args?

Uint8Array<ArrayBufferLike>[]

Any arguments to pass to the smart contract call.

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

(BoxReference | BoxIdentifier)[]

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

extraFee?

AlgoAmount

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

AlgoAmount

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

rekeyTo?

string | Address

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender?

string | Address

The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.

signer?

TransactionSigner | TransactionSignerAccount

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

AlgoAmount

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

Promise<Transaction>

The delete result

get()

get: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Makes a call to the Lodash smart contract using the get(string)string ABI method.

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

The call transaction

getBytes()

getBytes: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Makes a call to the Lodash smart contract using the get_bytes(string)byte[] ABI method.

Read raw ARC4 bytes from path (schema-typed paths).

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

The call transaction

getContractName()

getContractName: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Makes a call to the Lodash smart contract using the get_contract_name()byte[] ABI method.

This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.

Return the human-readable contract name, or empty bytes if unset.

Parameters

params

object & object = ...

The params for the smart contract call

Returns

Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

The call transaction

getContractType()

getContractType: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Makes a call to the Lodash smart contract using the get_contract_type()byte[] ABI method.

This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.

Return the contract type discriminator (b"object" or b"schema").

Parameters

params

object & object = ...

The params for the smart contract call

Returns

Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

The call transaction

getSchemaAppId()

getSchemaAppId: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Makes a call to the Lodash smart contract using the get_schema_app_id()uint64 ABI method.

setBytes: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Makes a call to the Lodash smart contract using the set_bytes(string,byte[])void ABI method.

Write raw ARC4 bytes to path (schema-typed paths). Bypasses the JSON envelope so another contract can decode the payload directly with arc4.decode. The box namespace is shared with set — only the on-the-wire type differs.

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

The call transaction

setContractName()

setContractName: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Makes a call to the Lodash smart contract using the set_contract_name(byte[])void ABI method.

Set (or clear) the human-readable contract name. Pass empty bytes to clear. Creator-only.

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

The call transaction

setContractType()

setContractType: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Makes a call to the Lodash smart contract using the set_contract_type(byte[])void ABI method.

Set the contract type discriminator. Must be either b"object" or b"schema". Creator-only.

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

The call transaction

setSchemaAppId()

setSchemaAppId: (params) => Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

Makes a call to the Lodash smart contract using the set_schema_app_id(uint64)void ABI method.

Bind (or clear) the schema-app pointer. Pass 0 to clear. Creator-only. The referenced app is expected to be a Lodash instance with contract_type == b"schema" whose boxes hold the canonical JSON Schema document.

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<{ methodCalls: Map<number, ABIMethod>; signers: Map<number, TransactionSigner>; transactions: Transaction[]; }>

The call transaction

params

readonly params: object

Defined in: packages/store-kit/src/lodash/client.ts:739

Get parameters to create transactions for the current app. A good mental model for this is that these parameters represent a deferred transaction creation.

clearState()

clearState: (params?) => AppCallParams

Makes a clear_state call to an existing instance of the Lodash smart contract.

Parameters

params?

The params for the bare (raw) call

accountReferences?

(string | Address)[]

Any account addresses to add to the accounts array.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

args?

Uint8Array<ArrayBufferLike>[]

Any arguments to pass to the smart contract call.

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

(BoxReference | BoxIdentifier)[]

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

extraFee?

AlgoAmount

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

AlgoAmount

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

rekeyTo?

string | Address

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender?

string | Address

The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.

signer?

TransactionSigner | TransactionSignerAccount

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

AlgoAmount

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

AppCallParams

The clearState result

concat()

concat: (params) => Promise<AppCallMethodCall>

Makes a call to the Lodash smart contract using the concat(string,string)void ABI method.

Concatenates a value to an existing box.

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<AppCallMethodCall>

The call params

delete

delete: object

Gets available delete methods

delete.bare()

bare: (params?) => AppDeleteParams

Deletes an existing instance of the Lodash smart contract using a bare call.

Parameters

params?

The params for the bare (raw) call

accountReferences?

(string | Address)[]

Any account addresses to add to the accounts array.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

args?

Uint8Array<ArrayBufferLike>[]

Any arguments to pass to the smart contract call.

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

(BoxReference | BoxIdentifier)[]

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

extraFee?

AlgoAmount

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

AlgoAmount

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

rekeyTo?

string | Address

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender?

string | Address

The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.

signer?

TransactionSigner | TransactionSignerAccount

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

AlgoAmount

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

AppDeleteParams

The delete result

get()

get: (params) => Promise<AppCallMethodCall>

Makes a call to the Lodash smart contract using the get(string)string ABI method.

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<AppCallMethodCall>

The call params

getBytes()

getBytes: (params) => Promise<AppCallMethodCall>

Makes a call to the Lodash smart contract using the get_bytes(string)byte[] ABI method.

Read raw ARC4 bytes from path (schema-typed paths).

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<AppCallMethodCall>

The call params

getContractName()

getContractName: (params) => Promise<AppCallMethodCall>

Makes a call to the Lodash smart contract using the get_contract_name()byte[] ABI method.

This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.

Return the human-readable contract name, or empty bytes if unset.

Parameters

params

object & object = ...

The params for the smart contract call

Returns

Promise<AppCallMethodCall>

The call params

getContractType()

getContractType: (params) => Promise<AppCallMethodCall>

Makes a call to the Lodash smart contract using the get_contract_type()byte[] ABI method.

This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.

Return the contract type discriminator (b"object" or b"schema").

Parameters

params

object & object = ...

The params for the smart contract call

Returns

Promise<AppCallMethodCall>

The call params

getSchemaAppId()

getSchemaAppId: (params) => Promise<AppCallMethodCall>

Makes a call to the Lodash smart contract using the get_schema_app_id()uint64 ABI method.

setContractName: (params) => Promise<AppCallMethodCall>

Makes a call to the Lodash smart contract using the set_contract_name(byte[])void ABI method.

Set (or clear) the human-readable contract name. Pass empty bytes to clear. Creator-only.

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<AppCallMethodCall>

The call params

setContractType()

setContractType: (params) => Promise<AppCallMethodCall>

Makes a call to the Lodash smart contract using the set_contract_type(byte[])void ABI method.

Set the contract type discriminator. Must be either b"object" or b"schema". Creator-only.

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<AppCallMethodCall>

The call params

setSchemaAppId()

setSchemaAppId: (params) => Promise<AppCallMethodCall>

Makes a call to the Lodash smart contract using the set_schema_app_id(uint64)void ABI method.

Parameters

params

object & object

The params for the smart contract call

Returns

Promise<AppCallMethodCall>

The call params

send

readonly send: object

Defined in: packages/store-kit/src/lodash/client.ts:1125

Send calls to the current app

clearState()

clearState: (params?) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: ABIReturn; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a clear_state call to an existing instance of the Lodash smart contract.

Parameters

params?

The params for the bare (raw) call

accountReferences?

(string | Address)[]

Any account addresses to add to the accounts array.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

args?

Uint8Array<ArrayBufferLike>[]

Any arguments to pass to the smart contract call.

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

(BoxReference | BoxIdentifier)[]

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

coverAppCallInnerTransactionFees?

boolean

Whether to use simulate to automatically calculate required app call inner transaction fees and cover them in the parent app call transaction fee

extraFee?

AlgoAmount

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

AlgoAmount

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

maxRoundsToWaitForConfirmation?

number

The number of rounds to wait for confirmation. By default until the latest lastValid has past.

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

populateAppCallResources?

boolean

Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to Config.populateAppCallResources.

rekeyTo?

string | Address

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender?

string | Address

The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.

signer?

TransactionSigner | TransactionSignerAccount

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

AlgoAmount

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

suppressLog?

boolean

Whether to suppress log messages from transaction send, default: do not suppress.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: ABIReturn; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

The clearState result

concat()

concat: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | void; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the concat(string,string)void ABI method.

Concatenates a value to an existing box.

Parameters

params

object & SendParams & object

The params for the smart contract call

Returns

Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | void; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

The call result

delete

delete: object

Gets available delete methods

delete.bare()

bare: (params?) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: ABIReturn; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Deletes an existing instance of the Lodash smart contract using a bare call.

Parameters

params?

The params for the bare (raw) call

accountReferences?

(string | Address)[]

Any account addresses to add to the accounts array.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

args?

Uint8Array<ArrayBufferLike>[]

Any arguments to pass to the smart contract call.

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

(BoxReference | BoxIdentifier)[]

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

coverAppCallInnerTransactionFees?

boolean

Whether to use simulate to automatically calculate required app call inner transaction fees and cover them in the parent app call transaction fee

extraFee?

AlgoAmount

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

AlgoAmount

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

maxRoundsToWaitForConfirmation?

number

The number of rounds to wait for confirmation. By default until the latest lastValid has past.

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

populateAppCallResources?

boolean

Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to Config.populateAppCallResources.

rekeyTo?

string | Address

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender?

string | Address

The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.

signer?

TransactionSigner | TransactionSignerAccount

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

AlgoAmount

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

suppressLog?

boolean

Whether to suppress log messages from transaction send, default: do not suppress.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

The delete result

get()

get: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | string; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the get(string)string ABI method.

Parameters

params

object & SendParams & object

The params for the smart contract call

Returns

Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | string; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

The call result

getBytes()

getBytes: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | Uint8Array<ArrayBufferLike>; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the get_bytes(string)byte[] ABI method.

Read raw ARC4 bytes from path (schema-typed paths).

Parameters

params

object & SendParams & object

The params for the smart contract call

Returns

Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | Uint8Array<ArrayBufferLike>; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

The call result

getContractName()

getContractName: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | Uint8Array<ArrayBufferLike>; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the get_contract_name()byte[] ABI method.

This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.

Return the human-readable contract name, or empty bytes if unset.

Parameters

params

object & SendParams & object = ...

The params for the smart contract call

Returns

The call result

getContractType()

getContractType: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | Uint8Array<ArrayBufferLike>; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the get_contract_type()byte[] ABI method.

This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.

Return the contract type discriminator (b"object" or b"schema").

Parameters

params

object & SendParams & object = ...

The params for the smart contract call

Returns

The call result

getSchemaAppId()

getSchemaAppId: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | bigint; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the get_schema_app_id()uint64 ABI method.

This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.

Return the bound schema app id, or 0 if unbound.

Parameters

params

object & SendParams & object = ...

The params for the smart contract call

Returns

Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | bigint; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

The call result

reclaim()

reclaim: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | void; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the reclaim(uint64)void ABI method.

Parameters

params

object & SendParams & object

The params for the smart contract call

Returns

The call result

remove()

remove: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | void; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the remove(string)void ABI method.

Parameters

params

object & SendParams & object

The params for the smart contract call

Returns

The call result

set()

set: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | void; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the set(string,string)void ABI method.

Parameters

params

object & SendParams & object

The params for the smart contract call

Returns

The call result

setBytes()

setBytes: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | void; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the set_bytes(string,byte[])void ABI method.

Parameters

params

object & SendParams & object

The params for the smart contract call

Returns

The call result

setContractName()

setContractName: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | void; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the set_contract_name(byte[])void ABI method.

Set (or clear) the human-readable contract name. Pass empty bytes to clear. Creator-only.

Parameters

params

object & SendParams & object

The params for the smart contract call

Returns

The call result

setContractType()

setContractType: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | void; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the set_contract_type(byte[])void ABI method.

Set the contract type discriminator. Must be either b"object" or b"schema". Creator-only.

Parameters

params

object & SendParams & object

The params for the smart contract call

Returns

The call result

setSchemaAppId()

setSchemaAppId: (params) => Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | void; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>

Makes a call to the Lodash smart contract using the set_schema_app_id(uint64)void ABI method.

Parameters

params

object & SendParams & object

The params for the smart contract call

Returns

The call result

state

state: object

Defined in: packages/store-kit/src/lodash/client.ts:1386

Methods to access state for the current Lodash app

global

global: object

Methods to access global state for the current Lodash app

global.contractName()

contractName: () => Promise<BinaryState>

Get the current value of the contract_name key in global state

Returns

Promise<BinaryState>

global.contractType()

contractType: () => Promise<BinaryState>

Get the current value of the contract_type key in global state

Returns

Promise<BinaryState>

global.getAll()

getAll: () => Promise<Partial<{ contractName: BinaryState; contractType: BinaryState; protocol: BinaryState; schemaAppId: bigint; }>>

Get all current keyed values from global state

Returns

Promise<Partial<{ contractName: BinaryState; contractType: BinaryState; protocol: BinaryState; schemaAppId: bigint; }>>

global.protocol()

protocol: () => Promise<BinaryState>

Get the current value of the protocol key in global state

Returns

Promise<BinaryState>

global.schemaAppId()

schemaAppId: () => Promise<undefined | bigint>

Get the current value of the schema_app_id key in global state

Returns

Promise<undefined | bigint>

Accessors

algorand

Get Signature

get algorand(): AlgorandClient

Defined in: packages/store-kit/src/lodash/client.ts:732

A reference to the underlying AlgorandClient this app client is using.

Returns

AlgorandClient

appAddress

Get Signature

get appAddress(): Address

Defined in: packages/store-kit/src/lodash/client.ts:717

The app address of the app instance this client is linked to.

Returns

Address

appId

Get Signature

get appId(): bigint

Defined in: packages/store-kit/src/lodash/client.ts:712

The ID of the app instance this client is linked to.

Returns

bigint

appName

Get Signature

get appName(): string

Defined in: packages/store-kit/src/lodash/client.ts:722

The name of the app.

Returns

string

appSpec

Get Signature

get appSpec(): Arc56Contract

Defined in: packages/store-kit/src/lodash/client.ts:727

The ARC-56 app spec being used

Returns

Arc56Contract

Methods

clone()

clone(params): LodashClient

Defined in: packages/store-kit/src/lodash/client.ts:1334

Clone this app client with different params

Parameters

params

The params to use for the the cloned app client. Omit a param to keep the original value. Set a param to override the original value. Setting to undefined will clear the original value.

appId?

bigint

The ID of the app instance this client should make calls against.

appName?

string

Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name

approvalSourceMap?

ProgramSourceMap

Optional source map for the approval program

clearSourceMap?

ProgramSourceMap

Optional source map for the clear state program

defaultSender?

string | Address

Optional address to use for the account to use as the default sender for calls.

defaultSigner?

TransactionSigner

Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from AlgorandClient).

Returns

LodashClient

A new app client with the altered params

decodeReturnValue()

decodeReturnValue<TSignature>(method, returnValue): undefined | MethodReturn<TSignature>

Defined in: packages/store-kit/src/lodash/client.ts:685

Checks for decode errors on the given return value and maps the return value to the return type for the given method

Type Parameters

Parameters

method

TSignature

returnValue

undefined | ABIReturn

Returns

undefined | MethodReturn<TSignature>

The typed return value or undefined if there was no value

getContractName()

getContractName(params): Promise<Uint8Array<ArrayBufferLike>>

Defined in: packages/store-kit/src/lodash/client.ts:1348

Makes a readonly (simulated) call to the Lodash smart contract using the get_contract_name()byte[] ABI method.

This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.

Return the human-readable contract name, or empty bytes if unset.

Parameters

params

The params for the smart contract call

accountReferences?

(string | Address)[]

Any account addresses to add to the accounts array.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

args

[] | {}

The args for the ABI method call, either as an ordered array or an object

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

(BoxReference | BoxIdentifier)[]

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

extraFee?

AlgoAmount

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

AlgoAmount

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

rekeyTo?

string | Address

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender?

string | Address

The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.

signer?

TransactionSigner | TransactionSignerAccount

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

AlgoAmount

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

Promise<Uint8Array<ArrayBufferLike>>

The call result

getContractType()

getContractType(params): Promise<Uint8Array<ArrayBufferLike>>

Defined in: packages/store-kit/src/lodash/client.ts:1363

Makes a readonly (simulated) call to the Lodash smart contract using the get_contract_type()byte[] ABI method.

This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.

Return the contract type discriminator (b"object" or b"schema").

Parameters

params

The params for the smart contract call

accountReferences?

(string | Address)[]

Any account addresses to add to the accounts array.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

args

[] | {}

The args for the ABI method call, either as an ordered array or an object

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

(BoxReference | BoxIdentifier)[]

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

extraFee?

AlgoAmount

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

AlgoAmount

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

rekeyTo?

string | Address

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender?

string | Address

The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.

signer?

TransactionSigner | TransactionSignerAccount

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

AlgoAmount

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

Promise<Uint8Array<ArrayBufferLike>>

The call result

getSchemaAppId()

getSchemaAppId(params): Promise<bigint>

Defined in: packages/store-kit/src/lodash/client.ts:1378

Makes a readonly (simulated) call to the Lodash smart contract using the get_schema_app_id()uint64 ABI method.

This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.

Return the bound schema app id, or 0 if unbound.

Parameters

params

The params for the smart contract call

accountReferences?

(string | Address)[]

Any account addresses to add to the accounts array.

appReferences?

bigint[]

The ID of any apps to load to the foreign apps array.

args

[] | {}

The args for the ABI method call, either as an ordered array or an object

assetReferences?

bigint[]

The ID of any assets to load to the foreign assets array.

boxReferences?

(BoxReference | BoxIdentifier)[]

Any boxes to load to the boxes array.

Either the name identifier (which will be set against app ID of 0 i.e. the current app), or a box identifier with the name identifier and app ID.

extraFee?

AlgoAmount

The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees.

firstValidRound?

bigint

Set the first round this transaction is valid. If left undefined, the value from algod will be used.

We recommend you only set this when you intentionally want this to be some time in the future.

lastValidRound?

bigint

The last round this transaction is valid. It is recommended to use validityWindow instead.

lease?

string | Uint8Array<ArrayBufferLike>

Prevent multiple transactions with the same lease being included within the validity window.

A lease enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).

maxFee?

AlgoAmount

Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.

note?

string | Uint8Array<ArrayBufferLike>

Note to attach to the transaction. Max of 1000 bytes.

rekeyTo?

string | Address

Change the signing key of the sender to the given address.

Warning: Please be careful with this parameter and be sure to read the official rekey guidance.

sender?

string | Address

The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.

signer?

TransactionSigner | TransactionSignerAccount

The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given sender or use a default signer (if configured).

staticFee?

AlgoAmount

The static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.

validityWindow?

number | bigint

How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.

Returns

Promise<bigint>

The call result

newGroup()

newGroup(): LodashComposer

Defined in: packages/store-kit/src/lodash/client.ts:1422

Returns

LodashComposer

fromCreatorAndName()

static fromCreatorAndName(params): Promise<LodashClient>

Defined in: packages/store-kit/src/lodash/client.ts:694

Returns a new LodashClient client, resolving the app by creator address and name using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note).

Parameters

params

Omit<{ algorand: AlgorandClient; appLookupCache: AppLookup; appName: string; approvalSourceMap: ProgramSourceMap; appSpec: string | Arc56Contract | AppSpec; clearSourceMap: ProgramSourceMap; creatorAddress: string | Address; defaultSender: string | Address; defaultSigner: TransactionSigner; ignoreCache: boolean; }, "appSpec">

The parameters to create the app client

Returns

Promise<LodashClient>

fromNetwork()

static fromNetwork(params): Promise<LodashClient>

Defined in: packages/store-kit/src/lodash/client.ts:705

Returns an LodashClient instance for the current network based on pre-determined network-specific app IDs specified in the ARC-56 app spec.

If no IDs are in the app spec or the network isn’t recognised, an error is thrown.

Parameters

params

Omit<{ algorand: AlgorandClient; appName: string; approvalSourceMap: ProgramSourceMap; appSpec: string | Arc56Contract | AppSpec; clearSourceMap: ProgramSourceMap; defaultSender: string | Address; defaultSigner: TransactionSigner; }, "appSpec">

The parameters to create the app client

Returns

Promise<LodashClient>