fix: deprecate is_sandbox and get_sandbox_default_account (#10)

src/algokit_utils/__init__.py

@@ -10,6 +10,7 @@
  get_kmd_wallet_account,
  get_localnet_default_account,
  get_or_create_kmd_wallet_account,
+ get_sandbox_default_account,
 )
 from algokit_utils.application_client import (
  ABICallArgs,
@@ -63,13 +64,15 @@
  get_indexer_client,
  get_kmd_client_from_algod_client,
  is_localnet,
+ is_sandbox,
 )
 
 __all__ = [
  "create_kmd_wallet_account",
  "get_account_from_mnemonic",
  "get_or_create_kmd_wallet_account",
  "get_localnet_default_account",
+ "get_sandbox_default_account",
  "get_dispenser_account",
  "get_kmd_wallet_account",
  "get_account",
@@ -120,6 +123,7 @@
  "get_indexer_client",
  "get_kmd_client_from_algod_client",
  "is_localnet",
+ "is_sandbox",
  "TransferParameters",
  "transfer",
 ]

src/algokit_utils/account.py

@@ -1,5 +1,6 @@
 import logging
 import os
+import warnings
 from collections.abc import Callable
 from typing import Any
 
@@ -14,6 +15,7 @@
 from algokit_utils.network_clients import get_kmd_client_from_algod_client, is_localnet
 
 __all__ = [
+ "create_kmd_wallet_account",
  "get_account_from_mnemonic",
  "get_or_create_kmd_wallet_account",
  "get_localnet_default_account",
@@ -85,6 +87,13 @@ def _is_default_account(account: dict[str, Any]) -> bool:
  return bool(account["status"] != "Offline" and account["amount"] > 1_000_000_000)
 
 
+def get_sandbox_default_account(client: AlgodClient) -> Account:
+ warnings.warn(
+ "get_sandbox_default_account is deprecated, please use get_localnet_default_account instead", DeprecationWarning
+ )
+ return get_localnet_default_account(client)
+
+
 def get_localnet_default_account(client: AlgodClient) -> Account:
  """Returns the default Account in a LocalNet instance"""
  if not is_localnet(client):

src/algokit_utils/application_client.py

@@ -44,6 +44,8 @@
 __all__ = [
  "ABICallArgs",
  "ABICallArgsDict",
+ "ABICreateCallArgs",
+ "ABICreateCallArgsDict",
  "ApplicationClient",
  "CommonCallParameters",
  "CommonCallParametersDict",

src/algokit_utils/network_clients.py

@@ -1,5 +1,6 @@
 import dataclasses
 import os
+import warnings
 from urllib import parse
 
 from algosdk.kmd import KMDClient
@@ -45,6 +46,11 @@ def is_localnet(client: AlgodClient) -> bool:
  return params.gen in ["devnet-v1", "sandnet-v1"]
 
 
+def is_sandbox(client: AlgodClient) -> bool:
+ warnings.warn("is_sandbox is deprecated, please use is_localnet instead", DeprecationWarning)
+ return is_localnet(client)
+
+
 def get_kmd_client_from_algod_client(client: AlgodClient) -> KMDClient:
  """Returns and SDK KMDClient using the same address as provided AlgodClient, but on port specified by
  KMD_PORT environment variable, or 4092 by default"""