This guide will walk you through the process of cloning the CoWallet repository and installing the required Node modules using npm
.
Before proceeding, make sure you have the following prerequisites installed on your system:
To clone the repository to your local machine, follow these steps:
- Open your terminal or command prompt.
- Navigate to the directory where you want to clone the repository.
- Run the following command to clone the repository:
gh repo clone Algo-Foundry/multisig-adenteo
. Alternatively, you can download the folder as a.zip
and extract it to your desired location.
To install the required Node modules for the project, use npm
. Follow these steps:
- Open your terminal or command prompt.
- Navigate to the repository's directory. Use the
cd
command to change directories. - Run the following command to install the Node modules specified in the project's
package.json
file:npm install
- Wait for the installation process to complete.
npm
will download and install all the required dependencies.
- Rename
.env.local.example
to.env.local
to specify the networks of your local Algorand Nodes.
Once you have successfully cloned the repository and installed the required Node modules, you are ready to view the CoWallet application!
Use npm run dev
to launch the application on your local machine. In order to use the features, please refer to the user guide.
If you encounter any issues or have questions, please refer to the repository's documentation or seek assistance from the project maintainers.
This user guide provides step-by-step instructions for creating a smart contract wallet, performing various transactions such as sending Algos and Algorand Standard Assets (ASAs), opting into ASAs, receiving Algos and ASAs, signing transactions, and executing transactions.
Before you begin, ensure that you have the following prerequisites:
- An Algorand blockchain node or access to a supported Algorand wallet.
- A basic understanding of Algorand's transaction types, account structures, and Algorand Standard Assets (ASAs).
To start using Cowallet, follow these steps:
-
Click "Connect" and select from a list of providers to connect to CoWallet.
-
Once connected, you will be able to create or load a CoWallet.
To create a CoWallet, follow these steps:
- Click on "Create CoWallet" and fill in the neccessary details for your smart contract wallet. The default version should be
1
and the max number of CoWallet owners is currently set to10
.
- Once you click on
Confirm Details
go ahead and confirm the details and proceed to create your CoWallet. You will be prompted to sign two transactions, one for initialising the smart contract, and another for funding your CoWallet.
- Once you have successfully signed both transactions, you will be redirected to your CoWallet dashboard, where you can access multiple other features.
To receive Algos or ASAs from your smart contract wallet, follow these steps:
- Click
Receive
on your CoWallet dashboard. You will see a pop-up with your CoWallet QR code as well as its public address. Use this address when receiving Algos or ASAs from others.
To send Algos from your smart contract wallet, follow these steps:
- Click
Send
on your CoWallet dashboard. You will see a pop-up allowing you to choose your desired transaction type.
- Once you have chose your transaction type, fill in the necessary details and click on
Create Transaction
. You will be prompted to confirm the details.
- Click on
Submit
to create your pending transaction. Once submitted, you should see it appear on your dashboard. Click on the dropdown button to view the details of the pending transactions.
To sign transactions from your CoWallet, follow these steps:
- Click on
Sign Transaction
in the dropdown view of the pending transaction. You will be prompted to sign the transaction with your connected account. If you are not opted-in to the CoWallet, an opt-in transaction will automatically be added to the atomic transaction you are signing.
- Once signed, you should be able to see a success notification as well as the updated status of your pending transaction.
To execute transactions from your CoWallet, follow these steps:
- One the signing threshold of the pending transaction has been met, you will be able to execute the transaction, provided that you are an owner of the CoWallet.
-
Click on
Execute Transaction
to submit the pending transaction to the network. You will be prompted to sign the submit transaction. -
Once submitted, you will be able to see a success notification as shown.
By following the instructions in this user guide, you can create a smart contract wallet, perform various transactions including sending Algos and ASAs, opt into ASAs, receive Algos and ASAs, sign transactions, and execute transactions. Remember to understand the implications and costs associated with each transaction type before proceeding.