refactor!: rename SourceMap to ProgramSourceMap to align with ts and move to algokit common (#241)

* refactor!: rename SourceMap to ProgramSourceMap to align with ts and move to algokit common

* refactor: unused ReadableAddress

* chore: regen docs

Author: aorumbayev

docs/markdown/autoapi/algokit_utils/accounts/kmd_account_manager/index.md

@@ -33,8 +33,6 @@ if no predicate is provided.
   * **sender** – Optional sender address to use this signer for (aka a rekeyed account)
 * **Returns:**
   The signing account or None if no matching wallet or account was found
-* **Raises:**
-  **Exception** – If error received while exporting the private key from KMD
 
 #### get_or_create_wallet_account(name: str, fund_with: [algokit_utils.models.amount.AlgoAmount](../../models/amount/index.md#algokit_utils.models.amount.AlgoAmount) | None = None) → algokit_transact.signer.AddressWithSigners
 

docs/markdown/autoapi/algokit_utils/applications/app_client/index.md

@@ -263,11 +263,11 @@ The default sender address
 
 The default transaction signer
 
-#### approval_source_map *: algokit_algosdk.source_map.SourceMap | None* *= None*
+#### approval_source_map *: algokit_common.ProgramSourceMap | None* *= None*
 
 The approval source map
 
-#### clear_source_map *: algokit_algosdk.source_map.SourceMap | None* *= None*
+#### clear_source_map *: algokit_common.ProgramSourceMap | None* *= None*
 
 The clear source map
 
@@ -292,10 +292,10 @@ methods for calling application methods, managing state, and handling transactio
           account="SIGNERACCOUNT",
           private_key="SIGNERPRIVATEKEY",
       ),
-      approval_source_map=SourceMap(
+      approval_source_map=ProgramSourceMap(
           source="APPROVALSOURCE",
       ),
-      clear_source_map=SourceMap(
+      clear_source_map=ProgramSourceMap(
           source="CLEARSOURCE",
       ),
   )
@@ -395,7 +395,7 @@ Normalize an application specification to ARC-56 format.
   spec = AppClient.normalise_app_spec(app_spec_json)
   ```
 
-#### *static* from_network(app_spec: algokit_abi.arc56.Arc56Contract | algokit_abi.arc32.Arc32Contract | str, algorand: [algokit_utils.algorand.AlgorandClient](../../algorand/index.md#algokit_utils.algorand.AlgorandClient), app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_algosdk.source_map.SourceMap | None = None, clear_source_map: algokit_algosdk.source_map.SourceMap | None = None) → [AppClient](#algokit_utils.applications.app_client.AppClient)
+#### *static* from_network(app_spec: algokit_abi.arc56.Arc56Contract | algokit_abi.arc32.Arc32Contract | str, algorand: [algokit_utils.algorand.AlgorandClient](../../algorand/index.md#algokit_utils.algorand.AlgorandClient), app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_common.ProgramSourceMap | None = None, clear_source_map: algokit_common.ProgramSourceMap | None = None) → [AppClient](#algokit_utils.applications.app_client.AppClient)
 
 Create an AppClient instance from network information.
 
@@ -422,16 +422,16 @@ Create an AppClient instance from network information.
           account="SIGNERACCOUNT",
           private_key="SIGNERPRIVATEKEY",
       ),
-      approval_source_map=SourceMap(
+      approval_source_map=ProgramSourceMap(
           source="APPROVALSOURCE",
       ),
-      clear_source_map=SourceMap(
+      clear_source_map=ProgramSourceMap(
           source="CLEARSOURCE",
       ),
   )
   ```
 
-#### *static* from_creator_and_name(creator_address: str, app_name: str, app_spec: algokit_abi.arc56.Arc56Contract | algokit_abi.arc32.Arc32Contract | str, algorand: [algokit_utils.algorand.AlgorandClient](../../algorand/index.md#algokit_utils.algorand.AlgorandClient), default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_algosdk.source_map.SourceMap | None = None, clear_source_map: algokit_algosdk.source_map.SourceMap | None = None, ignore_cache: bool | None = None, app_lookup_cache: [algokit_utils.applications.app_deployer.ApplicationLookup](../app_deployer/index.md#algokit_utils.applications.app_deployer.ApplicationLookup) | None = None) → [AppClient](#algokit_utils.applications.app_client.AppClient)
+#### *static* from_creator_and_name(creator_address: str, app_name: str, app_spec: algokit_abi.arc56.Arc56Contract | algokit_abi.arc32.Arc32Contract | str, algorand: [algokit_utils.algorand.AlgorandClient](../../algorand/index.md#algokit_utils.algorand.AlgorandClient), default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_common.ProgramSourceMap | None = None, clear_source_map: algokit_common.ProgramSourceMap | None = None, ignore_cache: bool | None = None, app_lookup_cache: [algokit_utils.applications.app_deployer.ApplicationLookup](../app_deployer/index.md#algokit_utils.applications.app_deployer.ApplicationLookup) | None = None) → [AppClient](#algokit_utils.applications.app_client.AppClient)
 
 Create an AppClient instance from creator address and application name.
 
@@ -482,7 +482,7 @@ Compile the application’s TEAL code.
 * **Returns:**
   The compilation result
 
-#### clone(app_name: str | None = \_MISSING, default_sender: str | None = \_MISSING, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = \_MISSING, approval_source_map: algokit_algosdk.source_map.SourceMap | None = \_MISSING, clear_source_map: algokit_algosdk.source_map.SourceMap | None = \_MISSING) → [AppClient](#algokit_utils.applications.app_client.AppClient)
+#### clone(app_name: str | None = \_MISSING, default_sender: str | None = \_MISSING, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = \_MISSING, approval_source_map: algokit_common.ProgramSourceMap | None = \_MISSING, clear_source_map: algokit_common.ProgramSourceMap | None = \_MISSING) → [AppClient](#algokit_utils.applications.app_client.AppClient)
 
 Create a cloned AppClient instance with optionally overridden parameters.
 

docs/markdown/autoapi/algokit_utils/applications/app_factory/index.md

@@ -260,7 +260,7 @@ various return properties like transaction, confirmation and deleteResult.
   })
   ```
 
-#### get_app_client_by_id(app_id: int, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_algosdk.source_map.SourceMap | None = None, clear_source_map: algokit_algosdk.source_map.SourceMap | None = None) → [algokit_utils.applications.app_client.AppClient](../app_client/index.md#algokit_utils.applications.app_client.AppClient)
+#### get_app_client_by_id(app_id: int, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_common.ProgramSourceMap | None = None, clear_source_map: algokit_common.ProgramSourceMap | None = None) → [algokit_utils.applications.app_client.AppClient](../app_client/index.md#algokit_utils.applications.app_client.AppClient)
 
 Returns a new AppClient client for an app instance of the given ID.
 
@@ -278,7 +278,7 @@ Returns a new AppClient client for an app instance of the given ID.
   app_client = factory.get_app_client_by_id(app_id=123)
   ```
 
