-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(transfer): Added ensureFunded method
- Loading branch information
Showing
10 changed files
with
399 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
203 changes: 203 additions & 0 deletions
203
docs/code/interfaces/types_transfer.EnsureFundedParams.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,203 @@ | ||
[@algorandfoundation/algokit-utils](../README.md) / [types/transfer](../modules/types_transfer.md) / EnsureFundedParams | ||
|
||
# Interface: EnsureFundedParams | ||
|
||
[types/transfer](../modules/types_transfer.md).EnsureFundedParams | ||
|
||
Parameters for | ||
|
||
**`See`** | ||
|
||
ensureFunded call. | ||
|
||
## Hierarchy | ||
|
||
- [`SendTransactionParams`](types_transaction.SendTransactionParams.md) | ||
|
||
↳ **`EnsureFundedParams`** | ||
|
||
## Table of contents | ||
|
||
### Properties | ||
|
||
- [accountToFund](types_transfer.EnsureFundedParams.md#accounttofund) | ||
- [fee](types_transfer.EnsureFundedParams.md#fee) | ||
- [fundingSource](types_transfer.EnsureFundedParams.md#fundingsource) | ||
- [maxFee](types_transfer.EnsureFundedParams.md#maxfee) | ||
- [maxRoundsToWaitForConfirmation](types_transfer.EnsureFundedParams.md#maxroundstowaitforconfirmation) | ||
- [minFundingIncrement](types_transfer.EnsureFundedParams.md#minfundingincrement) | ||
- [minSpendingBalance](types_transfer.EnsureFundedParams.md#minspendingbalance) | ||
- [note](types_transfer.EnsureFundedParams.md#note) | ||
- [skipSending](types_transfer.EnsureFundedParams.md#skipsending) | ||
- [skipWaiting](types_transfer.EnsureFundedParams.md#skipwaiting) | ||
- [suppressLog](types_transfer.EnsureFundedParams.md#suppresslog) | ||
- [transactionParams](types_transfer.EnsureFundedParams.md#transactionparams) | ||
|
||
## Properties | ||
|
||
### accountToFund | ||
|
||
• **accountToFund**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) | ||
|
||
The account to fund | ||
|
||
#### Defined in | ||
|
||
[types/transfer.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L22) | ||
|
||
___ | ||
|
||
### fee | ||
|
||
• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | ||
|
||
The flat fee you want to pay, useful for covering extra fees in a transaction group or app call | ||
|
||
#### Inherited from | ||
|
||
[SendTransactionParams](types_transaction.SendTransactionParams.md).[fee](types_transaction.SendTransactionParams.md#fee) | ||
|
||
#### Defined in | ||
|
||
[types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) | ||
|
||
___ | ||
|
||
### fundingSource | ||
|
||
• **fundingSource**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) | ||
|
||
The account to use as a funding source | ||
|
||
#### Defined in | ||
|
||
[types/transfer.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L24) | ||
|
||
___ | ||
|
||
### maxFee | ||
|
||
• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | ||
|
||
The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion | ||
|
||
#### Inherited from | ||
|
||
[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxFee](types_transaction.SendTransactionParams.md#maxfee) | ||
|
||
#### Defined in | ||
|
||
[types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) | ||
|
||
___ | ||
|
||
### maxRoundsToWaitForConfirmation | ||
|
||
• `Optional` **maxRoundsToWaitForConfirmation**: `number` | ||
|
||
The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds | ||
|
||
#### Inherited from | ||
|
||
[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxRoundsToWaitForConfirmation](types_transaction.SendTransactionParams.md#maxroundstowaitforconfirmation) | ||
|
||
#### Defined in | ||
|
||
[types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) | ||
|
||
___ | ||
|
||
### minFundingIncrement | ||
|
||
• `Optional` **minFundingIncrement**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | ||
|
||
When issuing a funding amount, the minimum amount to transfer (avoids many small transfers if this gets called often on an active account) | ||
|
||
#### Defined in | ||
|
||
[types/transfer.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L28) | ||
|
||
___ | ||
|
||
### minSpendingBalance | ||
|
||
• **minSpendingBalance**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | ||
|
||
The minimum balance of ALGOs that the account should have available to spend (i.e. on top of minimum balance requirement) | ||
|
||
#### Defined in | ||
|
||
[types/transfer.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L26) | ||
|
||
___ | ||
|
||
### note | ||
|
||
• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) | ||
|
||
The (optional) transaction note, default: "Funding account to meet minimum requirement" | ||
|
||
#### Defined in | ||
|
||
[types/transfer.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L32) | ||
|
||
___ | ||
|
||
### skipSending | ||
|
||
• `Optional` **skipSending**: `boolean` | ||
|
||
Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain) | ||
(and instead just return the raw transaction, e.g. so you can add it to a group of transactions) | ||
|
||
#### Inherited from | ||
|
||
[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipSending](types_transaction.SendTransactionParams.md#skipsending) | ||
|
||
#### Defined in | ||
|
||
[types/transaction.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L26) | ||
|
||
___ | ||
|
||
### skipWaiting | ||
|
||
• `Optional` **skipWaiting**: `boolean` | ||
|
||
Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) | ||
|
||
#### Inherited from | ||
|
||
[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipWaiting](types_transaction.SendTransactionParams.md#skipwaiting) | ||
|
||
#### Defined in | ||
|
||
[types/transaction.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L28) | ||
|
||
___ | ||
|
||
### suppressLog | ||
|
||
• `Optional` **suppressLog**: `boolean` | ||
|
||
Whether to suppress log messages from transaction send, default: do not suppress | ||
|
||
#### Inherited from | ||
|
||
[SendTransactionParams](types_transaction.SendTransactionParams.md).[suppressLog](types_transaction.SendTransactionParams.md#suppresslog) | ||
|
||
#### Defined in | ||
|
||
[types/transaction.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L30) | ||
|
||
___ | ||
|
||
### transactionParams | ||
|
||
• `Optional` **transactionParams**: `SuggestedParams` | ||
|
||
Optional transaction parameters | ||
|
||
#### Defined in | ||
|
||
[types/transfer.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L30) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.