Skip to content

Commit b58beed

Browse files
author
Chris Kim (Hyunggun)
committed
feat: add reference app client bootstraps in helper.py, tuple return -> namedTuple, apply changes to all utils code examples
1 parent 79c5c45 commit b58beed

24 files changed

+818
-59
lines changed

projects/python-examples/algokit_utils_py_examples/accounts/keys_and_signing.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
from algokit_utils import AlgoAmount, PaymentParams
22

3-
from algokit_utils_py_examples.helpers import setup_localnet_environment
3+
from algokit_utils_py_examples.helpers import (
4+
LocalnetEnvironment,
5+
setup_localnet_environment,
6+
)
47

58

69
def keys_and_signing() -> None:
710
# example: KEYS_AND_SIGNING
811

9-
algorand_client, _, account_a, account_b, account_c = setup_localnet_environment()
12+
env: LocalnetEnvironment = setup_localnet_environment()
13+
algorand_client = env.algorand_client
14+
account_a = env.account_a
15+
account_b = env.account_b
16+
account_c = env.account_c
17+
1018
algorand_client._default_validity_window = 1000
1119

1220
# example: DEFAULT_SIGNER

projects/python-examples/algokit_utils_py_examples/accounts/multisignature_accounts.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
from algokit_utils import AlgoAmount, MultisigMetadata, PaymentParams
22

3-
from algokit_utils_py_examples.helpers import setup_localnet_environment
3+
from algokit_utils_py_examples.helpers import (
4+
LocalnetEnvironment,
5+
setup_localnet_environment,
6+
)
47

58

69
def multisignature_accounts() -> None:
710
# example: MULTISIG_ACCOUNT
811

9-
algorand_client, dispenser, account_a, account_b, account_c = (
10-
setup_localnet_environment()
11-
)
12+
env: LocalnetEnvironment = setup_localnet_environment()
13+
algorand_client = env.algorand_client
14+
dispenser = env.dispenser
15+
account_a = env.account_a
16+
account_b = env.account_b
17+
account_c = env.account_c
1218

1319
"""
1420
Create a 2-of-3 multisig account that requires

projects/python-examples/algokit_utils_py_examples/accounts/rekeying_accounts.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
from algokit_utils import AlgoAmount, PaymentParams
22

3-
from algokit_utils_py_examples.helpers import setup_localnet_environment
3+
from algokit_utils_py_examples.helpers import (
4+
LocalnetEnvironment,
5+
setup_localnet_environment,
6+
)
47

58

69
def rekeying_accounts() -> None:
710
# example: REKEY_ACCOUNT
811

9-
algorand_client, dispenser, account_a, account_b, _ = setup_localnet_environment()
12+
env: LocalnetEnvironment = setup_localnet_environment()
13+
algorand_client = env.algorand_client
14+
dispenser = env.dispenser
15+
account_a = env.account_a
16+
account_b = env.account_b
1017

1118
"""
1219
Rekey an account to use a different address for signing.

projects/python-examples/algokit_utils_py_examples/algorand_client.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,17 @@
55
PaymentParams,
66
)
77

8-
from algokit_utils_py_examples.helpers import setup_localnet_environment
8+
from algokit_utils_py_examples.helpers import (
9+
LocalnetEnvironment,
10+
setup_localnet_environment,
11+
)
912

1013

1114
def algorand_client_bootstrap() -> None:
12-
algorand_client, _, account_a, account_b, _ = setup_localnet_environment()
15+
env: LocalnetEnvironment = setup_localnet_environment()
16+
algorand_client = env.algorand_client
17+
account_a = env.account_a
18+
account_b = env.account_b
1319

1420
algod = algorand_client.client.algod
1521
indexer = algorand_client.client.indexer
@@ -141,7 +147,10 @@ def algorand_client_bootstrap() -> None:
141147

142148

143149
def app_client() -> None:
144-
algorand_client, _, account_a, account_b, _ = setup_localnet_environment()
150+
env: LocalnetEnvironment = setup_localnet_environment()
151+
algorand_client = env.algorand_client
152+
account_a = env.account_a
153+
account_b = env.account_b
145154