-#### get_app_client_by_creator_and_name(creator_address: str, app_name: str, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, ignore_cache: bool | None = None, app_lookup_cache: [algokit_utils.applications.app_deployer.ApplicationLookup](../app_deployer/index.md#algokit_utils.applications.app_deployer.ApplicationLookup) | None = None, approval_source_map: algokit_algosdk.source_map.SourceMap | None = None, clear_source_map: algokit_algosdk.source_map.SourceMap | None = None) → [algokit_utils.applications.app_client.AppClient](../app_client/index.md#algokit_utils.applications.app_client.AppClient)
+#### get_app_client_by_creator_and_name(creator_address: str, app_name: str, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, ignore_cache: bool | None = None, app_lookup_cache: [algokit_utils.applications.app_deployer.ApplicationLookup](../app_deployer/index.md#algokit_utils.applications.app_deployer.ApplicationLookup) | None = None, approval_source_map: algokit_common.ProgramSourceMap | None = None, clear_source_map: algokit_common.ProgramSourceMap | None = None) → [algokit_utils.applications.app_client.AppClient](../app_client/index.md#algokit_utils.applications.app_client.AppClient)
 
 Returns a new AppClient client, resolving the app by creator address and name
 using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note).

docs/markdown/autoapi/algokit_utils/clients/client_manager/index.md

@@ -179,7 +179,7 @@ Get an application factory for deploying smart contracts.
 * **Returns:**
   Application factory instance
 
-#### get_app_client_by_id(app_spec: algokit_abi.arc56.Arc56Contract | str, app_id: int, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_algosdk.source_map.SourceMap | None = None, clear_source_map: algokit_algosdk.source_map.SourceMap | None = None) → [algokit_utils.applications.app_client.AppClient](../../applications/app_client/index.md#algokit_utils.applications.app_client.AppClient)
+#### get_app_client_by_id(app_spec: algokit_abi.arc56.Arc56Contract | str, app_id: int, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_common.ProgramSourceMap | None = None, clear_source_map: algokit_common.ProgramSourceMap | None = None) → [algokit_utils.applications.app_client.AppClient](../../applications/app_client/index.md#algokit_utils.applications.app_client.AppClient)
 
 Get an application client for an existing application by ID.
 
