LodashComposer
LodashComposer<
TReturns>:object
Defined in: packages/store-kit/src/lodash/client.ts:873
Type Parameters
• TReturns extends [...any[]] = []
Type declaration
delete
readonlydelete:object
Gets available delete methods
delete.bare()
Deletes an existing instance of the Lodash smart contract using a bare call.
Parameters
params?
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[]
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?
Uint8Array | string
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?
Uint8Array | string
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?
Address | string
The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.
signer?
algosdk.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
LodashComposer<[...TReturns[], undefined]>
The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions
addTransaction()
Adds a transaction to the composer
Parameters
txn
Transaction
A transaction to add to the transaction group
signer?
TransactionSigner
The optional signer to use when signing this transaction.
Returns
LodashComposer<TReturns>
clearState()
Makes a clear_state call to an existing instance of the Lodash smart contract.
Parameters
params?
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[]
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?
Uint8Array | string
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?
Uint8Array | string
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?
Address | string
The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.
signer?
algosdk.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
LodashComposer<[...TReturns[], undefined]>
The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions
composer()
Returns the underlying AtomicTransactionComposer instance
Returns
Promise<TransactionComposer>
concat()
Calls the concat(string,string)void ABI method.
Concatenates a value to an existing box.
Parameters
params?
Any additional parameters for the 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
Expand<TArgs>
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?
Uint8Array | string
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?
Uint8Array | string
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?
Address | string
The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.
signer?
algosdk.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
LodashComposer<[...TReturns[], undefined | void]>
The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions
get()
Calls the get(string)string ABI method.
Parameters
params?
Any additional parameters for the 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
Expand<TArgs>
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?
Uint8Array | string
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?
Uint8Array | string
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?
Address | string
The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.
signer?
algosdk.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
LodashComposer<[...TReturns[], undefined | string]>
The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions
reclaim()
Calls the reclaim(uint64)void ABI method.
Parameters
params?
Any additional parameters for the 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
Expand<TArgs>
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?
Uint8Array | string
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?
Uint8Array | string
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?
Address | string
The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.
signer?
algosdk.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
LodashComposer<[...TReturns[], undefined | void]>
The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions
remove()
Calls the remove(string)void ABI method.
Parameters
params?
Any additional parameters for the 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
Expand<TArgs>
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?
Uint8Array | string
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?
Uint8Array | string
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?
Address | string
The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.
signer?
algosdk.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
LodashComposer<[...TReturns[], undefined | void]>
The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions
send()
Sends the transaction group to the network and returns the results
Parameters
params?
SendParams
Returns
Promise<{ confirmations: modelsv2.PendingTransactionResponse[]; groupId: string; returns: ABIReturn[]; transactions: Transaction[]; txIds: string[]; }>
set()
Calls the set(string,string)void ABI method.
Parameters
params?
Any additional parameters for the 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
Expand<TArgs>
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?
Uint8Array | string
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?
Uint8Array | string
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?
Address | string
The address of the account sending the transaction, if undefined then the app client’s defaultSender is used.
signer?
algosdk.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
LodashComposer<[...TReturns[], undefined | void]>
The typed transaction composer so you can fluently chain multiple calls or call execute to execute all queued up transactions
simulate()
Call Signature
Simulates the transaction group and returns the result
Returns
Promise<object & object>
Call Signature
Parameters
options
allowMoreLogging?
boolean
allowUnnamedResources?
boolean
execTraceConfig?
SimulateTraceConfig
extraOpcodeBudget?
number | bigint
round?
number | bigint
skipSignatures
boolean
Whether or not to skip signatures for all built transactions and use an empty signer instead.
This will set fixSigners and allowEmptySignatures when sending the request to the algod API.
Returns
Promise<object & object>
Call Signature
Parameters
options
allowEmptySignatures?
boolean
allowMoreLogging?
boolean
allowUnnamedResources?
boolean
execTraceConfig?
SimulateTraceConfig
extraOpcodeBudget?
number | bigint
fixSigners?
boolean
round?
number | bigint
Returns
Promise<object & object>