Skip to content

Commit

Permalink
chore: allow options for ensureFundedFromTestNetDispenserApi to not b…
Browse files Browse the repository at this point in the history
…e supplied (#320)
  • Loading branch information
neilcampbell authored Oct 8, 2024
1 parent caf45b5 commit f940449
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/code/classes/types_account_manager.AccountManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ ___

### ensureFundedFromTestNetDispenserApi

**ensureFundedFromTestNetDispenserApi**(`accountToFund`, `dispenserClient`, `minSpendingBalance`, `options`): `Promise`\<`undefined` \| [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\>
**ensureFundedFromTestNetDispenserApi**(`accountToFund`, `dispenserClient`, `minSpendingBalance`, `options?`): `Promise`\<`undefined` \| [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\>

Funds a given account using the TestNet Dispenser API as a funding source such that
the account has a certain amount of Algo free to spend (accounting for Algo locked
Expand All @@ -320,7 +320,7 @@ https://developer.algorand.org/docs/get-details/accounts/#minimum-balance
| `accountToFund` | `string` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The account to fund |
| `dispenserClient` | [`TestNetDispenserApiClient`](types_dispenser_client.TestNetDispenserApiClient.md) | The TestNet dispenser funding client |
| `minSpendingBalance` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The minimum balance of Algo that the account should have available to spend (i.e. on top of minimum balance requirement) |
| `options` | `Object` | Optional parameters to control the funding increment, transaction or execution of the transaction |
| `options?` | `Object` | Optional parameters to control the funding increment, transaction or execution of the transaction |
| `options.minFundingIncrement?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | - |

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion src/types/account-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -647,7 +647,7 @@ export class AccountManager {
accountToFund: string | TransactionSignerAccount,
dispenserClient: TestNetDispenserApiClient,
minSpendingBalance: AlgoAmount,
options: {
options?: {
minFundingIncrement?: AlgoAmount
},
): Promise<EnsureFundedResult | undefined> {
Expand Down

0 comments on commit f940449

Please sign in to comment.