LodashClient
Defined in: packages/store-kit/src/lodash/client.ts:435
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:446
Creates a new instance of LodashClient
Parameters
appClient
AppClient
An AppClient instance which has been created with the Lodash app spec
Returns
new LodashClient()
new LodashClient(
params):LodashClient
Defined in: packages/store-kit/src/lodash/client.ts:452
Creates a new instance of LodashClient
Parameters
params
Omit<AppClientParams, "appSpec">
The parameters to initialise the app client with
Returns
Properties
appClient
readonlyappClient:AppClient
Defined in: packages/store-kit/src/lodash/client.ts:439
The underlying AppClient for when you want to have more flexibility
createTransaction
readonlycreateTransaction:object
Defined in: packages/store-kit/src/lodash/client.ts:601
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
reclaim()
reclaim: (
params) =>Promise<{methodCalls:Map<number,ABIMethod>;signers:Map<number,TransactionSigner>;transactions:Transaction[]; }>
Makes a call to the Lodash smart contract using the reclaim(uint64)void 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
remove()
remove: (
params) =>Promise<{methodCalls:Map<number,ABIMethod>;signers:Map<number,TransactionSigner>;transactions:Transaction[]; }>
Makes a call to the Lodash smart contract using the remove(string)void 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
set()
set: (
params) =>Promise<{methodCalls:Map<number,ABIMethod>;signers:Map<number,TransactionSigner>;transactions:Transaction[]; }>
Makes a call to the Lodash smart contract using the set(string,string)void 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
params
readonlyparams:object
Defined in: packages/store-kit/src/lodash/client.ts:518
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
reclaim()
reclaim: (
params) =>Promise<AppCallMethodCall>
Makes a call to the Lodash smart contract using the reclaim(uint64)void ABI method.
Parameters
params
object & object
The params for the smart contract call
Returns
Promise<AppCallMethodCall>
The call params
remove()
remove: (
params) =>Promise<AppCallMethodCall>
Makes a call to the Lodash smart contract using the remove(string)void ABI method.
Parameters
params
object & object
The params for the smart contract call
Returns
Promise<AppCallMethodCall>
The call params
set()
set: (
params) =>Promise<AppCallMethodCall>
Makes a call to the Lodash smart contract using the set(string,string)void ABI method.
Parameters
params
object & object
The params for the smart contract call
Returns
Promise<AppCallMethodCall>
The call params
send
readonlysend:object
Defined in: packages/store-kit/src/lodash/client.ts:684
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
Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: ABIReturn; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>
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
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
Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | void; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>
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
Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | void; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>
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
Promise<{ confirmation: PendingTransactionResponse; confirmations: PendingTransactionResponse[]; groupId: string; return: undefined | void; returns: ABIReturn[]; transaction: Transaction; transactions: Transaction[]; txIds: string[]; }>
The call result
state
state:
object={}
Defined in: packages/store-kit/src/lodash/client.ts:782
Methods to access state for the current Lodash app
Accessors
algorand
Get Signature
get algorand():
AlgorandClientInterface
Defined in: packages/store-kit/src/lodash/client.ts:511
A reference to the underlying AlgorandClient this app client is using.
Returns
AlgorandClientInterface
appAddress
Get Signature
get appAddress():
Address
Defined in: packages/store-kit/src/lodash/client.ts:496
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:491
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:501
The name of the app.
Returns
string
appSpec
Get Signature
get appSpec():
Arc56Contract
Defined in: packages/store-kit/src/lodash/client.ts:506
The ARC-56 app spec being used
Returns
Arc56Contract
Methods
clone()
clone(
params):LodashClient
Defined in: packages/store-kit/src/lodash/client.ts:775
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
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:464
Checks for decode errors on the given return value and maps the return value to the return type for the given method
Type Parameters
• TSignature extends "get" | "get(string)string"
Parameters
method
TSignature
returnValue
undefined | ABIReturn
Returns
undefined | MethodReturn<TSignature>
The typed return value or undefined if there was no value
newGroup()
newGroup():
LodashComposer
Defined in: packages/store-kit/src/lodash/client.ts:785
Returns
fromCreatorAndName()
staticfromCreatorAndName(params):Promise<LodashClient>
Defined in: packages/store-kit/src/lodash/client.ts:473
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: AlgorandClientInterface; 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()
staticfromNetwork(params):Promise<LodashClient>
Defined in: packages/store-kit/src/lodash/client.ts:484
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: AlgorandClientInterface; 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>