@@ -196,7 +196,7 @@ Get an application client for an existing application by ID.
 * **Returns:**
   Application client instance
 
-#### get_app_client_by_network(app_spec: algokit_abi.arc56.Arc56Contract | str, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_algosdk.source_map.SourceMap | None = None, clear_source_map: algokit_algosdk.source_map.SourceMap | None = None) → [algokit_utils.applications.app_client.AppClient](../../applications/app_client/index.md#algokit_utils.applications.app_client.AppClient)
+#### get_app_client_by_network(app_spec: algokit_abi.arc56.Arc56Contract | str, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_common.ProgramSourceMap | None = None, clear_source_map: algokit_common.ProgramSourceMap | None = None) → [algokit_utils.applications.app_client.AppClient](../../applications/app_client/index.md#algokit_utils.applications.app_client.AppClient)
 
 Get an application client for an existing application by network.
 
@@ -212,7 +212,7 @@ Get an application client for an existing application by network.
 * **Returns:**
   Application client instance
 
-#### get_app_client_by_creator_and_name(creator_address: str, app_name: str, app_spec: algokit_abi.arc56.Arc56Contract | str, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, ignore_cache: bool | None = None, app_lookup_cache: [algokit_utils.applications.app_deployer.ApplicationLookup](../../applications/app_deployer/index.md#algokit_utils.applications.app_deployer.ApplicationLookup) | None = None, approval_source_map: algokit_algosdk.source_map.SourceMap | None = None, clear_source_map: algokit_algosdk.source_map.SourceMap | None = None) → [algokit_utils.applications.app_client.AppClient](../../applications/app_client/index.md#algokit_utils.applications.app_client.AppClient)
+#### get_app_client_by_creator_and_name(creator_address: str, app_name: str, app_spec: algokit_abi.arc56.Arc56Contract | str, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, ignore_cache: bool | None = None, app_lookup_cache: [algokit_utils.applications.app_deployer.ApplicationLookup](../../applications/app_deployer/index.md#algokit_utils.applications.app_deployer.ApplicationLookup) | None = None, approval_source_map: algokit_common.ProgramSourceMap | None = None, clear_source_map: algokit_common.ProgramSourceMap | None = None) → [algokit_utils.applications.app_client.AppClient](../../applications/app_client/index.md#algokit_utils.applications.app_client.AppClient)
 
 Get an application client by creator address and name.
 
@@ -316,7 +316,7 @@ Get a typed application client by creator address and name.
   )
   ```
 
-#### get_typed_app_client_by_id(typed_client: type[TypedAppClientT], \*, app_id: int, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_algosdk.source_map.SourceMap | None = None, clear_source_map: algokit_algosdk.source_map.SourceMap | None = None) → TypedAppClientT
+#### get_typed_app_client_by_id(typed_client: type[TypedAppClientT], \*, app_id: int, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_common.ProgramSourceMap | None = None, clear_source_map: algokit_common.ProgramSourceMap | None = None) → TypedAppClientT
 
 Get a typed application client by ID.
 
@@ -341,7 +341,7 @@ Get a typed application client by ID.
   )
   ```
 
-#### get_typed_app_client_by_network(typed_client: type[TypedAppClientT], \*, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_algosdk.source_map.SourceMap | None = None, clear_source_map: algokit_algosdk.source_map.SourceMap | None = None) → TypedAppClientT
+#### get_typed_app_client_by_network(typed_client: type[TypedAppClientT], \*, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_common.ProgramSourceMap | None = None, clear_source_map: algokit_common.ProgramSourceMap | None = None) → TypedAppClientT
 
 Returns a new typed client, resolves the app ID for the current network.
 

docs/markdown/autoapi/algokit_utils/errors/logic_error/index.md

@@ -50,7 +50,7 @@ kwargs) -> new dictionary initialized with the name=value pairs
 
 ### algokit_utils.errors.logic_error.parse_logic_error(error_str: str) → [LogicErrorData](#algokit_utils.errors.logic_error.LogicErrorData) | None
 
-### *exception* algokit_utils.errors.logic_error.LogicError(\*, logic_error_str: str, program: str, source_map: AlgoSourceMap | None, transaction_id: str, message: str, pc: int, logic_error: Exception | None = None, traces: list[algokit_algod_client.models.SimulateTransactionResult] | None = None, get_line_for_pc: collections.abc.Callable[[int], int | None] | None = None)
+### *exception* algokit_utils.errors.logic_error.LogicError(\*, logic_error_str: str, program: str, source_map: ProgramSourceMap | None, transaction_id: str, message: str, pc: int, logic_error: Exception | None = None, traces: list[algokit_algod_client.models.SimulateTransactionResult] | None = None, get_line_for_pc: collections.abc.Callable[[int], int | None] | None = None)
 
 Bases: `Exception`
 

