feat: Added initial documentation and tweaks to deprecate account, network-client and localnet functions

[robdmoore]

Inspired by #286, but a slightly different approach that starts to lay the foundation for deprecating the old way of using AlgoKit Utils in favour of the new approach using AlgorandClient.

This method allows us to keep this library in a releasable state while working on the deprecation bit by bit.

The patterns in this pull request help us guide users towards where we want and do proper deprecation of old vs new world, keep the documentation clear, keep the migration path clear and not have to do the migration all in a big bang.

Deprecates the following in favour of new AlgorandClient exposed functionality:

• algokit.multisigAccount
• algokit.rekeyedAccount
• algokit.transactionSignerAccount
• algokit.randomAccount
• algokit.mnemonicAccountFromEnvironment
• algokit.getAccountAddressAsUint8Array
• algokit.getAccountAddressAsString
• algokit.getAccountInformation
• algokit.getAccountAssetInformation
• algokit.getAccount
• algokit.getDispenserAccount
• algokit.mnemonicAccount
• algokit.getTestNetDispenserApiClient
• algokit.getKmdWalletAccount
• algokit.getKmdWalletAccount
• algokit.getOrCreateKmdWalletAccount
• algokit.isLocalNet
• algokit.getConfigFromEnvOrDefaults
• algokit.getAlgodConfigFromEnvironment
• algokit.getIndexerConfigFromEnvironment
• algokit.getAlgoNodeConfig
• algokit.getDefaultLocalNetConfig
• algokit.getAlgoClient
• algokit.getAlgoIndexerClient
• algokit.getAlgoKmdClient
• algokit.isTestNet
• algokit.isMainNet
• algorandFixture(undefined, config) override (now you can pass in clients or client configs to the first parameter of algorandFixture)
• AccountConfig in types/account

Changes:

• getTestAccount to take an AlgorandClient rather than algod and kmd (no change for getTestAccount method exposed from algorandFixture though, which is the primary way of accessing it (outside of a tweak to the recently added accountGetter parameter to also take an AlgorandClient)
• algorandFixture().context now has an algorand property with an AlgorandClient instance
• dispenser() method in AccountManager is now called dispenserFromEnvironment() to reflect the fact it loads environment variables and expects a Node.js environment

Additions:

• getAccountTransactionSigner method exposed from types/account-manager (similar to previous getSenderTransactionSigner method)
• AccountManager has a kmd property with an instance of the new KmdAccountManager class, and a rekeyed method that tracks a TransactionSignerAccount to a different sender
• KmdAccountManager class with getWalletAccount, getOrCreateWalletAccount and getLocalNetDispenserAccount methods
• ClientManager has new instance methods for network(), isLocalNet(), isTestNet() and isMainNet() and static methods for getConfigFromEnvironmentOrLocalNet, getAlgodConfigFromEnvironment, getIndexerConfigFromEnvironment, getAlgoNodeConfig, getDefaultLocalNetConfig, getAlgodClient, getAlgodClientFromEnvironment, getIndexerClient, getIndexerClientFromEnvironment, getKmdClient, and getKmdClientFromEnvironment

[joe-p]

LGTM. We should get eyes on it from devrel before merging though mainly to keep them in the loop and make sure there's no objections.

@SilentRhetoric no need for line-by-line review, but general summary is

• Moving AlgokitComposer/AlgorandClient out of beta
• Marking older functions now covered by these classes as deprecated
• Updating documentation to document new ways of doing things and guide developers from old to new
• Implementing AlgorandClient deeper within the library in some places to reduce duplicate code

[SilentRhetoric]

Thank you for your work on this! The consolidation of clients should make the library easier to use, investigate with Intellisense, teach, and maintain.

[robdmoore]

Agreed! This is the first of a number of pull requests to gracefully bring the new way of working with the library into being so expect a few more pull requests.