146155
# example: GET_APP_CLIENT_WHEN_DEPLOYED
147156
from smart_contracts.artifacts.hello_world.hello_world_client import (

projects/python-examples/algokit_utils_py_examples/assets(ASA)/asset_clawback.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
from algokit_utils import AssetTransferParams
22

3-
from algokit_utils_py_examples.helpers import setup_localnet_environment
3+
from algokit_utils_py_examples.helpers import (
4+
LocalnetEnvironment,
5+
setup_localnet_environment,
6+
)
47

58

69
def asset_clawback() -> None:
710

8-
algorand_client, _, manager, account_to_be_clawbacked, _ = (
9-
setup_localnet_environment()
10-
)
11+
env: LocalnetEnvironment = setup_localnet_environment()
12+
algorand_client = env.algorand_client
13+
manager = env.account_a # Using account_a as the manager
14+
account_to_be_clawbacked = (
15+
env.account_b
16+
) # Using account_b as the account to be clawed back
1117

1218
# example: ASSET_CLAWBACK_TRANSACTION
1319

projects/python-examples/algokit_utils_py_examples/assets(ASA)/asset_create.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
from algokit_utils import AssetCreateParams
22

3-
from algokit_utils_py_examples.helpers import setup_localnet_environment
3+
from algokit_utils_py_examples.helpers import (
4+
LocalnetEnvironment,
5+
setup_localnet_environment,
6+
)
47

58

69
def asset_create() -> None:
710

8-
algorand_client, _, account_a, _, _ = setup_localnet_environment()
11+
env: LocalnetEnvironment = setup_localnet_environment()
12+
algorand_client = env.algorand_client
13+
account_a = env.account_a
914

1015
# example: ASSET_CREATE_TRANSACTION
1116

projects/python-examples/algokit_utils_py_examples/assets(ASA)/asset_delete.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
from algokit_utils import AssetDestroyParams
22

3-
from algokit_utils_py_examples.helpers import setup_localnet_environment
3+
from algokit_utils_py_examples.helpers import (
4+
LocalnetEnvironment,
5+
setup_localnet_environment,
6+
)
47

58

69
def asset_delete() -> None:
710

8-
algorand_client, _, account_a, _, _ = setup_localnet_environment()
11+
env: LocalnetEnvironment = setup_localnet_environment()
12+
algorand_client = env.algorand_client
13+
account_a = env.account_a
914

1015
# example: ASSET_DESTROY_TRANSACTION
1116
"""

projects/python-examples/algokit_utils_py_examples/assets(ASA)/asset_freeze.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
from algokit_utils import AssetFreezeParams
22

3-
from algokit_utils_py_examples.helpers import setup_localnet_environment
3+
from algokit_utils_py_examples.helpers import (
4+
LocalnetEnvironment,
5+
setup_localnet_environment,
6+
)
47

58

69
def asset_freeze() -> None:
7-
algorand_client, _, account_a, account_b, _ = setup_localnet_environment()
10+
env: LocalnetEnvironment = setup_localnet_environment()
11+
algorand_client = env.algorand_client
12+
account_a = env.account_a
13+
account_b = env.account_b
814

915
# example: ASSET_FREEZE_TRANSACTION
1016

projects/python-examples/algokit_utils_py_examples/assets(ASA)/asset_optin_optout.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
from algokit_utils import AssetOptInParams, AssetOptOutParams
22

3-
from algokit_utils_py_examples.helpers import setup_localnet_environment
3+
from algokit_utils_py_examples.helpers import (
4+
LocalnetEnvironment,
5+
setup_localnet_environment,
6+
)
47

58

69
def asset_optin_optout() -> None:
710

8-
algorand_client, _, account_a, account_b, _ = setup_localnet_environment()
11+
env: LocalnetEnvironment = setup_localnet_environment()
12+
algorand_client = env.algorand_client
13+
account_a = env.account_a
14+
account_b = env.account_b
915

1016
# example: ASSET_OPT_IN_TRANSACTION
1117

projects/python-examples/algokit_utils_py_examples/assets(ASA)/asset_transfer.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
from algokit_utils import AssetTransferParams
22

3-
from algokit_utils_py_examples.helpers import setup_localnet_environment
3+
from algokit_utils_py_examples.helpers import (
4+
LocalnetEnvironment,
5+
setup_localnet_environment,
6+
)
47

58

69
def asset_transfer() -> None:
7-
algorand_client, _, account_a, account_b, _ = setup_localnet_environment()
10+
env: LocalnetEnvironment = setup_localnet_environment()
11+
algorand_client = env.algorand_client
12+
account_a = env.account_a
13+
account_b = env.account_b
814

915
# example: ASSET_TRANSFER_TRANSACTION
1016

0 commit comments

Comments
 (0)