feat: add ensure_funded method (#24)

algorandfoundation · Apr 27, 2023 · e45fc46 · e45fc46 · github-actions · Apr 27, 2023
1 parent 6ba8792
commit e45fc46
Show file tree

Hide file tree

Showing 8 changed files with 425 additions and 41 deletions.
diff --git a/docs/html/_sources/apidocs/algokit_utils/algokit_utils.md.txt b/docs/html/_sources/apidocs/algokit_utils/algokit_utils.md.txt
@@ -120,6 +120,11 @@ orphan: true
  :parser: myst
  :summary:
  ```
+* - {py:obj}`EnsureBalanceParameters <algokit_utils._transfer.EnsureBalanceParameters>`
+ - ```{autodoc2-docstring} algokit_utils._transfer.EnsureBalanceParameters
+ :parser: myst
+ :summary:
+ ```
 * - {py:obj}`MethodHints <algokit_utils.application_specification.MethodHints>`
  - ```{autodoc2-docstring} algokit_utils.application_specification.MethodHints
  :parser: myst
@@ -178,6 +183,11 @@ orphan: true
  :parser: myst
  :summary:
  ```
+* - {py:obj}`ensure_funded <algokit_utils._transfer.ensure_funded>`
+ - ```{autodoc2-docstring} algokit_utils._transfer.ensure_funded
+ :parser: myst
+ :summary:
+ ```
 * - {py:obj}`execute_atc_with_logic_error <algokit_utils.application_client.execute_atc_with_logic_error>`
  - ```{autodoc2-docstring} algokit_utils.application_client.execute_atc_with_logic_error
  :parser: myst
@@ -951,6 +961,111 @@ Bases: {py:obj}`Exception`
 
 ```
 
+`````{py:class} EnsureBalanceParameters
+:canonical: algokit_utils._transfer.EnsureBalanceParameters
+
+```{autodoc2-docstring} algokit_utils._transfer.EnsureBalanceParameters
+:parser: myst
+```
+
+````{py:attribute} account_to_fund
+:canonical: algokit_utils._transfer.EnsureBalanceParameters.account_to_fund
+:type: algokit_utils.models.Account | algosdk.atomic_transaction_composer.AccountTransactionSigner | str
+:value: >
+ None
+
+```{autodoc2-docstring} algokit_utils._transfer.EnsureBalanceParameters.account_to_fund
+:parser: myst
+```
+
+````
+
+````{py:attribute} fee_micro_algos
+:canonical: algokit_utils._transfer.EnsureBalanceParameters.fee_micro_algos
+:type: int | None
+:value: >
+ None
+
+```{autodoc2-docstring} algokit_utils._transfer.EnsureBalanceParameters.fee_micro_algos
+:parser: myst
+```
+
+````
+
+````{py:attribute} funding_source
+:canonical: algokit_utils._transfer.EnsureBalanceParameters.funding_source
+:type: algokit_utils.models.Account | algosdk.atomic_transaction_composer.AccountTransactionSigner
+:value: >
+ None
+
+```{autodoc2-docstring} algokit_utils._transfer.EnsureBalanceParameters.funding_source
+:parser: myst
+```
+
+````
+
+````{py:attribute} max_fee_micro_algos
+:canonical: algokit_utils._transfer.EnsureBalanceParameters.max_fee_micro_algos
+:type: int | None
+:value: >
+ None
+
+```{autodoc2-docstring} algokit_utils._transfer.EnsureBalanceParameters.max_fee_micro_algos
+:parser: myst
+```
+
+````
+
+````{py:attribute} min_funding_increment_micro_algos
+:canonical: algokit_utils._transfer.EnsureBalanceParameters.min_funding_increment_micro_algos
+:type: int
+:value: >
+ 0
+
+```{autodoc2-docstring} algokit_utils._transfer.EnsureBalanceParameters.min_funding_increment_micro_algos
+:parser: myst
+```
+
+````
+
+````{py:attribute} min_spending_balance_micro_algos
+:canonical: algokit_utils._transfer.EnsureBalanceParameters.min_spending_balance_micro_algos
+:type: int
+:value: >
+ None
+
+```{autodoc2-docstring} algokit_utils._transfer.EnsureBalanceParameters.min_spending_balance_micro_algos
+:parser: myst
+```
+
+````
+
+````{py:attribute} note
+:canonical: algokit_utils._transfer.EnsureBalanceParameters.note
+:type: str | bytes | None
+:value: >
+ None
+
+```{autodoc2-docstring} algokit_utils._transfer.EnsureBalanceParameters.note
+:parser: myst
+```
+
+````
+
+````{py:attribute} suggested_params
+:canonical: algokit_utils._transfer.EnsureBalanceParameters.suggested_params
+:type: algosdk.transaction.SuggestedParams | None
+:value: >
+ None
+
+```{autodoc2-docstring} algokit_utils._transfer.EnsureBalanceParameters.suggested_params
+:parser: myst
+```
+
+````
+
+`````
+
 ```{py:exception} LogicError(*, logic_error: Exception, program: str, source_map: algosdk.source_map.SourceMap, transaction_id: str, message: str, pc: int)
 :canonical: algokit_utils.logic_error.LogicError
 
@@ -1369,6 +1484,14 @@ Bases: {py:obj}`enum.Enum`
 ```
 ````
 
+````{py:function} ensure_funded(client: algosdk.v2client.algod.AlgodClient, parameters: algokit_utils._transfer.EnsureBalanceParameters) -> None | algosdk.transaction.PaymentTxn
+:canonical: algokit_utils._transfer.ensure_funded
+
+```{autodoc2-docstring} algokit_utils._transfer.ensure_funded
+:parser: myst
+```
+````
+
 ````{py:function} execute_atc_with_logic_error(atc: algosdk.atomic_transaction_composer.AtomicTransactionComposer, algod_client: algosdk.v2client.algod.AlgodClient, wait_rounds: int = 4, approval_program: str | None = None, approval_source_map: algosdk.source_map.SourceMap | None = None) -> algosdk.atomic_transaction_composer.AtomicTransactionResponse
 :canonical: algokit_utils.application_client.execute_atc_with_logic_error
File	Stmts	Miss	Cover	Missing
src/algokit_utils
_transfer.py	80	4	95%	13, 82–83, 164
account.py	89	15	83%	15–18, 63–67, 96–101, 107, 120, 147, 150, 194
application_client.py	499	81	84%	48–49, 105, 121, 163, 178, 183, 247, 304, 309–310, 312, 314, 381, 390, 399, 449, 457, 466, 510, 518, 527, 571, 579, 588, 615, 641, 649, 658, 700, 708, 717, 777, 792, 810–813, 847, 859–860, 864, 886, 926, 934, 971, 1031–1037, 1041–1046, 1048, 1084, 1091, 1211, 1227–1229, 1231, 1248, 1253–1263, 1269, 1275, 1282–1285, 1309–1314, 1334–1337
application_specification.py	97	25	74%	85, 88–97, 110, 118, 126, 155, 171, 193–202, 206
deploy.py	373	23	94%	30–33, 163, 167–168, 185, 241, 318, 322, 328–336, 353–356, 374, 536–537, 557
logic_error.py	36	2	94%	6, 30
models.py	69	1	99%	70
network_clients.py	64	5	92%	88–89, 114, 117–118
TOTAL	1316	156	88%