@algorandfoundation/algokit-utils 8.2.0-beta.2 → 8.2.0-beta.3

package/types/client-manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"client-manager.js","sources":["../../src/types/client-manager.ts"],"sourcesContent":["import algosdk, { SuggestedParams } from 'algosdk'\nimport { AlgoHttpClientWithRetry } from './algo-http-client-with-retry'\nimport { AlgorandClientInterface } from './algorand-client-interface'\nimport { AppClient, AppClientParams, ResolveAppClientByCreatorAndName } from './app-client'\nimport { AppFactory, AppFactoryParams } from './app-factory'\nimport { TestNetDispenserApiClient, TestNetDispenserApiClientParams } from './dispenser-client'\nimport { Expand } from './expand'\nimport { AlgoClientConfig, AlgoConfig, NetworkDetails, genesisIdIsLocalNet } from './network-client'\nimport Kmd = algosdk.Kmd\nimport Indexer = algosdk.Indexer\nimport Algodv2 = algosdk.Algodv2\n\n/** Clients from algosdk that interact with the official Algorand APIs */\nexport interface AlgoSdkClients {\n  /** Algod client, see https://developer.algorand.org/docs/rest-apis/algod/ */\n  algod: algosdk.Algodv2\n  /** Optional indexer client, see https://developer.algorand.org/docs/rest-apis/indexer/ */\n  indexer?: algosdk.Indexer\n  /** Optional KMD client, see https://developer.algorand.org/docs/rest-apis/kmd/ */\n  kmd?: algosdk.Kmd\n}\n\n/** Params to get an app factory from `ClientManager`. */\nexport type ClientAppFactoryParams = Expand<Omit<AppFactoryParams, 'algorand'>>\n\n/** Params to get an app client by creator address and name from `ClientManager`. */\nexport type ClientResolveAppClientByCreatorAndNameParams = Expand<Omit<ResolveAppClientByCreatorAndName, 'algorand'>>\n\n/** Params to get an app client by ID from `ClientManager`. */\nexport type ClientAppClientParams = Expand<Omit<AppClientParams, 'algorand'>>\n\n/** Params to get an app client by network from `ClientManager`. */\nexport type ClientAppClientByNetworkParams = Expand<Omit<AppClientParams, 'algorand' | 'appId'>>\n\n/** Params to get a typed app client by creator address and name from `ClientManager`. */\nexport type ClientTypedAppClientByCreatorAndNameParams = Expand<Omit<ResolveAppClientByCreatorAndName, 'algorand' | 'appSpec'>>\n\n/** Params to get a typed app client by ID from `ClientManager`. */\nexport type ClientTypedAppClientParams = Expand<Omit<AppClientParams, 'algorand' | 'appSpec'>>\n\n/** Params to get a typed app client by network from `ClientManager`. */\nexport type ClientTypedAppClientByNetworkParams = Expand<Omit<AppClientParams, 'algorand' | 'appSpec' | 'appId'>>\n\n/** Params to get a typed app factory from `ClientManager`. */\nexport type ClientTypedAppFactoryParams = Expand<Omit<AppFactoryParams, 'algorand' | 'appSpec'>>\n\n/** Exposes access to various API clients. */\nexport class ClientManager {\n  private _algod: algosdk.Algodv2\n  private _indexer?: algosdk.Indexer\n  private _kmd?: algosdk.Kmd\n  private _algorand?: AlgorandClientInterface\n\n  /**\n   * algosdk clients or config for interacting with the official Algorand APIs.\n   * @param clientsOrConfig The clients or config to use\n   * @example Algod client only\n   * ```typescript\n   * const clientManager = new ClientManager({ algod: algodClient })\n   * ```\n   * @example All clients\n   * ```typescript\n   * const clientManager = new ClientManager({ algod: algodClient, indexer: indexerClient, kmd: kmdClient })\n   * ```\n   * @example Algod config only\n   * ```typescript\n   * const clientManager = new ClientManager({ algodConfig })\n   * ```\n   * @example All client configs\n   * ```typescript\n   * const clientManager = new ClientManager({ algodConfig, indexerConfig, kmdConfig })\n   * ```\n   */\n  constructor(clientsOrConfig: AlgoConfig | AlgoSdkClients, algorandClient?: AlgorandClientInterface) {\n    const _clients =\n      'algod' in clientsOrConfig\n        ? clientsOrConfig\n        : {\n            algod: ClientManager.getAlgodClient(clientsOrConfig.algodConfig),\n            indexer: clientsOrConfig.indexerConfig ? ClientManager.getIndexerClient(clientsOrConfig.indexerConfig) : undefined,\n            kmd: clientsOrConfig.kmdConfig ? ClientManager.getKmdClient(clientsOrConfig.kmdConfig) : undefined,\n          }\n    this._algod = _clients.algod\n    this._indexer = _clients.indexer\n    this._kmd = _clients.kmd\n    this._algorand = algorandClient\n  }\n\n  /** Returns an algosdk Algod API client. */\n  public get algod(): algosdk.Algodv2 {\n    return this._algod\n  }\n\n  /** Returns an algosdk Indexer API client or throws an error if it's not been provided. */\n  public get indexer(): algosdk.Indexer {\n    if (!this._indexer) throw new Error('Attempt to use Indexer client in AlgoKit instance with no Indexer configured')\n    return this._indexer\n  }\n\n  /** Returns an algosdk Indexer API client or `undefined` if it's not been provided. */\n  public get indexerIfPresent(): algosdk.Indexer | undefined {\n    return this._indexer\n  }\n\n  /** Returns an algosdk KMD API client or throws an error if it's not been provided. */\n  public get kmd(): algosdk.Kmd {\n    if (!this._kmd) throw new Error('Attempt to use Kmd client in AlgoKit instance with no Kmd configured')\n    return this._kmd\n  }\n\n  private _getNetworkPromise: Promise<SuggestedParams> | undefined\n  /**\n   * Get details about the current network.\n   * @example Getting genesis ID\n   * ```typescript\n   * const network = await networkClient.network()\n   * const genesisId = network.genesisId\n   * ```\n   * @returns The current network details\n   */\n  public async network(): Promise<NetworkDetails> {\n    if (!this._getNetworkPromise) {\n      this._getNetworkPromise = this._algod.getTransactionParams().do()\n    }\n\n    const params = await this._getNetworkPromise\n    return {\n      isTestNet: ['testnet-v1.0', 'testnet-v1', 'testnet'].includes(params.genesisID ?? 'unknown'),\n      isMainNet: ['mainnet-v1.0', 'mainnet-v1', 'mainnet'].includes(params.genesisID ?? 'unknown'),\n      isLocalNet: ClientManager.genesisIdIsLocalNet(params.genesisID ?? 'unknown'),\n      genesisId: params.genesisID ?? 'unknown',\n      genesisHash: params.genesisHash ? Buffer.from(params.genesisHash).toString('base64') : 'unknown',\n    }\n  }\n\n  /**\n   * Returns true if the given network genesisId is associated with a LocalNet network.\n   * @param genesisId The network genesis ID\n   * @returns Whether the given genesis ID is associated with a LocalNet network\n   */\n  public static genesisIdIsLocalNet(genesisId: string) {\n    return genesisIdIsLocalNet(genesisId)\n  }\n\n  /**\n   * Returns true if the current network is LocalNet.\n   * @returns True if the current network is LocalNet.\n   */\n  public async isLocalNet() {\n    return (await this.network()).isLocalNet\n  }\n\n  /**\n   * Returns true if the current network is TestNet.\n   * @returns True if the current network is TestNet.\n   */\n  public async isTestNet() {\n    return (await this.network()).isTestNet\n  }\n\n  /**\n   * Returns true if the current network is MainNet.\n   * @returns True if the current network is MainNet.\n   */\n  public async isMainNet() {\n    return (await this.network()).isMainNet\n  }\n\n  /**\n   * Returns a TestNet Dispenser API client.\n   *\n   * Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token.\n   *\n   * @param params An object containing parameters for the TestNetDispenserApiClient class.\n   * @example\n   * const client = clientManager.getTestNetDispenser(\n   *     {\n   *       authToken: 'your_auth_token',\n   *       requestTimeout: 15,\n   *     }\n   * )\n   *\n   * @returns An instance of the TestNetDispenserApiClient class.\n   */\n  public getTestNetDispenser(params: TestNetDispenserApiClientParams) {\n    return new TestNetDispenserApiClient(params)\n  }\n\n  /**\n   * Returns a TestNet Dispenser API client, loading the auth token from `process.env.ALGOKIT_DISPENSER_ACCESS_TOKEN`.\n   *\n   * Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token.\n   *\n   * @param params An object containing parameters for the TestNetDispenserApiClient class.\n   * @example\n   * const client = clientManager.getTestNetDispenserFromEnvironment(\n   *     {\n   *       requestTimeout: 15,\n   *     }\n   * )\n   *\n   * @returns An instance of the TestNetDispenserApiClient class.\n   */\n  public getTestNetDispenserFromEnvironment(params?: Omit<TestNetDispenserApiClientParams, 'authToken'>) {\n    return new TestNetDispenserApiClient(params ? { ...params, authToken: '' } : undefined)\n  }\n\n  /**\n   * Returns a new `AppFactory` client\n   * @example Basic example\n   * ```typescript\n   * const factory = algorand.client.getAppFactory({\n   *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\\/}',\n   * })\n   * ```\n   * @example Advanced example\n   * ```typescript\n   * const factory = algorand.client.getAppFactory({\n   *   appSpec: parsedAppSpec_AppSpec_or_Arc56Contract,\n   *   defaultSender: \"SENDERADDRESS\",\n   *   appName: \"OverriddenAppName\",\n   *   version: \"2.0.0\",\n   *   updatable: true,\n   *   deletable: false,\n   *   deployTimeParams: { ONE: 1, TWO: 'value' }\n   * })\n   * ```\n   */\n  public getAppFactory(params: ClientAppFactoryParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app factory from a ClientManager without an Algorand client')\n    }\n\n    return new AppFactory({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new `AppClient` client for managing calls and state for an ARC-32/ARC-56 app.\n   * This method resolves the app ID by looking up the creator address and name\n   * using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note).\n   * @param params The parameters to create the app client\n   * @example Basic\n   * ```typescript\n   * const appClient = algorand.client.getAppClientByCreatorAndName({\n   *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\\}',\n   *   // appId resolved by looking for app ID of named app by this creator\n   *   creatorAddress: 'CREATORADDRESS',\n   * })\n   * ```\n   * @returns The `AppClient`\n   */\n  public getAppClientByCreatorAndName(params: ClientResolveAppClientByCreatorAndNameParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n\n    return AppClient.fromCreatorAndName({\n      ...params,\n      algorand: this._algorand,\n    })\n  }\n\n  /**\n   * Returns a new `AppClient` client for managing calls and state for an ARC-32/ARC-56 app.\n   * @param params The parameters to create the app client\n   * @example Basic\n   * ```typescript\n   * const appClient = algorand.client.getAppClientById({\n   *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\\}',\n   *   appId: 12345n,\n   * })\n   * ```\n   * @returns The `AppClient`\n   */\n  public getAppClientById(params: ClientAppClientParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n    return new AppClient({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new `AppClient` client for managing calls and state for an ARC-56 app.\n   * This method resolves the app ID for the current network based on\n   * pre-determined network-specific app IDs specified in the ARC-56 app spec.\n   *\n   * If no IDs are in the app spec or the network isn't recognised, an error is thrown.\n   * @param params The parameters to create the app client\n   * @example Basic\n   * ```typescript\n   * const appClient = algorand.client.getAppClientByNetwork({\n   *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\\}',\n   *   // appId resolved by using ARC-56 spec to find app ID for current network\n   * })\n   * ```\n   * @returns The `AppClient`\n   */\n  public async getAppClientByNetwork(params: ClientAppClientByNetworkParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n    return AppClient.fromNetwork({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new typed client, resolving the app by creator address and name.\n   * @param typedClient The typed client type to use\n   * @param params The params to resolve the app by creator address and name\n   * @example Use name in ARC-32 / ARC-56 app spec\n   * ```typescript\n   * const appClient = algorand.client.getTypedAppClientByCreatorAndName(MyContractClient, {\n   *   creatorAddress: \"CREATORADDRESS\",\n   *   defaultSender: alice,\n   * })\n   * ```\n   * @example Specify name\n   * ```typescript\n   * const appClient = algorand.client.getTypedAppClientByCreatorAndName(MyContractClient, {\n   *   creatorAddress: \"CREATORADDRESS\",\n   *   name: \"contract-name\",\n   *   defaultSender: alice,\n   * })\n   * ```\n   * @returns The typed client instance\n   */\n  public async getTypedAppClientByCreatorAndName<TClient extends TypedAppClient<InstanceType<TClient>>>(\n    typedClient: TClient,\n    params: ClientTypedAppClientByCreatorAndNameParams,\n  ) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n\n    return typedClient.fromCreatorAndName({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new typed client, resolving the app by app ID.\n   * @param typedClient The typed client type to use\n   * @param params The params to resolve the app by ID\n   * @example\n   * ```typescript\n   * const appClient = algorand.client.getTypedAppClientById(MyContractClient, {\n   *   appId: 12345n,\n   *   defaultSender: alice,\n   * })\n   * ```\n   * @returns The typed client instance\n   */\n  public getTypedAppClientById<TClient extends TypedAppClient<InstanceType<TClient>>>(\n    typedClient: TClient,\n    params: ClientTypedAppClientParams,\n  ) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n\n    return new typedClient({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new typed client, resolves the app ID for the current network based on\n   * pre-determined network-specific app IDs specified in the ARC-56 app spec.\n   *\n   * If no IDs are in the app spec or the network isn't recognised, an error is thrown.\n   * @param typedClient The typed client type to use\n   * @param params The params to resolve the app by network\n   * @example\n   * ```typescript\n   * const appClient = algorand.client.getTypedAppClientByNetwork(MyContractClient, {\n   *   defaultSender: alice,\n   * })\n   * ```\n   * @returns The typed client instance\n   */\n  public getTypedAppClientByNetwork<TClient extends TypedAppClient<InstanceType<TClient>>>(\n    typedClient: TClient,\n    params?: ClientTypedAppClientByNetworkParams,\n  ) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n\n    return typedClient.fromNetwork({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new typed app factory.\n   * @param typedFactory The typed factory type to use\n   * @param params The params to resolve the factory by\n   * @example\n   * ```typescript\n   * const appFactory = algorand.client.getTypedAppFactory(MyContractClient, {\n   *   sender: alice,\n   * })\n   * ```\n   * @returns The typed client instance\n   */\n  public getTypedAppFactory<TClient>(typedFactory: TypedAppFactory<TClient>, params?: ClientTypedAppFactoryParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app factory from a ClientManager without an Algorand client')\n    }\n\n    return new typedFactory({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Retrieve client configurations from environment variables when defined or get defaults (expects to be called from a Node.js environment)\n   *\n   * If both `process.env.INDEXER_SERVER` and `process.env.ALGOD_SERVER` is defined it will use both along with optional `process.env.ALGOD_PORT`, `process.env.ALGOD_TOKEN`, `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`.\n   *\n   * If only `process.env.ALGOD_SERVER` is defined it will use this along with optional `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN` and leave indexer as `undefined`.\n   *\n   * If only `process.env.INDEXER_SERVER` is defined it will use the default (LocalNet) configuration for both algod and indexer.\n   *\n   * It will return a KMD configuration that uses `process.env.KMD_PORT` (or port 4002) if `process.env.ALGOD_SERVER` is defined,\n   * otherwise it will use the default LocalNet config unless it detects testnet or mainnet.\n   * @example\n   * ```typescript\n   * const config = ClientManager.getConfigFromEnvironmentOrLocalNet()\n   * ```\n   * @returns The config for algod, indexer and kmd\n   */\n  public static getConfigFromEnvironmentOrLocalNet(): AlgoConfig {\n    if (!process || !process.env) {\n      throw new Error('Attempt to get default client configuration from a non Node.js context; supply the config instead')\n    }\n    const [algodConfig, indexerConfig, kmdConfig] = process.env.ALGOD_SERVER\n      ? [\n          ClientManager.getAlgodConfigFromEnvironment(),\n          process.env.INDEXER_SERVER ? ClientManager.getIndexerConfigFromEnvironment() : undefined,\n          !process.env.ALGOD_SERVER.includes('mainnet') && !process.env.ALGOD_SERVER.includes('testnet')\n            ? { ...ClientManager.getAlgodConfigFromEnvironment(), port: process?.env?.KMD_PORT ?? '4002' }\n            : undefined,\n        ]\n      : [\n          ClientManager.getDefaultLocalNetConfig('algod'),\n          ClientManager.getDefaultLocalNetConfig('indexer'),\n          ClientManager.getDefaultLocalNetConfig('kmd'),\n        ]\n\n    return {\n      algodConfig,\n      indexerConfig,\n      kmdConfig,\n    }\n  }\n\n  /** Retrieve the algod configuration from environment variables (expects to be called from a Node.js environment)\n   *\n   * Expects `process.env.ALGOD_SERVER` to be defined, and you can also specify `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN`.\n   */\n  public static getAlgodConfigFromEnvironment(): AlgoClientConfig {\n    if (!process || !process.env) {\n      throw new Error('Attempt to get default algod configuration from a non Node.js context; supply the config instead')\n    }\n\n    if (!process.env.ALGOD_SERVER) {\n      throw new Error('Attempt to get default algod configuration without specifying ALGOD_SERVER in the environment variables')\n    }\n\n    return {\n      server: process.env.ALGOD_SERVER,\n      port: process.env.ALGOD_PORT,\n      token: process.env.ALGOD_TOKEN,\n    }\n  }\n\n  /**\n   * Retrieve the indexer configuration from environment variables (expects to be called from a Node.js environment).\n   *\n   * Expects `process.env.INDEXER_SERVER` to be defined, and you can also specify `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`.\n   */\n  public static getIndexerConfigFromEnvironment(): AlgoClientConfig {\n    if (!process || !process.env) {\n      throw new Error('Attempt to get default indexer configuration from a non Node.js context; supply the config instead')\n    }\n\n    if (!process.env.INDEXER_SERVER) {\n      throw new Error('Attempt to get default indexer configuration without specifying INDEXER_SERVER in the environment variables')\n    }\n\n    return {\n      server: process.env.INDEXER_SERVER,\n      port: process.env.INDEXER_PORT,\n      token: process.env.INDEXER_TOKEN,\n    }\n  }\n\n  /** Returns the Algorand configuration to point to the free tier of the AlgoNode service.\n   *\n   * @param network Which network to connect to - TestNet or MainNet\n   * @param config Which algod config to return - Algod or Indexer\n   */\n  public static getAlgoNodeConfig(network: 'testnet' | 'mainnet', config: 'algod' | 'indexer'): AlgoClientConfig {\n    return {\n      server: `https://${network}-${config === 'algod' ? 'api' : 'idx'}.algonode.cloud/`,\n      port: 443,\n    }\n  }\n\n  /** Returns the Algorand configuration to point to the default LocalNet.\n   *\n   * @param configOrPort Which algod config to return - algod, kmd, or indexer OR a port number\n   */\n  public static getDefaultLocalNetConfig(configOrPort: 'algod' | 'indexer' | 'kmd' | number): AlgoClientConfig {\n    return {\n      server: `http://localhost`,\n      port: configOrPort === 'algod' ? 4001 : configOrPort === 'indexer' ? 8980 : configOrPort === 'kmd' ? 4002 : configOrPort,\n      token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n    }\n  }\n\n  /**\n   * Returns an algod SDK client that automatically retries on idempotent calls.\n   *\n   * @param config The config of the client\n   * @example AlgoNode (testnet)\n   * ```typescript\n   *  const algod = ClientManager.getAlgodClient(ClientManager.getAlgoNodeConfig('testnet', 'algod'))\n   *  await algod.healthCheck().do()\n   * ```\n   * @example AlgoNode (mainnet)\n   * ```typescript\n   *  const algod = ClientManager.getAlgodClient(ClientManager.getAlgoNodeConfig('mainnet', 'algod'))\n   *  await algod.healthCheck().do()\n   * ```\n   * @example Custom (e.g. default LocalNet)\n   * ```typescript\n   *  const algod = ClientManager.getAlgodClient({server: 'http://localhost', port: '4001', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})\n   *  await algod.healthCheck().do()\n   * ```\n   */\n  public static getAlgodClient(config: AlgoClientConfig): Algodv2 {\n    const { token, server, port } = config\n    const tokenHeader = typeof token === 'string' ? { 'X-Algo-API-Token': token } : (token ?? {})\n    const httpClientWithRetry = new AlgoHttpClientWithRetry(tokenHeader, server, port)\n    return new algosdk.Algodv2(httpClientWithRetry, server)\n  }\n\n  /**\n   * Returns an algod SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment).\n   *\n   * @example\n   *  ```typescript\n   *  // Uses process.env.ALGOD_SERVER, process.env.ALGOD_PORT and process.env.ALGOD_TOKEN\n   *  const algod = ClientManager.getAlgodClientFromEnvironment()\n   *  await algod.healthCheck().do()\n   *  ```\n   */\n  public static getAlgodClientFromEnvironment(): Algodv2 {\n    return ClientManager.getAlgodClient(ClientManager.getAlgodConfigFromEnvironment())\n  }\n\n  /**\n   * Returns an indexer SDK client that automatically retries on idempotent calls\n   *\n   * @param config The config of the client\n   * @example AlgoNode (testnet)\n   * ```typescript\n   *  const indexer = ClientManager.getIndexerClient(ClientManager.getAlgoNodeConfig('testnet', 'indexer'))\n   *  await indexer.makeHealthCheck().do()\n   * ```\n   * @example AlgoNode (mainnet)\n   * ```typescript\n   *  const indexer = ClientManager.getIndexerClient(ClientManager.getAlgoNodeConfig('mainnet', 'indexer'))\n   *  await indexer.makeHealthCheck().do()\n   * ```\n   * @example Custom (e.g. default LocalNet, although we recommend loading this into a .env and using the Default option instead)\n   * ```typescript\n   *  const indexer = ClientManager.getIndexerClient({server: 'http://localhost', port: '8980', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})\n   *  await indexer.makeHealthCheck().do()\n   * ```\n   */\n  public static getIndexerClient(config: AlgoClientConfig): Indexer {\n    const { token, server, port } = config\n    const tokenHeader = typeof token === 'string' ? { 'X-Indexer-API-Token': token } : (token ?? {})\n    const httpClientWithRetry = new AlgoHttpClientWithRetry(tokenHeader, server, port)\n    return new Indexer(httpClientWithRetry)\n  }\n\n  /**\n   * Returns an indexer SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment).\n   *\n   * @example\n   *\n   *  ```typescript\n   *  // Uses process.env.INDEXER_SERVER, process.env.INDEXER_PORT and process.env.INDEXER_TOKEN\n   *  const indexer = ClientManager.getIndexerClientFromEnvironment()\n   *  await indexer.makeHealthCheck().do()\n   *  ```\n   */\n  public static getIndexerClientFromEnvironment(): Indexer {\n    return ClientManager.getIndexerClient(ClientManager.getIndexerConfigFromEnvironment())\n  }\n\n  /**\n   * Returns a KMD SDK client.\n   *\n   * KMD client allows you to export private keys, which is useful to (for instance) get the default account in a LocalNet network.\n   *\n   * @param config The config for the client\n   * @example Custom (e.g. default LocalNet, although we recommend loading this into a .env and using the Default option instead)\n   * ```typescript\n   *  const kmd = ClientManager.getKmdClient({server: 'http://localhost', port: '4002', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})\n   * ```\n   */\n  public static getKmdClient(config: AlgoClientConfig): Kmd {\n    const { token, server, port } = config\n    return new Kmd(token as string, server, port)\n  }\n\n  /**\n   * Returns a KMD SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment).\n   *\n   * @example\n   *  ```typescript\n   *  // Uses process.env.ALGOD_SERVER, process.env.KMD_PORT (or if not specified: port 4002) and process.env.ALGOD_TOKEN\n   *  const kmd = ClientManager.getKmdClientFromEnvironment()\n   *  ```\n   */\n  public static getKmdClientFromEnvironment(): Kmd {\n    // We can only use Kmd on the LocalNet otherwise it's not exposed so this makes some assumptions\n    // (e.g. same token and server as algod and port 4002 by default)\n    return ClientManager.getKmdClient({ ...ClientManager.getAlgodConfigFromEnvironment(), port: process?.env?.KMD_PORT ?? '4002' })\n  }\n}\n\n/**\n * Interface to identify a typed client that can be used to interact with an application.\n */\nexport interface TypedAppClient<TClient> {\n  new (params: Omit<AppClientParams, 'appSpec'>): TClient\n  fromNetwork(params: Omit<AppClientParams, 'appId' | 'appSpec'>): Promise<TClient>\n  fromCreatorAndName(params: Omit<ResolveAppClientByCreatorAndName, 'appSpec'>): Promise<TClient>\n}\n\n/**\n * Interface to identify a typed factory that can be used to create and deploy an application.\n */\nexport interface TypedAppFactory<TClient> {\n  new (params: Omit<AppFactoryParams, 'appSpec'>): TClient\n}\n"],"names":["genesisIdIsLocalNet","TestNetDispenserApiClient","AppFactory","AppClient","AlgoHttpClientWithRetry"],"mappings":";;;;;;;;;AAQA,IAAO,GAAG,GAAG,OAAO,CAAC,GAAG;AACxB,IAAO,OAAO,GAAG,OAAO,CAAC,OAAO;AAqChC;MACa,aAAa,CAAA;AAMxB;;;;;;;;;;;;;;;;;;;AAmBG;IACH,WAAY,CAAA,eAA4C,EAAE,cAAwC,EAAA;AAChG,QAAA,MAAM,QAAQ,GACZ,OAAO,IAAI;AACT,cAAE;AACF,cAAE;gBACE,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC;AAChE,gBAAA,OAAO,EAAE,eAAe,CAAC,aAAa,GAAG,aAAa,CAAC,gBAAgB,CAAC,eAAe,CAAC,aAAa,CAAC,GAAG,SAAS;AAClH,gBAAA,GAAG,EAAE,eAAe,CAAC,SAAS,GAAG,aAAa,CAAC,YAAY,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,SAAS;aACnG;AACP,QAAA,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK;AAC5B,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO;AAChC,QAAA,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG;AACxB,QAAA,IAAI,CAAC,SAAS,GAAG,cAAc;;;AAIjC,IAAA,IAAW,KAAK,GAAA;QACd,OAAO,IAAI,CAAC,MAAM;;;AAIpB,IAAA,IAAW,OAAO,GAAA;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC;QACnH,OAAO,IAAI,CAAC,QAAQ;;;AAItB,IAAA,IAAW,gBAAgB,GAAA;QACzB,OAAO,IAAI,CAAC,QAAQ;;;AAItB,IAAA,IAAW,GAAG,GAAA;QACZ,IAAI,CAAC,IAAI,CAAC,IAAI;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC;QACvG,OAAO,IAAI,CAAC,IAAI;;AAIlB;;;;;;;;AAQG;AACI,IAAA,MAAM,OAAO,GAAA;AAClB,QAAA,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;AAC5B,YAAA,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC,EAAE,EAAE;;AAGnE,QAAA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB;QAC5C,OAAO;AACL,YAAA,SAAS,EAAE,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC;AAC5F,YAAA,SAAS,EAAE,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC;YAC5F,UAAU,EAAE,aAAa,CAAC,mBAAmB,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC;AAC5E,YAAA,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,SAAS;YACxC,WAAW,EAAE,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,SAAS;SACjG;;AAGH;;;;AAIG;IACI,OAAO,mBAAmB,CAAC,SAAiB,EAAA;AACjD,QAAA,OAAOA,uCAAmB,CAAC,SAAS,CAAC;;AAGvC;;;AAGG;AACI,IAAA,MAAM,UAAU,GAAA;QACrB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE,UAAU;;AAG1C;;;AAGG;AACI,IAAA,MAAM,SAAS,GAAA;QACpB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS;;AAGzC;;;AAGG;AACI,IAAA,MAAM,SAAS,GAAA;QACpB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS;;AAGzC;;;;;;;;;;;;;;;AAeG;AACI,IAAA,mBAAmB,CAAC,MAAuC,EAAA;AAChE,QAAA,OAAO,IAAIC,+CAAyB,CAAC,MAAM,CAAC;;AAG9C;;;;;;;;;;;;;;AAcG;AACI,IAAA,kCAAkC,CAAC,MAA2D,EAAA;QACnG,OAAO,IAAIA,+CAAyB,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,SAAS,CAAC;;AAGzF;;;;;;;;;;;;;;;;;;;;AAoBG;AACI,IAAA,aAAa,CAAC,MAA8B,EAAA;AACjD,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC;;AAG/F,QAAA,OAAO,IAAIC,2BAAU,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAGhE;;;;;;;;;;;;;;AAcG;AACI,IAAA,4BAA4B,CAAC,MAAoD,EAAA;AACtF,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC;;QAG9F,OAAOC,yBAAS,CAAC,kBAAkB,CAAC;AAClC,YAAA,GAAG,MAAM;YACT,QAAQ,EAAE,IAAI,CAAC,SAAS;AACzB,SAAA,CAAC;;AAGJ;;;;;;;;;;;AAWG;AACI,IAAA,gBAAgB,CAAC,MAA6B,EAAA;AACnD,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC;;AAE9F,QAAA,OAAO,IAAIA,yBAAS,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAG/D;;;;;;;;;;;;;;;AAeG;IACI,MAAM,qBAAqB,CAAC,MAAsC,EAAA;AACvE,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC;;AAE9F,QAAA,OAAOA,yBAAS,CAAC,WAAW,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAGvE;;;;;;;;;;;;;;;;;;;;AAoBG;AACI,IAAA,MAAM,iCAAiC,CAC5C,WAAoB,EACpB,MAAkD,EAAA;AAElD,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC;;AAG9F,QAAA,OAAO,WAAW,CAAC,kBAAkB,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAGhF;;;;;;;;;;;;AAYG;IACI,qBAAqB,CAC1B,WAAoB,EACpB,MAAkC,EAAA;AAElC,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC;;AAG9F,QAAA,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAGjE;;;;;;;;;;;;;;AAcG;IACI,0BAA0B,CAC/B,WAAoB,EACpB,MAA4C,EAAA;AAE5C,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC;;AAG9F,QAAA,OAAO,WAAW,CAAC,WAAW,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAGzE;;;;;;;;;;;AAWG;IACI,kBAAkB,CAAU,YAAsC,EAAE,MAAoC,EAAA;AAC7G,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC;;AAG/F,QAAA,OAAO,IAAI,YAAY,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAGlE;;;;;;;;;;;;;;;;AAgBG;AACI,IAAA,OAAO,kCAAkC,GAAA;QAC9C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CAAC,mGAAmG,CAAC;;AAEtH,QAAA,MAAM,CAAC,WAAW,EAAE,aAAa,EAAE,SAAS,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;AAC1D,cAAE;gBACE,aAAa,CAAC,6BAA6B,EAAE;AAC7C,gBAAA,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,aAAa,CAAC,+BAA+B,EAAE,GAAG,SAAS;gBACxF,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS;AAC3F,sBAAE,EAAE,GAAG,aAAa,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,IAAI,MAAM;AAC5F,sBAAE,SAAS;AACd;AACH,cAAE;AACE,gBAAA,aAAa,CAAC,wBAAwB,CAAC,OAAO,CAAC;AAC/C,gBAAA,aAAa,CAAC,wBAAwB,CAAC,SAAS,CAAC;AACjD,gBAAA,aAAa,CAAC,wBAAwB,CAAC,KAAK,CAAC;aAC9C;QAEL,OAAO;YACL,WAAW;YACX,aAAa;YACb,SAAS;SACV;;AAGH;;;AAGG;AACI,IAAA,OAAO,6BAA6B,GAAA;QACzC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC;;AAGrH,QAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE;AAC7B,YAAA,MAAM,IAAI,KAAK,CAAC,yGAAyG,CAAC;;QAG5H,OAAO;AACL,YAAA,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY;AAChC,YAAA,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU;AAC5B,YAAA,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW;SAC/B;;AAGH;;;;AAIG;AACI,IAAA,OAAO,+BAA+B,GAAA;QAC3C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CAAC,oGAAoG,CAAC;;AAGvH,QAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;AAC/B,YAAA,MAAM,IAAI,KAAK,CAAC,6GAA6G,CAAC;;QAGhI,OAAO;AACL,YAAA,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc;AAClC,YAAA,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY;AAC9B,YAAA,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa;SACjC;;AAGH;;;;AAIG;AACI,IAAA,OAAO,iBAAiB,CAAC,OAA8B,EAAE,MAA2B,EAAA;QACzF,OAAO;AACL,YAAA,MAAM,EAAE,CAAA,QAAA,EAAW,OAAO,CAAA,CAAA,EAAI,MAAM,KAAK,OAAO,GAAG,KAAK,GAAG,KAAK,CAAkB,gBAAA,CAAA;AAClF,YAAA,IAAI,EAAE,GAAG;SACV;;AAGH;;;AAGG;IACI,OAAO,wBAAwB,CAAC,YAAkD,EAAA;QACvF,OAAO;AACL,YAAA,MAAM,EAAE,CAAkB,gBAAA,CAAA;AAC1B,YAAA,IAAI,EAAE,YAAY,KAAK,OAAO,GAAG,IAAI,GAAG,YAAY,KAAK,SAAS,GAAG,IAAI,GAAG,YAAY,KAAK,KAAK,GAAG,IAAI,GAAG,YAAY;AACxH,YAAA,KAAK,EAAE,kEAAkE;SAC1E;;AAGH;;;;;;;;;;;;;;;;;;;AAmBG;IACI,OAAO,cAAc,CAAC,MAAwB,EAAA;QACnD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM;QACtC,MAAM,WAAW,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,IAAI,KAAK,IAAI,EAAE,CAAC;QAC7F,MAAM,mBAAmB,GAAG,IAAIC,qDAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC;QAClF,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC;;AAGzD;;;;;;;;;AASG;AACI,IAAA,OAAO,6BAA6B,GAAA;QACzC,OAAO,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,6BAA6B,EAAE,CAAC;;AAGpF;;;;;;;;;;;;;;;;;;;AAmBG;IACI,OAAO,gBAAgB,CAAC,MAAwB,EAAA;QACrD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM;QACtC,MAAM,WAAW,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,EAAE,qBAAqB,EAAE,KAAK,EAAE,IAAI,KAAK,IAAI,EAAE,CAAC;QAChG,MAAM,mBAAmB,GAAG,IAAIA,qDAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC;AAClF,QAAA,OAAO,IAAI,OAAO,CAAC,mBAAmB,CAAC;;AAGzC;;;;;;;;;;AAUG;AACI,IAAA,OAAO,+BAA+B,GAAA;QAC3C,OAAO,aAAa,CAAC,gBAAgB,CAAC,aAAa,CAAC,+BAA+B,EAAE,CAAC;;AAGxF;;;;;;;;;;AAUG;IACI,OAAO,YAAY,CAAC,MAAwB,EAAA;QACjD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM;QACtC,OAAO,IAAI,GAAG,CAAC,KAAe,EAAE,MAAM,EAAE,IAAI,CAAC;;AAG/C;;;;;;;;AAQG;AACI,IAAA,OAAO,2BAA2B,GAAA;;;QAGvC,OAAO,aAAa,CAAC,YAAY,CAAC,EAAE,GAAG,aAAa,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,IAAI,MAAM,EAAE,CAAC;;AAElI;;;;"}
+{"version":3,"file":"client-manager.js","sources":["../../src/types/client-manager.ts"],"sourcesContent":["import algosdk, { SuggestedParams } from 'algosdk'\nimport { AlgoHttpClientWithRetry } from './algo-http-client-with-retry'\nimport { AlgorandClientInterface } from './algorand-client-interface'\nimport { AppClient, AppClientParams, ResolveAppClientByCreatorAndName } from './app-client'\nimport { AppFactory, AppFactoryParams } from './app-factory'\nimport { TestNetDispenserApiClient, TestNetDispenserApiClientParams } from './dispenser-client'\nimport { Expand } from './expand'\nimport { AlgoClientConfig, AlgoConfig, NetworkDetails, genesisIdIsLocalNet } from './network-client'\nimport Kmd = algosdk.Kmd\nimport Indexer = algosdk.Indexer\nimport Algodv2 = algosdk.Algodv2\n\n/** Clients from algosdk that interact with the official Algorand APIs */\nexport interface AlgoSdkClients {\n  /** Algod client, see https://developer.algorand.org/docs/rest-apis/algod/ */\n  algod: algosdk.Algodv2\n  /** Optional indexer client, see https://developer.algorand.org/docs/rest-apis/indexer/ */\n  indexer?: algosdk.Indexer\n  /** Optional KMD client, see https://developer.algorand.org/docs/rest-apis/kmd/ */\n  kmd?: algosdk.Kmd\n}\n\n/** Params to get an app factory from `ClientManager`. */\nexport type ClientAppFactoryParams = Expand<Omit<AppFactoryParams, 'algorand'>>\n\n/** Params to get an app client by creator address and name from `ClientManager`. */\nexport type ClientResolveAppClientByCreatorAndNameParams = Expand<Omit<ResolveAppClientByCreatorAndName, 'algorand'>>\n\n/** Params to get an app client by ID from `ClientManager`. */\nexport type ClientAppClientParams = Expand<Omit<AppClientParams, 'algorand'>>\n\n/** Params to get an app client by network from `ClientManager`. */\nexport type ClientAppClientByNetworkParams = Expand<Omit<AppClientParams, 'algorand' | 'appId'>>\n\n/** Params to get a typed app client by creator address and name from `ClientManager`. */\nexport type ClientTypedAppClientByCreatorAndNameParams = Expand<Omit<ResolveAppClientByCreatorAndName, 'algorand' | 'appSpec'>>\n\n/** Params to get a typed app client by ID from `ClientManager`. */\nexport type ClientTypedAppClientParams = Expand<Omit<AppClientParams, 'algorand' | 'appSpec'>>\n\n/** Params to get a typed app client by network from `ClientManager`. */\nexport type ClientTypedAppClientByNetworkParams = Expand<Omit<AppClientParams, 'algorand' | 'appSpec' | 'appId'>>\n\n/** Params to get a typed app factory from `ClientManager`. */\nexport type ClientTypedAppFactoryParams = Expand<Omit<AppFactoryParams, 'algorand' | 'appSpec'>>\n\n/** Exposes access to various API clients. */\nexport class ClientManager {\n  private _algod: algosdk.Algodv2\n  private _indexer?: algosdk.Indexer\n  private _kmd?: algosdk.Kmd\n  private _algorand?: AlgorandClientInterface\n\n  /**\n   * algosdk clients or config for interacting with the official Algorand APIs.\n   * @param clientsOrConfig The clients or config to use\n   * @example Algod client only\n   * ```typescript\n   * const clientManager = new ClientManager({ algod: algodClient })\n   * ```\n   * @example All clients\n   * ```typescript\n   * const clientManager = new ClientManager({ algod: algodClient, indexer: indexerClient, kmd: kmdClient })\n   * ```\n   * @example Algod config only\n   * ```typescript\n   * const clientManager = new ClientManager({ algodConfig })\n   * ```\n   * @example All client configs\n   * ```typescript\n   * const clientManager = new ClientManager({ algodConfig, indexerConfig, kmdConfig })\n   * ```\n   */\n  constructor(clientsOrConfig: AlgoConfig | AlgoSdkClients, algorandClient?: AlgorandClientInterface) {\n    const _clients =\n      'algod' in clientsOrConfig\n        ? clientsOrConfig\n        : {\n            algod: ClientManager.getAlgodClient(clientsOrConfig.algodConfig),\n            indexer: clientsOrConfig.indexerConfig ? ClientManager.getIndexerClient(clientsOrConfig.indexerConfig) : undefined,\n            kmd: clientsOrConfig.kmdConfig ? ClientManager.getKmdClient(clientsOrConfig.kmdConfig) : undefined,\n          }\n    this._algod = _clients.algod\n    this._indexer = _clients.indexer\n    this._kmd = _clients.kmd\n    this._algorand = algorandClient\n  }\n\n  /**\n   * Returns an algosdk Algod API client.\n   * @returns The Algod client\n   */\n  public get algod(): algosdk.Algodv2 {\n    return this._algod\n  }\n\n  /**\n   * Returns an algosdk Indexer API client or throws an error if it's not been provided.\n   * @returns The Indexer client\n   * @throws Error if no Indexer client is configured\n   */\n  public get indexer(): algosdk.Indexer {\n    if (!this._indexer) throw new Error('Attempt to use Indexer client in AlgoKit instance with no Indexer configured')\n    return this._indexer\n  }\n\n  /**\n   * Returns an algosdk Indexer API client or `undefined` if it's not been provided.\n   * @returns The Indexer client or `undefined`\n   */\n  public get indexerIfPresent(): algosdk.Indexer | undefined {\n    return this._indexer\n  }\n\n  /**\n   * Returns an algosdk KMD API client or throws an error if it's not been provided.\n   * @returns The KMD client\n   * @throws Error if no KMD client is configured\n   */\n  public get kmd(): algosdk.Kmd {\n    if (!this._kmd) throw new Error('Attempt to use Kmd client in AlgoKit instance with no Kmd configured')\n    return this._kmd\n  }\n\n  private _getNetworkPromise: Promise<SuggestedParams> | undefined\n  /**\n   * Get details about the current network.\n   * @example Getting genesis ID\n   * ```typescript\n   * const network = await networkClient.network()\n   * const genesisId = network.genesisId\n   * ```\n   * @returns The current network details\n   */\n  public async network(): Promise<NetworkDetails> {\n    if (!this._getNetworkPromise) {\n      this._getNetworkPromise = this._algod.getTransactionParams().do()\n    }\n\n    const params = await this._getNetworkPromise\n    return {\n      isTestNet: ['testnet-v1.0', 'testnet-v1', 'testnet'].includes(params.genesisID ?? 'unknown'),\n      isMainNet: ['mainnet-v1.0', 'mainnet-v1', 'mainnet'].includes(params.genesisID ?? 'unknown'),\n      isLocalNet: ClientManager.genesisIdIsLocalNet(params.genesisID ?? 'unknown'),\n      genesisId: params.genesisID ?? 'unknown',\n      genesisHash: params.genesisHash ? Buffer.from(params.genesisHash).toString('base64') : 'unknown',\n    }\n  }\n\n  /**\n   * Returns true if the given network genesisId is associated with a LocalNet network.\n   * @param genesisId The network genesis ID\n   * @returns Whether the given genesis ID is associated with a LocalNet network\n   * @example\n   * ```typescript\n   * const isLocalNet = ClientManager.genesisIdIsLocalNet('testnet-v1.0')\n   * ```\n   */\n  public static genesisIdIsLocalNet(genesisId: string) {\n    return genesisIdIsLocalNet(genesisId)\n  }\n\n  /**\n   * Returns true if the current network is LocalNet.\n   * @returns True if the current network is LocalNet.\n   * @example\n   * ```typescript\n   * const isLocalNet = await clientManager.isLocalNet()\n   * ```\n   */\n  public async isLocalNet() {\n    return (await this.network()).isLocalNet\n  }\n\n  /**\n   * Returns true if the current network is TestNet.\n   * @returns True if the current network is TestNet.\n   * @example\n   * ```typescript\n   * const isTestNet = await clientManager.isTestNet()\n   * ```\n   */\n  public async isTestNet() {\n    return (await this.network()).isTestNet\n  }\n\n  /**\n   * Returns true if the current network is MainNet.\n   * @returns True if the current network is MainNet.\n   * @example\n   * ```typescript\n   * const isMainNet = await clientManager.isMainNet()\n   * ```\n   */\n  public async isMainNet() {\n    return (await this.network()).isMainNet\n  }\n\n  /**\n   * Returns a TestNet Dispenser API client.\n   *\n   * Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token.\n   *\n   * @param params An object containing parameters for the TestNetDispenserApiClient class.\n   * @example\n   * const client = clientManager.getTestNetDispenser(\n   *     {\n   *       authToken: 'your_auth_token',\n   *       requestTimeout: 15,\n   *     }\n   * )\n   *\n   * @returns An instance of the TestNetDispenserApiClient class.\n   */\n  public getTestNetDispenser(params: TestNetDispenserApiClientParams) {\n    return new TestNetDispenserApiClient(params)\n  }\n\n  /**\n   * Returns a TestNet Dispenser API client, loading the auth token from `process.env.ALGOKIT_DISPENSER_ACCESS_TOKEN`.\n   *\n   * Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token.\n   *\n   * @param params An object containing parameters for the TestNetDispenserApiClient class.\n   * @example\n   * const client = clientManager.getTestNetDispenserFromEnvironment(\n   *     {\n   *       requestTimeout: 15,\n   *     }\n   * )\n   *\n   * @returns An instance of the TestNetDispenserApiClient class.\n   */\n  public getTestNetDispenserFromEnvironment(params?: Omit<TestNetDispenserApiClientParams, 'authToken'>) {\n    return new TestNetDispenserApiClient(params ? { ...params, authToken: '' } : undefined)\n  }\n\n  /**\n   * Returns a new `AppFactory` client\n   * @param params The parameters to create the app factory\n   * @example Basic example\n   * ```typescript\n   * const factory = clientManager.getAppFactory({\n   *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\\/}',\n   * })\n   * ```\n   * @example Advanced example\n   * ```typescript\n   * const factory = clientManager.getAppFactory({\n   *   appSpec: parsedAppSpec_AppSpec_or_Arc56Contract,\n   *   defaultSender: \"SENDERADDRESS\",\n   *   appName: \"OverriddenAppName\",\n   *   version: \"2.0.0\",\n   *   updatable: true,\n   *   deletable: false,\n   *   deployTimeParams: { ONE: 1, TWO: 'value' }\n   * })\n   * ```\n   * @returns The `AppFactory` instance\n   */\n  public getAppFactory(params: ClientAppFactoryParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app factory from a ClientManager without an Algorand client')\n    }\n\n    return new AppFactory({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new `AppClient` client for managing calls and state for an ARC-32/ARC-56 app.\n   * This method resolves the app ID by looking up the creator address and name\n   * using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note).\n   * @param params The parameters to create the app client\n   * @example Basic\n   * ```typescript\n   * const appClient = clientManager.getAppClientByCreatorAndName({\n   *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\\}',\n   *   // appId resolved by looking for app ID of named app by this creator\n   *   creatorAddress: 'CREATORADDRESS',\n   * })\n   * ```\n   * @returns The `AppClient` instance\n   */\n  public getAppClientByCreatorAndName(params: ClientResolveAppClientByCreatorAndNameParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n\n    return AppClient.fromCreatorAndName({\n      ...params,\n      algorand: this._algorand,\n    })\n  }\n\n  /**\n   * Returns a new `AppClient` client for managing calls and state for an ARC-32/ARC-56 app.\n   * @param params The parameters to create the app client\n   * @example Basic\n   * ```typescript\n   * const appClient = clientManager.getAppClientById({\n   *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\\}',\n   *   appId: 12345n,\n   * })\n   * ```\n   * @returns The `AppClient` instance\n   */\n  public getAppClientById(params: ClientAppClientParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n    return new AppClient({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new `AppClient` client for managing calls and state for an ARC-56 app.\n   * This method resolves the app ID for the current network based on\n   * pre-determined network-specific app IDs specified in the ARC-56 app spec.\n   *\n   * If no IDs are in the app spec or the network isn't recognised, an error is thrown.\n   * @param params The parameters to create the app client\n   * @example Basic\n   * ```typescript\n   * const appClient = clientManager.getAppClientByNetwork({\n   *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\\}',\n   *   // appId resolved by using ARC-56 spec to find app ID for current network\n   * })\n   * ```\n   * @returns The `AppClient` instance\n   */\n  public async getAppClientByNetwork(params: ClientAppClientByNetworkParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n    return AppClient.fromNetwork({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new typed client, resolving the app by creator address and name.\n   * @param typedClient The typed client type to use\n   * @param params The params to resolve the app by creator address and name\n   * @example Use name in ARC-32 / ARC-56 app spec\n   * ```typescript\n   * const appClient = clientManager.getTypedAppClientByCreatorAndName(MyContractClient, {\n   *   creatorAddress: \"CREATORADDRESS\",\n   *   defaultSender: alice,\n   * })\n   * ```\n   * @example Specify name\n   * ```typescript\n   * const appClient = clientManager.getTypedAppClientByCreatorAndName(MyContractClient, {\n   *   creatorAddress: \"CREATORADDRESS\",\n   *   name: \"contract-name\",\n   *   defaultSender: alice,\n   * })\n   * ```\n   * @returns The typed client instance\n   */\n  public async getTypedAppClientByCreatorAndName<TClient extends TypedAppClient<InstanceType<TClient>>>(\n    typedClient: TClient,\n    params: ClientTypedAppClientByCreatorAndNameParams,\n  ) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n\n    return typedClient.fromCreatorAndName({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new typed client, resolving the app by app ID.\n   * @param typedClient The typed client type to use\n   * @param params The params to resolve the app by ID\n   * @example\n   * ```typescript\n   * const appClient = clientManager.getTypedAppClientById(MyContractClient, {\n   *   appId: 12345n,\n   *   defaultSender: alice,\n   * })\n   * ```\n   * @returns The typed client instance\n   */\n  public getTypedAppClientById<TClient extends TypedAppClient<InstanceType<TClient>>>(\n    typedClient: TClient,\n    params: ClientTypedAppClientParams,\n  ) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n\n    return new typedClient({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new typed client, resolves the app ID for the current network based on\n   * pre-determined network-specific app IDs specified in the ARC-56 app spec.\n   *\n   * If no IDs are in the app spec or the network isn't recognised, an error is thrown.\n   * @param typedClient The typed client type to use\n   * @param params The params to resolve the app by network\n   * @example\n   * ```typescript\n   * const appClient = clientManager.getTypedAppClientByNetwork(MyContractClient, {\n   *   defaultSender: alice,\n   * })\n   * ```\n   * @returns The typed client instance\n   */\n  public getTypedAppClientByNetwork<TClient extends TypedAppClient<InstanceType<TClient>>>(\n    typedClient: TClient,\n    params?: ClientTypedAppClientByNetworkParams,\n  ) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app client from a ClientManager without an Algorand client')\n    }\n\n    return typedClient.fromNetwork({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Returns a new typed app factory.\n   * @param typedFactory The typed factory type to use\n   * @param params The params to resolve the factory by\n   * @example\n   * ```typescript\n   * const appFactory = clientManager.getTypedAppFactory(MyContractClient, {\n   *   sender: alice,\n   * })\n   * ```\n   * @returns The typed client instance\n   */\n  public getTypedAppFactory<TClient>(typedFactory: TypedAppFactory<TClient>, params?: ClientTypedAppFactoryParams) {\n    if (!this._algorand) {\n      throw new Error('Attempt to get app factory from a ClientManager without an Algorand client')\n    }\n\n    return new typedFactory({ ...params, algorand: this._algorand })\n  }\n\n  /**\n   * Retrieve client configurations from environment variables when defined or get defaults (expects to be called from a Node.js environment)\n   *\n   * If both `process.env.INDEXER_SERVER` and `process.env.ALGOD_SERVER` is defined it will use both along with optional `process.env.ALGOD_PORT`, `process.env.ALGOD_TOKEN`, `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`.\n   *\n   * If only `process.env.ALGOD_SERVER` is defined it will use this along with optional `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN` and leave indexer as `undefined`.\n   *\n   * If only `process.env.INDEXER_SERVER` is defined it will use the default (LocalNet) configuration for both algod and indexer.\n   *\n   * It will return a KMD configuration that uses `process.env.KMD_PORT` (or port 4002) if `process.env.ALGOD_SERVER` is defined,\n   * otherwise it will use the default LocalNet config unless it detects testnet or mainnet.\n   * @example\n   * ```typescript\n   * const config = ClientManager.getConfigFromEnvironmentOrLocalNet()\n   * ```\n   * @returns The config for algod, indexer and kmd\n   */\n  public static getConfigFromEnvironmentOrLocalNet(): AlgoConfig {\n    if (!process || !process.env) {\n      throw new Error('Attempt to get default client configuration from a non Node.js context; supply the config instead')\n    }\n    const [algodConfig, indexerConfig, kmdConfig] = process.env.ALGOD_SERVER\n      ? [\n          ClientManager.getAlgodConfigFromEnvironment(),\n          process.env.INDEXER_SERVER ? ClientManager.getIndexerConfigFromEnvironment() : undefined,\n          !process.env.ALGOD_SERVER.includes('mainnet') && !process.env.ALGOD_SERVER.includes('testnet')\n            ? { ...ClientManager.getAlgodConfigFromEnvironment(), port: process?.env?.KMD_PORT ?? '4002' }\n            : undefined,\n        ]\n      : [\n          ClientManager.getDefaultLocalNetConfig('algod'),\n          ClientManager.getDefaultLocalNetConfig('indexer'),\n          ClientManager.getDefaultLocalNetConfig('kmd'),\n        ]\n\n    return {\n      algodConfig,\n      indexerConfig,\n      kmdConfig,\n    }\n  }\n\n  /**\n   * Retrieve the algod configuration from environment variables (expects to be called from a Node.js environment)\n   *\n   * Expects `process.env.ALGOD_SERVER` to be defined, and you can also specify `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN`.\n   * @returns The Algod client configuration\n   * @throws Error if `process.env.ALGOD_SERVER` is not defined\n   * @example\n   * ```typescript\n   * const config = ClientManager.getAlgodConfigFromEnvironment()\n   * ```\n   */\n  public static getAlgodConfigFromEnvironment(): AlgoClientConfig {\n    if (!process || !process.env) {\n      throw new Error('Attempt to get default algod configuration from a non Node.js context; supply the config instead')\n    }\n\n    if (!process.env.ALGOD_SERVER) {\n      throw new Error('Attempt to get default algod configuration without specifying ALGOD_SERVER in the environment variables')\n    }\n\n    return {\n      server: process.env.ALGOD_SERVER,\n      port: process.env.ALGOD_PORT,\n      token: process.env.ALGOD_TOKEN,\n    }\n  }\n\n  /**\n   * Retrieve the indexer configuration from environment variables (expects to be called from a Node.js environment).\n   *\n   * Expects `process.env.INDEXER_SERVER` to be defined, and you can also specify `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`.\n   * @returns The Indexer client configuration\n   * @throws Error if `process.env.INDEXER_SERVER` is not defined\n   * @example\n   * ```typescript\n   * const config = ClientManager.getIndexerConfigFromEnvironment()\n   * ```\n   */\n  public static getIndexerConfigFromEnvironment(): AlgoClientConfig {\n    if (!process || !process.env) {\n      throw new Error('Attempt to get default indexer configuration from a non Node.js context; supply the config instead')\n    }\n\n    if (!process.env.INDEXER_SERVER) {\n      throw new Error('Attempt to get default indexer configuration without specifying INDEXER_SERVER in the environment variables')\n    }\n\n    return {\n      server: process.env.INDEXER_SERVER,\n      port: process.env.INDEXER_PORT,\n      token: process.env.INDEXER_TOKEN,\n    }\n  }\n\n  /** Returns the Algorand configuration to point to the free tier of the AlgoNode service.\n   *\n   * @param network Which network to connect to - TestNet or MainNet\n   * @param config Which algod config to return - Algod or Indexer\n   * @returns The AlgoNode client configuration\n   * @example\n   * ```typescript\n   * const config = ClientManager.getAlgoNodeConfig('testnet', 'algod')\n   * ```\n   */\n  public static getAlgoNodeConfig(network: 'testnet' | 'mainnet', config: 'algod' | 'indexer'): AlgoClientConfig {\n    return {\n      server: `https://${network}-${config === 'algod' ? 'api' : 'idx'}.algonode.cloud/`,\n      port: 443,\n    }\n  }\n\n  /** Returns the Algorand configuration to point to the default LocalNet.\n   *\n   * @param configOrPort Which algod config to return - algod, kmd, or indexer OR a port number\n   * @returns The LocalNet client configuration\n   * @example\n   * ```typescript\n   * const config = ClientManager.getDefaultLocalNetConfig('algod')\n   * ```\n   */\n  public static getDefaultLocalNetConfig(configOrPort: 'algod' | 'indexer' | 'kmd' | number): AlgoClientConfig {\n    return {\n      server: `http://localhost`,\n      port: configOrPort === 'algod' ? 4001 : configOrPort === 'indexer' ? 8980 : configOrPort === 'kmd' ? 4002 : configOrPort,\n      token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',\n    }\n  }\n\n  /**\n   * Returns an algod SDK client that automatically retries on idempotent calls.\n   *\n   * @param config The config of the client\n   * @returns The Algod client\n   * @example AlgoNode (testnet)\n   * ```typescript\n   *  const algod = ClientManager.getAlgodClient(ClientManager.getAlgoNodeConfig('testnet', 'algod'))\n   *  await algod.healthCheck().do()\n   * ```\n   * @example AlgoNode (mainnet)\n   * ```typescript\n   *  const algod = ClientManager.getAlgodClient(ClientManager.getAlgoNodeConfig('mainnet', 'algod'))\n   *  await algod.healthCheck().do()\n   * ```\n   * @example Custom (e.g. default LocalNet)\n   * ```typescript\n   *  const algod = ClientManager.getAlgodClient({server: 'http://localhost', port: '4001', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})\n   *  await algod.healthCheck().do()\n   * ```\n   */\n  public static getAlgodClient(config: AlgoClientConfig): Algodv2 {\n    const { token, server, port } = config\n    const tokenHeader = typeof token === 'string' ? { 'X-Algo-API-Token': token } : (token ?? {})\n    const httpClientWithRetry = new AlgoHttpClientWithRetry(tokenHeader, server, port)\n    return new algosdk.Algodv2(httpClientWithRetry, server)\n  }\n\n  /**\n   * Returns an algod SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment).\n   *\n   * @returns The Algod client\n   * @example\n   *  ```typescript\n   *  // Uses process.env.ALGOD_SERVER, process.env.ALGOD_PORT and process.env.ALGOD_TOKEN\n   *  const algod = ClientManager.getAlgodClientFromEnvironment()\n   *  await algod.healthCheck().do()\n   *  ```\n   */\n  public static getAlgodClientFromEnvironment(): Algodv2 {\n    return ClientManager.getAlgodClient(ClientManager.getAlgodConfigFromEnvironment())\n  }\n\n  /**\n   * Returns an indexer SDK client that automatically retries on idempotent calls\n   *\n   * @param config The config of the client\n   * @returns The Indexer client\n   * @example AlgoNode (testnet)\n   * ```typescript\n   *  const indexer = ClientManager.getIndexerClient(ClientManager.getAlgoNodeConfig('testnet', 'indexer'))\n   *  await indexer.makeHealthCheck().do()\n   * ```\n   * @example AlgoNode (mainnet)\n   * ```typescript\n   *  const indexer = ClientManager.getIndexerClient(ClientManager.getAlgoNodeConfig('mainnet', 'indexer'))\n   *  await indexer.makeHealthCheck().do()\n   * ```\n   * @example Custom (e.g. default LocalNet, although we recommend loading this into a .env and using the Default option instead)\n   * ```typescript\n   *  const indexer = ClientManager.getIndexerClient({server: 'http://localhost', port: '8980', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})\n   *  await indexer.makeHealthCheck().do()\n   * ```\n   */\n  public static getIndexerClient(config: AlgoClientConfig): Indexer {\n    const { token, server, port } = config\n    const tokenHeader = typeof token === 'string' ? { 'X-Indexer-API-Token': token } : (token ?? {})\n    const httpClientWithRetry = new AlgoHttpClientWithRetry(tokenHeader, server, port)\n    return new Indexer(httpClientWithRetry)\n  }\n\n  /**\n   * Returns an indexer SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment).\n   *\n   * @returns The Indexer client\n   * @example\n   *\n   *  ```typescript\n   *  // Uses process.env.INDEXER_SERVER, process.env.INDEXER_PORT and process.env.INDEXER_TOKEN\n   *  const indexer = ClientManager.getIndexerClientFromEnvironment()\n   *  await indexer.makeHealthCheck().do()\n   *  ```\n   */\n  public static getIndexerClientFromEnvironment(): Indexer {\n    return ClientManager.getIndexerClient(ClientManager.getIndexerConfigFromEnvironment())\n  }\n\n  /**\n   * Returns a KMD SDK client.\n   *\n   * KMD client allows you to export private keys, which is useful to (for instance) get the default account in a LocalNet network.\n   *\n   * @param config The config for the client\n   * @returns The KMD client\n   * @example Custom (e.g. default LocalNet, although we recommend loading this into a .env and using the Default option instead)\n   * ```typescript\n   *  const kmd = ClientManager.getKmdClient({server: 'http://localhost', port: '4002', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})\n   * ```\n   */\n  public static getKmdClient(config: AlgoClientConfig): Kmd {\n    const { token, server, port } = config\n    return new Kmd(token as string, server, port)\n  }\n\n  /**\n   * Returns a KMD SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment).\n   *\n   * @returns The KMD client\n   * @example\n   *  ```typescript\n   *  // Uses process.env.ALGOD_SERVER, process.env.KMD_PORT (or if not specified: port 4002) and process.env.ALGOD_TOKEN\n   *  const kmd = ClientManager.getKmdClientFromEnvironment()\n   *  ```\n   */\n  public static getKmdClientFromEnvironment(): Kmd {\n    // We can only use Kmd on the LocalNet otherwise it's not exposed so this makes some assumptions\n    // (e.g. same token and server as algod and port 4002 by default)\n    return ClientManager.getKmdClient({ ...ClientManager.getAlgodConfigFromEnvironment(), port: process?.env?.KMD_PORT ?? '4002' })\n  }\n}\n\n/**\n * Interface to identify a typed client that can be used to interact with an application.\n */\nexport interface TypedAppClient<TClient> {\n  new (params: Omit<AppClientParams, 'appSpec'>): TClient\n  fromNetwork(params: Omit<AppClientParams, 'appId' | 'appSpec'>): Promise<TClient>\n  fromCreatorAndName(params: Omit<ResolveAppClientByCreatorAndName, 'appSpec'>): Promise<TClient>\n}\n\n/**\n * Interface to identify a typed factory that can be used to create and deploy an application.\n */\nexport interface TypedAppFactory<TClient> {\n  new (params: Omit<AppFactoryParams, 'appSpec'>): TClient\n}\n"],"names":["genesisIdIsLocalNet","TestNetDispenserApiClient","AppFactory","AppClient","AlgoHttpClientWithRetry"],"mappings":";;;;;;;;;AAQA,IAAO,GAAG,GAAG,OAAO,CAAC,GAAG;AACxB,IAAO,OAAO,GAAG,OAAO,CAAC,OAAO;AAqChC;MACa,aAAa,CAAA;AAMxB;;;;;;;;;;;;;;;;;;;AAmBG;IACH,WAAY,CAAA,eAA4C,EAAE,cAAwC,EAAA;AAChG,QAAA,MAAM,QAAQ,GACZ,OAAO,IAAI;AACT,cAAE;AACF,cAAE;gBACE,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC;AAChE,gBAAA,OAAO,EAAE,eAAe,CAAC,aAAa,GAAG,aAAa,CAAC,gBAAgB,CAAC,eAAe,CAAC,aAAa,CAAC,GAAG,SAAS;AAClH,gBAAA,GAAG,EAAE,eAAe,CAAC,SAAS,GAAG,aAAa,CAAC,YAAY,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,SAAS;aACnG;AACP,QAAA,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,KAAK;AAC5B,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO;AAChC,QAAA,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG;AACxB,QAAA,IAAI,CAAC,SAAS,GAAG,cAAc;;AAGjC;;;AAGG;AACH,IAAA,IAAW,KAAK,GAAA;QACd,OAAO,IAAI,CAAC,MAAM;;AAGpB;;;;AAIG;AACH,IAAA,IAAW,OAAO,GAAA;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC;QACnH,OAAO,IAAI,CAAC,QAAQ;;AAGtB;;;AAGG;AACH,IAAA,IAAW,gBAAgB,GAAA;QACzB,OAAO,IAAI,CAAC,QAAQ;;AAGtB;;;;AAIG;AACH,IAAA,IAAW,GAAG,GAAA;QACZ,IAAI,CAAC,IAAI,CAAC,IAAI;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC;QACvG,OAAO,IAAI,CAAC,IAAI;;AAIlB;;;;;;;;AAQG;AACI,IAAA,MAAM,OAAO,GAAA;AAClB,QAAA,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;AAC5B,YAAA,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC,EAAE,EAAE;;AAGnE,QAAA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB;QAC5C,OAAO;AACL,YAAA,SAAS,EAAE,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC;AAC5F,YAAA,SAAS,EAAE,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC;YAC5F,UAAU,EAAE,aAAa,CAAC,mBAAmB,CAAC,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC;AAC5E,YAAA,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,SAAS;YACxC,WAAW,EAAE,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,SAAS;SACjG;;AAGH;;;;;;;;AAQG;IACI,OAAO,mBAAmB,CAAC,SAAiB,EAAA;AACjD,QAAA,OAAOA,uCAAmB,CAAC,SAAS,CAAC;;AAGvC;;;;;;;AAOG;AACI,IAAA,MAAM,UAAU,GAAA;QACrB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE,UAAU;;AAG1C;;;;;;;AAOG;AACI,IAAA,MAAM,SAAS,GAAA;QACpB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS;;AAGzC;;;;;;;AAOG;AACI,IAAA,MAAM,SAAS,GAAA;QACpB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS;;AAGzC;;;;;;;;;;;;;;;AAeG;AACI,IAAA,mBAAmB,CAAC,MAAuC,EAAA;AAChE,QAAA,OAAO,IAAIC,+CAAyB,CAAC,MAAM,CAAC;;AAG9C;;;;;;;;;;;;;;AAcG;AACI,IAAA,kCAAkC,CAAC,MAA2D,EAAA;QACnG,OAAO,IAAIA,+CAAyB,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,SAAS,CAAC;;AAGzF;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,IAAA,aAAa,CAAC,MAA8B,EAAA;AACjD,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC;;AAG/F,QAAA,OAAO,IAAIC,2BAAU,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAGhE;;;;;;;;;;;;;;AAcG;AACI,IAAA,4BAA4B,CAAC,MAAoD,EAAA;AACtF,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC;;QAG9F,OAAOC,yBAAS,CAAC,kBAAkB,CAAC;AAClC,YAAA,GAAG,MAAM;YACT,QAAQ,EAAE,IAAI,CAAC,SAAS;AACzB,SAAA,CAAC;;AAGJ;;;;;;;;;;;AAWG;AACI,IAAA,gBAAgB,CAAC,MAA6B,EAAA;AACnD,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC;;AAE9F,QAAA,OAAO,IAAIA,yBAAS,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAG/D;;;;;;;;;;;;;;;AAeG;IACI,MAAM,qBAAqB,CAAC,MAAsC,EAAA;AACvE,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC;;AAE9F,QAAA,OAAOA,yBAAS,CAAC,WAAW,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAGvE;;;;;;;;;;;;;;;;;;;;AAoBG;AACI,IAAA,MAAM,iCAAiC,CAC5C,WAAoB,EACpB,MAAkD,EAAA;AAElD,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC;;AAG9F,QAAA,OAAO,WAAW,CAAC,kBAAkB,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAGhF;;;;;;;;;;;;AAYG;IACI,qBAAqB,CAC1B,WAAoB,EACpB,MAAkC,EAAA;AAElC,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC;;AAG9F,QAAA,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAGjE;;;;;;;;;;;;;;AAcG;IACI,0BAA0B,CAC/B,WAAoB,EACpB,MAA4C,EAAA;AAE5C,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC;;AAG9F,QAAA,OAAO,WAAW,CAAC,WAAW,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAGzE;;;;;;;;;;;AAWG;IACI,kBAAkB,CAAU,YAAsC,EAAE,MAAoC,EAAA;AAC7G,QAAA,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;AACnB,YAAA,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC;;AAG/F,QAAA,OAAO,IAAI,YAAY,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;;AAGlE;;;;;;;;;;;;;;;;AAgBG;AACI,IAAA,OAAO,kCAAkC,GAAA;QAC9C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CAAC,mGAAmG,CAAC;;AAEtH,QAAA,MAAM,CAAC,WAAW,EAAE,aAAa,EAAE,SAAS,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;AAC1D,cAAE;gBACE,aAAa,CAAC,6BAA6B,EAAE;AAC7C,gBAAA,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,aAAa,CAAC,+BAA+B,EAAE,GAAG,SAAS;gBACxF,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS;AAC3F,sBAAE,EAAE,GAAG,aAAa,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,IAAI,MAAM;AAC5F,sBAAE,SAAS;AACd;AACH,cAAE;AACE,gBAAA,aAAa,CAAC,wBAAwB,CAAC,OAAO,CAAC;AAC/C,gBAAA,aAAa,CAAC,wBAAwB,CAAC,SAAS,CAAC;AACjD,gBAAA,aAAa,CAAC,wBAAwB,CAAC,KAAK,CAAC;aAC9C;QAEL,OAAO;YACL,WAAW;YACX,aAAa;YACb,SAAS;SACV;;AAGH;;;;;;;;;;AAUG;AACI,IAAA,OAAO,6BAA6B,GAAA;QACzC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC;;AAGrH,QAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE;AAC7B,YAAA,MAAM,IAAI,KAAK,CAAC,yGAAyG,CAAC;;QAG5H,OAAO;AACL,YAAA,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY;AAChC,YAAA,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU;AAC5B,YAAA,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW;SAC/B;;AAGH;;;;;;;;;;AAUG;AACI,IAAA,OAAO,+BAA+B,GAAA;QAC3C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;AAC5B,YAAA,MAAM,IAAI,KAAK,CAAC,oGAAoG,CAAC;;AAGvH,QAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;AAC/B,YAAA,MAAM,IAAI,KAAK,CAAC,6GAA6G,CAAC;;QAGhI,OAAO;AACL,YAAA,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc;AAClC,YAAA,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY;AAC9B,YAAA,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa;SACjC;;AAGH;;;;;;;;;AASG;AACI,IAAA,OAAO,iBAAiB,CAAC,OAA8B,EAAE,MAA2B,EAAA;QACzF,OAAO;AACL,YAAA,MAAM,EAAE,CAAA,QAAA,EAAW,OAAO,CAAA,CAAA,EAAI,MAAM,KAAK,OAAO,GAAG,KAAK,GAAG,KAAK,CAAkB,gBAAA,CAAA;AAClF,YAAA,IAAI,EAAE,GAAG;SACV;;AAGH;;;;;;;;AAQG;IACI,OAAO,wBAAwB,CAAC,YAAkD,EAAA;QACvF,OAAO;AACL,YAAA,MAAM,EAAE,CAAkB,gBAAA,CAAA;AAC1B,YAAA,IAAI,EAAE,YAAY,KAAK,OAAO,GAAG,IAAI,GAAG,YAAY,KAAK,SAAS,GAAG,IAAI,GAAG,YAAY,KAAK,KAAK,GAAG,IAAI,GAAG,YAAY;AACxH,YAAA,KAAK,EAAE,kEAAkE;SAC1E;;AAGH;;;;;;;;;;;;;;;;;;;;AAoBG;IACI,OAAO,cAAc,CAAC,MAAwB,EAAA;QACnD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM;QACtC,MAAM,WAAW,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,EAAE,kBAAkB,EAAE,KAAK,EAAE,IAAI,KAAK,IAAI,EAAE,CAAC;QAC7F,MAAM,mBAAmB,GAAG,IAAIC,qDAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC;QAClF,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC;;AAGzD;;;;;;;;;;AAUG;AACI,IAAA,OAAO,6BAA6B,GAAA;QACzC,OAAO,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,6BAA6B,EAAE,CAAC;;AAGpF;;;;;;;;;;;;;;;;;;;;AAoBG;IACI,OAAO,gBAAgB,CAAC,MAAwB,EAAA;QACrD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM;QACtC,MAAM,WAAW,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,EAAE,qBAAqB,EAAE,KAAK,EAAE,IAAI,KAAK,IAAI,EAAE,CAAC;QAChG,MAAM,mBAAmB,GAAG,IAAIA,qDAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC;AAClF,QAAA,OAAO,IAAI,OAAO,CAAC,mBAAmB,CAAC;;AAGzC;;;;;;;;;;;AAWG;AACI,IAAA,OAAO,+BAA+B,GAAA;QAC3C,OAAO,aAAa,CAAC,gBAAgB,CAAC,aAAa,CAAC,+BAA+B,EAAE,CAAC;;AAGxF;;;;;;;;;;;AAWG;IACI,OAAO,YAAY,CAAC,MAAwB,EAAA;QACjD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM;QACtC,OAAO,IAAI,GAAG,CAAC,KAAe,EAAE,MAAM,EAAE,IAAI,CAAC;;AAG/C;;;;;;;;;AASG;AACI,IAAA,OAAO,2BAA2B,GAAA;;;QAGvC,OAAO,aAAa,CAAC,YAAY,CAAC,EAAE,GAAG,aAAa,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,IAAI,MAAM,EAAE,CAAC;;AAElI;;;;"}

