/mpc_wallet

A Multi-Party Computation solution for Custodial Wallet which relies on EVM based blockchains like ETH, Polygon and Avalanche for storing the Key Shares.

Primary LanguageGo

MPC Custodial Wallet

MPC Custodial Wallet is an open-source custodial wallet service that utilizes Multi-Party Computation (MPC) to securely store and manage cryptocurrency private keys. The wallet service is designed for high flexibility and can interact with various blockchain networks, such as Ethereum, Polygon, and Avalanche.

Features

  • Key Management: Split a user's private key into multiple shares using Shamir's Secret Sharing algorithm and store each share on different blockchain networks.
  • Transaction Building and Signing: Create, sign, and broadcast transactions to the supported blockchain networks.
  • OAuth Integration: Allow users to register and log in using their social media accounts (e.g., Google).
  • Modular Architecture: Comprising of modular components, the service is easy to extend and adapt to various blockchain networks.
  • Smart Contract Interaction: Flexible interaction with smart contracts by parsing contract ABIs.

Getting Started

Prerequisites

  • Golang (version 1.16 or higher)
  • Gin Web Framework
  • Ethereum and other supported blockchain networks' testnet/private keys and addresses.

Installation

  1. Clone the repository:

    git clone https://github.com/Jahankohan/mpc_wallet.git

  2. Change to the project directory:

    cd mpc_wallet

  3. Install the required Go packages:

    go mod download

  4. Set up the configuration in config.yml:

    networks:
testnet:
local:
  privatekey: "242e8a1be01eb4142083e5f2491600c53a1af215840f6800336b1a27c123b927"
  network: "http://localhost:8545"
  deployedAddress: "0x6F755946fbF08495f3D5c9309Bc4d15A5f7Ae5f3"
  chainid: 1337
sepoila:
  privatekey: ""
  network: "https://rpc.sepolia.dev"
  deployedAddress: ""
  chainid: "11155111"
mumbai:
  privatekey: ""
  network: "https://matic-mumbai.chainstacklabs.com/"
  deployedAddress: "0xB72Ec384Cb9c94F5cafbe02d3529cF6a0B127524"
  chainid: "80001"
fuji:
  privatekey: ""
  network: "https://api.avax-test.network/ext/bc/C/rpc"
  deployedAddress: "0x2d39d7b66FF5c199DC3B51379C30E08c3Ac97946"
  chainid: "43113"
mainnet:
ethereum:
  privatekey: ""
  network: ""
  deployedAddress: ""
  chainid: ""
polygon:
  network: ""
  deployedAddress: ""
  chainid: ""
avalanche:
  privatekey: ""
  network: "https://api.avax.network/ext/bc/C/rpc"
  deployedAddress: ""
  chainid: "43114"

  5. Set up environment variables for private keys. The environment variable names should be in uppercase and follow the pattern PRIVATEKEY_<NETWORKTYPE>.

    For example:

    PRIVATEKEY=242e8a1be01eb4142083e5f2491600c53a1af215840f6800336b1a27c123b927
...

    You can place them in a .env file in the root directory of the project. This file should be added to .gitignore to ensure it doesn't get committed to your version control system.

  6. Run the server:

    go run main.go

Your server should now be running at http://localhost:8080.

Usage

  • Register/Login through OAuth.
  • Store a private key by splitting it into shares and storing them on different blockchains.
  • Build, sign, and broadcast transactions to interact with blockchain networks and smart contracts.
  • Retrieve and reconstruct private keys through stored shares.

Contributing

We welcome contributions from the community. Please submit your pull requests to this GitHub repository.

License

This project is licensed under the MIT License.

Acknowledgments