docs/markdown/autoapi/algokit_utils/models/application/index.md

@@ -99,7 +99,7 @@ The compiled hash
 
 The compiled base64 to bytes
 
-#### source_map *: algokit_algosdk.source_map.SourceMap | None*
+#### source_map *: algokit_common.ProgramSourceMap | None*
 
 ### *class* algokit_utils.models.application.AppCompilationResult
 
@@ -117,10 +117,10 @@ The compiled clear state program
 
 The source maps for the application
 
-#### approval_source_map *: algokit_algosdk.source_map.SourceMap | None* *= None*
+#### approval_source_map *: algokit_common.ProgramSourceMap | None* *= None*
 
 The source map for the approval program
 
-#### clear_source_map *: algokit_algosdk.source_map.SourceMap | None* *= None*
+#### clear_source_map *: algokit_common.ProgramSourceMap | None* *= None*
 
 The source map for the clear state program

docs/markdown/autoapi/algokit_utils/protocols/typed_clients/index.md

@@ -8,15 +8,15 @@
 
 ## Module Contents
 
-### *class* algokit_utils.protocols.typed_clients.TypedAppClientProtocol(\*, app_id: int, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, algorand: [algokit_utils.algorand.AlgorandClient](../../algorand/index.md#algokit_utils.algorand.AlgorandClient), approval_source_map: algokit_algosdk.source_map.SourceMap | None = None, clear_source_map: algokit_algosdk.source_map.SourceMap | None = None)
+### *class* algokit_utils.protocols.typed_clients.TypedAppClientProtocol(\*, app_id: int, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, algorand: [algokit_utils.algorand.AlgorandClient](../../algorand/index.md#algokit_utils.algorand.AlgorandClient), approval_source_map: algokit_common.ProgramSourceMap | None = None, clear_source_map: algokit_common.ProgramSourceMap | None = None)
 
 Bases: `Protocol`
 
 App Client protocol
 
 #### *classmethod* from_creator_and_name(\*, creator_address: str, app_name: str, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, ignore_cache: bool | None = None, app_lookup_cache: [ApplicationLookup](../../applications/app_deployer/index.md#algokit_utils.applications.app_deployer.ApplicationLookup) | None = None, algorand: [algokit_utils.algorand.AlgorandClient](../../algorand/index.md#algokit_utils.algorand.AlgorandClient)) → typing_extensions.Self
 
-#### *classmethod* from_network(\*, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_algosdk.source_map.SourceMap | None = None, clear_source_map: algokit_algosdk.source_map.SourceMap | None = None, algorand: [algokit_utils.algorand.AlgorandClient](../../algorand/index.md#algokit_utils.algorand.AlgorandClient)) → typing_extensions.Self
+#### *classmethod* from_network(\*, app_name: str | None = None, default_sender: str | None = None, default_signer: algokit_utils.protocols.signer.TransactionSigner | None = None, approval_source_map: algokit_common.ProgramSourceMap | None = None, clear_source_map: algokit_common.ProgramSourceMap | None = None, algorand: [algokit_utils.algorand.AlgorandClient](../../algorand/index.md#algokit_utils.algorand.AlgorandClient)) → typing_extensions.Self
 
 ### *class* algokit_utils.protocols.typed_clients.TypedAppFactoryProtocol(algorand: [algokit_utils.algorand.AlgorandClient](../../algorand/index.md#algokit_utils.algorand.AlgorandClient), \*\*kwargs: Any)
 

src/algokit_algosdk/__init__.py

@@ -22,7 +22,6 @@
     logicsig,
     mnemonic,
     multisig,
-    source_map,
     transaction,
 )
 
@@ -35,6 +34,5 @@
     "logicsig",
     "mnemonic",
     "multisig",
-    "source_map",
     "transaction",
 ]

src/algokit_algosdk/error.py

@@ -118,11 +118,6 @@ def __init__(self) -> None:
         super().__init__("decimals must be between 0 and 19, inclusive")
 
 
-class SourceMapVersionError(Exception):
-    def __init__(self, version: int) -> None:
-        super().__init__(f"unsupported source map version: {version}")
-
-
 class EmptyAddressError(Exception):
     def __init__(self) -> None:
         super().__init__(
@@ -142,7 +137,9 @@ def __init__(self) -> None:
 
 class ZeroAddressError(Exception):
     def __init__(self) -> None:
-        super().__init__("For the zero address, please specify AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAY5HFKQ")
+        super().__init__(
+            "For the zero address, please specify AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAY5HFKQ"
+        )
 
 
 class KeyregOnlineTxnInitError(Exception):