package/types/client-manager.mjs

@@ -42,21 +42,35 @@ class ClientManager {
         this._kmd = _clients.kmd;
         this._algorand = algorandClient;
     }
-    /** Returns an algosdk Algod API client. */
+    /**
+     * Returns an algosdk Algod API client.
+     * @returns The Algod client
+     */
     get algod() {
         return this._algod;
     }
-    /** Returns an algosdk Indexer API client or throws an error if it's not been provided. */
+    /**
+     * Returns an algosdk Indexer API client or throws an error if it's not been provided.
+     * @returns The Indexer client
+     * @throws Error if no Indexer client is configured
+     */
     get indexer() {
         if (!this._indexer)
             throw new Error('Attempt to use Indexer client in AlgoKit instance with no Indexer configured');
         return this._indexer;
     }
-    /** Returns an algosdk Indexer API client or `undefined` if it's not been provided. */
+    /**
+     * Returns an algosdk Indexer API client or `undefined` if it's not been provided.
+     * @returns The Indexer client or `undefined`
+     */
     get indexerIfPresent() {
         return this._indexer;
     }
-    /** Returns an algosdk KMD API client or throws an error if it's not been provided. */
+    /**
+     * Returns an algosdk KMD API client or throws an error if it's not been provided.
+     * @returns The KMD client
+     * @throws Error if no KMD client is configured
+     */
     get kmd() {
         if (!this._kmd)
             throw new Error('Attempt to use Kmd client in AlgoKit instance with no Kmd configured');
@@ -88,6 +102,10 @@ class ClientManager {
      * Returns true if the given network genesisId is associated with a LocalNet network.
      * @param genesisId The network genesis ID
      * @returns Whether the given genesis ID is associated with a LocalNet network
+     * @example
+     * ```typescript
+     * const isLocalNet = ClientManager.genesisIdIsLocalNet('testnet-v1.0')
+     * ```
      */
     static genesisIdIsLocalNet(genesisId) {
         return genesisIdIsLocalNet(genesisId);
@@ -95,6 +113,10 @@ class ClientManager {
     /**
      * Returns true if the current network is LocalNet.
      * @returns True if the current network is LocalNet.
+     * @example
+     * ```typescript
+     * const isLocalNet = await clientManager.isLocalNet()
+     * ```
      */
     async isLocalNet() {
         return (await this.network()).isLocalNet;
@@ -102,6 +124,10 @@ class ClientManager {
     /**
      * Returns true if the current network is TestNet.
      * @returns True if the current network is TestNet.
+     * @example
+     * ```typescript
+     * const isTestNet = await clientManager.isTestNet()
+     * ```
      */
     async isTestNet() {
         return (await this.network()).isTestNet;
@@ -109,6 +135,10 @@ class ClientManager {
     /**
      * Returns true if the current network is MainNet.
      * @returns True if the current network is MainNet.
+     * @example
+     * ```typescript
+     * const isMainNet = await clientManager.isMainNet()
+     * ```
      */
     async isMainNet() {
         return (await this.network()).isMainNet;
@@ -152,15 +182,16 @@ class ClientManager {
     }
     /**
      * Returns a new `AppFactory` client
+     * @param params The parameters to create the app factory
      * @example Basic example
      * ```typescript
-     * const factory = algorand.client.getAppFactory({
+     * const factory = clientManager.getAppFactory({
      *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\/}',
      * })
      * ```
      * @example Advanced example
      * ```typescript
-     * const factory = algorand.client.getAppFactory({
+     * const factory = clientManager.getAppFactory({
      *   appSpec: parsedAppSpec_AppSpec_or_Arc56Contract,
      *   defaultSender: "SENDERADDRESS",
      *   appName: "OverriddenAppName",
@@ -170,6 +201,7 @@ class ClientManager {
      *   deployTimeParams: { ONE: 1, TWO: 'value' }
      * })
      * ```
+     * @returns The `AppFactory` instance
      */
     getAppFactory(params) {
         if (!this._algorand) {
@@ -184,13 +216,13 @@ class ClientManager {
      * @param params The parameters to create the app client
      * @example Basic
      * ```typescript
-     * const appClient = algorand.client.getAppClientByCreatorAndName({
+     * const appClient = clientManager.getAppClientByCreatorAndName({
      *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\}',
      *   // appId resolved by looking for app ID of named app by this creator
      *   creatorAddress: 'CREATORADDRESS',
      * })
      * ```
-     * @returns The `AppClient`
+     * @returns The `AppClient` instance
      */
     getAppClientByCreatorAndName(params) {
         if (!this._algorand) {
@@ -206,12 +238,12 @@ class ClientManager {
      * @param params The parameters to create the app client
      * @example Basic
      * ```typescript
-     * const appClient = algorand.client.getAppClientById({
+     * const appClient = clientManager.getAppClientById({
      *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\}',
      *   appId: 12345n,
      * })
      * ```
-     * @returns The `AppClient`
+     * @returns The `AppClient` instance
      */
     getAppClientById(params) {
         if (!this._algorand) {
@@ -228,12 +260,12 @@ class ClientManager {
      * @param params The parameters to create the app client
      * @example Basic
      * ```typescript
-     * const appClient = algorand.client.getAppClientByNetwork({
+     * const appClient = clientManager.getAppClientByNetwork({
      *   appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\}',
      *   // appId resolved by using ARC-56 spec to find app ID for current network
      * })
      * ```
-     * @returns The `AppClient`
+     * @returns The `AppClient` instance
      */
     async getAppClientByNetwork(params) {
         if (!this._algorand) {
@@ -247,14 +279,14 @@ class ClientManager {
      * @param params The params to resolve the app by creator address and name
      * @example Use name in ARC-32 / ARC-56 app spec
      * ```typescript
-     * const appClient = algorand.client.getTypedAppClientByCreatorAndName(MyContractClient, {
+     * const appClient = clientManager.getTypedAppClientByCreatorAndName(MyContractClient, {
      *   creatorAddress: "CREATORADDRESS",
      *   defaultSender: alice,
      * })
      * ```
      * @example Specify name
      * ```typescript
-     * const appClient = algorand.client.getTypedAppClientByCreatorAndName(MyContractClient, {
+     * const appClient = clientManager.getTypedAppClientByCreatorAndName(MyContractClient, {
      *   creatorAddress: "CREATORADDRESS",
      *   name: "contract-name",
      *   defaultSender: alice,
@@ -274,7 +306,7 @@ class ClientManager {
      * @param params The params to resolve the app by ID
      * @example
      * ```typescript
-     * const appClient = algorand.client.getTypedAppClientById(MyContractClient, {
+     * const appClient = clientManager.getTypedAppClientById(MyContractClient, {
      *   appId: 12345n,
      *   defaultSender: alice,
      * })
@@ -296,7 +328,7 @@ class ClientManager {
      * @param params The params to resolve the app by network
      * @example
      * ```typescript
-     * const appClient = algorand.client.getTypedAppClientByNetwork(MyContractClient, {
+     * const appClient = clientManager.getTypedAppClientByNetwork(MyContractClient, {
      *   defaultSender: alice,
      * })
      * ```
@@ -314,7 +346,7 @@ class ClientManager {
      * @param params The params to resolve the factory by
      * @example
      * ```typescript
-     * const appFactory = algorand.client.getTypedAppFactory(MyContractClient, {
+     * const appFactory = clientManager.getTypedAppFactory(MyContractClient, {
      *   sender: alice,
      * })
      * ```
@@ -366,9 +398,16 @@ class ClientManager {
             kmdConfig,
         };
     }
-    /** Retrieve the algod configuration from environment variables (expects to be called from a Node.js environment)
+    /**
+     * Retrieve the algod configuration from environment variables (expects to be called from a Node.js environment)
      *
      * Expects `process.env.ALGOD_SERVER` to be defined, and you can also specify `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN`.
+     * @returns The Algod client configuration
+     * @throws Error if `process.env.ALGOD_SERVER` is not defined
+     * @example
+     * ```typescript
+     * const config = ClientManager.getAlgodConfigFromEnvironment()
+     * ```
      */
     static getAlgodConfigFromEnvironment() {
         if (!process || !process.env) {
@@ -387,6 +426,12 @@ class ClientManager {
      * Retrieve the indexer configuration from environment variables (expects to be called from a Node.js environment).
      *
      * Expects `process.env.INDEXER_SERVER` to be defined, and you can also specify `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`.
+     * @returns The Indexer client configuration
+     * @throws Error if `process.env.INDEXER_SERVER` is not defined
+     * @example
+     * ```typescript
+     * const config = ClientManager.getIndexerConfigFromEnvironment()
+     * ```
      */
     static getIndexerConfigFromEnvironment() {
         if (!process || !process.env) {
@@ -405,6 +450,11 @@ class ClientManager {
      *
      * @param network Which network to connect to - TestNet or MainNet
      * @param config Which algod config to return - Algod or Indexer
+     * @returns The AlgoNode client configuration
+     * @example
+     * ```typescript
+     * const config = ClientManager.getAlgoNodeConfig('testnet', 'algod')
+     * ```
      */
     static getAlgoNodeConfig(network, config) {
         return {
@@ -415,6 +465,11 @@ class ClientManager {
     /** Returns the Algorand configuration to point to the default LocalNet.
      *
      * @param configOrPort Which algod config to return - algod, kmd, or indexer OR a port number
+     * @returns The LocalNet client configuration
+     * @example
+     * ```typescript
+     * const config = ClientManager.getDefaultLocalNetConfig('algod')
+     * ```
      */
     static getDefaultLocalNetConfig(configOrPort) {
         return {
@@ -427,6 +482,7 @@ class ClientManager {
      * Returns an algod SDK client that automatically retries on idempotent calls.
      *
      * @param config The config of the client
+     * @returns The Algod client
      * @example AlgoNode (testnet)
      * ```typescript
      *  const algod = ClientManager.getAlgodClient(ClientManager.getAlgoNodeConfig('testnet', 'algod'))
@@ -452,6 +508,7 @@ class ClientManager {
     /**
      * Returns an algod SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment).
      *
+     * @returns The Algod client
      * @example
      *  ```typescript
      *  // Uses process.env.ALGOD_SERVER, process.env.ALGOD_PORT and process.env.ALGOD_TOKEN
@@ -466,6 +523,7 @@ class ClientManager {
      * Returns an indexer SDK client that automatically retries on idempotent calls
      *
      * @param config The config of the client
+     * @returns The Indexer client
      * @example AlgoNode (testnet)
      * ```typescript
      *  const indexer = ClientManager.getIndexerClient(ClientManager.getAlgoNodeConfig('testnet', 'indexer'))
@@ -491,6 +549,7 @@ class ClientManager {
     /**
      * Returns an indexer SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment).
      *
+     * @returns The Indexer client
      * @example
      *
      *  ```typescript
@@ -508,6 +567,7 @@ class ClientManager {
      * KMD client allows you to export private keys, which is useful to (for instance) get the default account in a LocalNet network.
      *
      * @param config The config for the client
+     * @returns The KMD client
      * @example Custom (e.g. default LocalNet, although we recommend loading this into a .env and using the Default option instead)
      * ```typescript
      *  const kmd = ClientManager.getKmdClient({server: 'http://localhost', port: '4002', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'})
@@ -520,6 +580,7 @@ class ClientManager {
     /**
      * Returns a KMD SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment).
      *
+     * @returns The KMD client
      * @example
      *  ```typescript
      *  // Uses process.env.ALGOD_SERVER, process.env.KMD_PORT (or if not specified: port 4002) and process.env.ALGOD_TOKEN