Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mgnfy-view/multi-sig-wallet
A multi-signature wallet implementation using the eth-ape framework in python
https://github.com/mgnfy-view/multi-sig-wallet
eth-ape ethereum multisig-wallets pip3 pytest python3 smart-contracts solidity
Last synced: about 2 months ago
JSON representation
A multi-signature wallet implementation using the eth-ape framework in python
- Host: GitHub
- URL: https://github.com/mgnfy-view/multi-sig-wallet
- Owner: mgnfy-view
- License: mit
- Created: 2024-01-03T14:19:16.000Z (almost 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T07:54:07.000Z (8 months ago)
- Last Synced: 2024-05-29T22:11:27.011Z (7 months ago)
- Topics: eth-ape, ethereum, multisig-wallets, pip3, pytest, python3, smart-contracts, solidity
- Language: Python
- Homepage: https://sepolia.etherscan.io/address/0xCdec20F79bd58A9A30870f632e3F928717cffa95
- Size: 388 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Multi-Sig Wallet
A multi-signature wallet implementation using the Eth-Ape framework in python
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
## About The Project
A multi-sig wallet, also known as a multi-signature wallet, is a crypto wallet which is held by multiple owners, and requires a predetermined minimum number of approvals to authorize and execute transactions.
The wallet owners and the minimum number of approvals required for transaction authorization are set during deployment of the smart contract. A transaction request can be issued by any one of the owners. Further, the transaction can be approved by other wallet owners, and then executed. This implementation of the multi-sig wallet supports ether, token, and NFT transactions.
To get a full list of multi-sig wallet functions and their descriptions, head over to `./docs/index.html`. Open the file in a web browser to view the documentation.
Additionally, you can view the most recent deployment of an example wallet contract [here](https://sepolia.etherscan.io/address/0xCdec20F79bd58A9A30870f632e3F928717cffa95).
### Built With
- 
- 
- 
- 
## Getting Started
### Prerequisites
Make sure you have node.js, python3, pip3, python3-venv, and git installed and configured on your system. Also, you need to have a bunch of MetaMask accounts, with atleast one of them (the deployer) having about 1 ETH. If you are using the Sepolia testnet, you can get Sepolia testnet ETH from the [Alchemy faucet](https://sepoliafaucet.com/).
### Installation
Clone this repository
```shell
git clone https://github.com/mgnfy-view/multi-sig-wallet.git
```
Cd into the project folder and activate the virtual environment
```shell
cd multi-sig-wallet
python3 -m venv .venv
source .venv/bin/activate
```
Then install the dependencies
```shell
pip3 install -r requirements.txt
ape pm install .
npm install
```
Don't forget to install the plugins required by this project!
```shell
ape plugins install .
```
### Setup and Deployment
> [!WARNING]
> The multi-sig wallet contract hasn't undergone a security review yet. It is highy advisable to keep your deployments restricted to testnets only.
You need to bring your Metamask accounts into ape. One of these accounts will be used to deploy your wallet. The others, along with the deployer, will be joint owners of the multi-sig wallet. You can import as many accounts as you like with
```shell
ape accounts import
```
Answer the prompts and your accounts will be registered with ape. You will need to provide an alias for each account, and a passphrase. Don't forget these! Ape will ask you for the passphrase to sign transactions.
If you would like to deploy to the Sepolia testnet, you'll need to get your api key from [Alchemy](https://www.alchemy.com/), and set it as an environment variable
```shell
export WEB3_ALCHEMY_API_KEY=
```
Additionally, you can get an api key from [Etherscan](https://docs.etherscan.io/getting-started/creating-an-account) to publish and verify your contracts. Once you have the api key, set it as an environment variable
```shell
export ETHERSCAN_API_KEY=
```
Then, go to `./scripts/deploy_multi_sig_wallet.py` and bring in your accounts using the account aliases you set before. Remember, account_1 is the deployer.
```python
account_1 = accounts.load("")
account_2 = accounts.load("")
...
account_n = accounts.load("")
```
Set the minimum number of required approvals to authorize a transaction to a valid value (required_approvals <= number of wallet owners and required_approvals > 0).
```python
required_approvals = 2 # an example
```
> [!TIP]
> You can pass in only one owner, and set the required_approvals to 0 to use the multi-sig wallet as a conventional wallet!
Add all your accounts to the constructor arguments in order. These accounts will be registered as wallet owners during deployment.
```python
constructor_args = [[account_1, account_2,..., account_n], required_approvals]
```
Finally, deploy your wallet to your preferred network (I'm using the Sepolia testnet as an example here)
```shell
ape run scripts/deploy_multi_sig_wallet.py --network ethereum:sepolia:alchemy
```
This will prompt you to sign the transaction by entering your passphrase. Wait for some time as the deployment script deploys the contract and publishes the contract code on Etherscan.
And there you have it, your very own multi-sig wallet!
You can go to Etherscan, paste in your wallet's address, connect your Metamask account (which is one of the wallet owners), and start issuing, approving, and executing transactions!
## Roadmap
- [x] Write the multi-sig wallet and factory smart contracts
- [x] Write deployment scripts
- [x] Conduct unit testing
- [x] Perform gas optimizations
- [x] Deploy the wallet on Sepolia testnet
- [x] Write Natspec documentation and generate docs
- [x] Write a good README.md
See the [open issues](https://github.com/Sahil-Gujrati/multi-sig-wallet/issues) for a full list of proposed features (and known issues).
## Contributing
Check out [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for contribution guidelines.
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
### Reach Out
Here's a gateway to all my socials, don't forget to hit me up!
[](https://linktr.ee/mgnfy.view)
[contributors-shield]: https://img.shields.io/github/contributors/Sahil-Gujrati/multi-sig-wallet.svg?style=for-the-badge
[contributors-url]: https://github.com/Sahil-Gujrati/multi-sig-wallet/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Sahil-Gujrati/multi-sig-wallet.svg?style=for-the-badge
[forks-url]: https://github.com/Sahil-Gujrati/multi-sig-wallet/network/members
[stars-shield]: https://img.shields.io/github/stars/Sahil-Gujrati/multi-sig-wallet.svg?style=for-the-badge
[stars-url]: https://github.com/Sahil-Gujrati/multi-sig-wallet/stargazers
[issues-shield]: https://img.shields.io/github/issues/Sahil-Gujrati/multi-sig-wallet.svg?style=for-the-badge
[issues-url]: https://github.com/Sahil-Gujrati/multi-sig-wallet/issues
[license-shield]: https://img.shields.io/github/license/Sahil-Gujrati/multi-sig-wallet.svg?style=for-the-badge
[license-url]: https://github.com/Sahil-Gujrati/multi-sig-wallet/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/sahil-gujrati-125ab0284