Sequence Smart Wallet Contracts

Ethereum contracts for the Sequence Smart Wallet at https://sequence.app.

For more information see, https://sequence.build

Usage

Please visit https://sequence.app to access the Sequence Wallet via your Web Browser, or download "Sequence Wallet" from the respective Apple/Google stores.

You may also access, interface or develop your own Sequence Wallet via sequence.js. The sequence.js library offers a full open source library to interact, create, deploy and manage a Sequence Smart Wallet Account, as defined by the contracts in this respository. Also see go-sequence for an implementation in Go.

Connecting your Dapp with Sequence Wallet

If you wish to use Sequence Wallet in your Dapp, simply use sequence.js. Sequence.js is an Ethereum client library built on ethers.js, that provides an additional Sequence Smart Wallet Signer.

Install Sequence.js, an Ethereum client library built on ethers.js -- yarn add 0xsequence or npm install 0xsequence
Setup an Ethereum web3-compatible provider from your dapp to the Sequence Wallet

import { sequence } from '0xsequence'

const wallet = new sequence.Wallet('mainnet')
await wallet.login()

const provider = wallet.getProvider()
// .. connect provider to your dapp

Developing a custom Wallet UI for Sequence (advanced!)

If you wish to the Sequence Wallet Contracts @0xsequence/wallet-contracts directly:

Install the contracts -- yarn add @0xsequence/wallet-contracts or npm install @0xsequence/wallet-contracts
Install the Sequence Wallet libraries -- yarn add @0xsequence/wallet or npm install @0xsequence/wallet. To view the source, of the wallet libraries, see here, and review the test for sample usage, as well as the tests here.

NOTE: this integration is only needed if you want low-level access to the Sequence Wallet contracts, such as if you'd building your own custom wallet, or perhaps a CLI tool for managing your wallet.

Security Review

@0xsequence/wallet-contracts has been audited by two independant parties

Consensys Diligence - May 2020
Quantstamp - initial audit - July 2020
Quantstamp - audit of new capability, nested Sequence signers - Feb 2021

Dev env & release

This repository is configured as a yarn workspace, and has multiple pacakge.json files. Specifically, we have the root ./package.json for the development environment, contract compilation and testing. Contract source code and distribution files are packaged in "src/package.json".

To release a new version, make sure to bump the version, tag it, and run yarn release. The release command will publish the @0xsequence/wallet-contracts package in the "src/" folder, separate from the root package. The advantage here is that application developers who consume @0xsequence/wallet-contracts aren't required to install any of the devDependencies in their toolchains as our build and contract packages are separated.

LICENSE

Licensed under Apache-2.0

NirajBhattarai/wallet-contracts