algosdk utility wrapper (legacy)

A legacy utility wrapper over algosdk that abstracts some of its APIs to simplify algosdk usage in some specific instances. No longer useful since Algokit's release -- please see Algokit.

Features

• Provide functions to sign transactions in various ways for the Algorand Blockchain.
• Utilities for various tasks, such as:
  • Compile a program source file
  • Wait for transaction confirmation
  • Send raw transactions
  • Execute transactions with or without signing
  • Opt-in to assets and apps
  • Interact with assets and apps
  • Compile, create, update, and delete Algorand smart contracts
  • Utility functions for Algorand wallets
• Transaction Signer abstraction, including implementations for signing with transactions with Wallet Connect and a key pair.

Installation

Install via npm:

npm install @gradian/util

Usage

Create an instance of AlgorandUtil by passing an Algorand client (AlgodV2 instance) as a dependency during instantiation. Once initialized, you can utilize the various utilities it offers. Check out the example below:

import { AlgorandUtil, Signer } from '@gradian/util';

// algoClient is an algorand client (AlgodV2 instance)
const algoUtil = new AlgorandUtil(algoClient)

// Groups the 'transactions' array and signs each transaction using the associated wallet from the 'wallets' array (of type FalseyWallet[]).
// Only transactions with a defined secret key (sk) in the wallet are signed.
// The function returns a grouped transaction that might be partially signed. 
// Any unsigned transactions can be signed elsewhere, e.g., in the frontend using WalletConnect.
const groupSigningRequest: SignTxnRequest[] = await algoUtil.generateGroupTransactionSigningRequest(transactions, wallets)


// Create a WalletConnectSigner, for signing transactions using the specified WalletConnect connector instance (connected wallet) with the 'sign' function
const walletConnectSigner: Signer.WalletConnectSigner = new Signer.WalletConnectSigner(algoClient, walletConnect.connector)
// now we can use it to sign txns
await walletConnectSigner.sign(txns)

For more detailed usage, please refer to the documentation of individual utility functions and the provided examples.

Building

To build the project, run:

npm run build

License

This project is licensed under the MIT License - see the LICENSE file for details.

This README.md provides a comprehensive overview of the @gradian/util package, showcasing its capabilities and features in an organized manner. The actual README.md might be extended with more examples, a detailed API reference, or a contribution guide.

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

By using this software, you acknowledge and agree that the authors and contributors of this software are not responsible or liable, directly or indirectly, for any damage or loss caused, or alleged to be caused, by or in connection with the use of or reliance on this software. This includes, but is not limited to, any bugs, errors, defects, failures, or omissions in the software or its documentation. Additionally, the authors are not responsible for any security vulnerabilities or potential breaches that may arise from the use of this software.

You are solely responsible for the risks associated with using this software and should take any necessary precautions before utilizing it in any production or critical systems. It's strongly recommended to review the software thoroughly and test its functionalities in a controlled environment before any broader application.