Multi-signature functionality for StarkNet

Last update: Dec 24, 2022

Related tags

Overview

Starknet multisig

Multi-signature functionality for StarkNet.

⚠️ WARNING! ⚠️

This repo contains highly experimental code which relies on other highly experimental code. Expect rapid iteration. Do not use in production.

Current preliminary version

The current version is a preliminary version. This version consists of three pieces:

Cairo contract code
Unit tests for testing all the multisig functionality
A very rough UI for testing a multisig

The current version supports only on-chain multi-signatures. The multisig is a separate contract, which is called through your regular account contract (wallet).

Usage

Network

You can try either in alpha network (Goerli) or mainnet, but alpha is highly recommended since it's a lot faster. Do note that faster means that it may take only 10 minutes for a transaction to go through, depending on the network conditions.

Using the Goerli network means you operate on Goerli through a separate StarkNet alpha network. You do not interact directly with the Goerli network.

Currently StarkNet devnet doesn't work properly with this version.

What is there to test?

Currently you can test the multisig with only one target contract. The target contract is a trivial contract which keeps track of some balance and has unrestricted functionality to update the balance. You can't change the target contract (without some development work).

If you want to have a fresh start, just refresh your browser window. No data is stored between sessions.

Fees

You do not need any assets in your wallets in order to use this functionality. StarkNet does not currently enforce fees and subsidises Goerli fees.

UI

The UI can be found at http://starknet-multisig.vercel.app.

How to use:

If you don't have it yet, get the Argent X browser extension (not the regular Argent wallet!). Change the network to Goerli. Create some accounts
Choose what the threshold is and how many signers there can be in total. The threshold states how many signers have to sign a transaction before it can be executed. The total number of signers states how many signers the contract supports in total.
Enter owner addresses
Deploy the multisig
Enter some number in "Target balance" and submit the transaction
Confirm the transaction with at least the threshold amount of signer accounts
Execute the transaction. The displayed current balance in Target contract should reflect the changed balance.

Warnings

You should wait for each transaction to get status "ACCEPTED_ON_L2" (or L1) before proceeding with the next transaction. This can take some time. It may also take a bit of time for the UI to receive the latest data from the blockchain after a transaction has passed, so be patient.

There are very few UI validations currently. Enter sensible data in if you want to get sensible data out.

The network also doesn't provide any sensible error messages. If some of your transactions are rejected, you just have to figure out what failed in your setup.

Future development

In near future we'll get here:

A clearer UI
Possibility to choose an arbitrary target transaction
Possibly an option to use an account contract as multisig
Possibly off-chain signatures

Multisig implementation options

The current implementation uses Option 1 in the following image. Option 2 is in our roadmap for near future.

Fluffy stuff

Created by Equilibrium.

For support, free to poke LauriP#8728 at StarkNet Discord.

Comments

feat: support multi-wallets
generalizing wallet related access/docs (StarkNet is a multi-wallet ecosystem)

upgrading @argent/get-starknet to its latest version (which wraps get-starknet, StarkNet community's multi-wallet lib)

replaced faucet link to point towards a multi-wallet supporting TST faucet (argent locks their faucet to argent-only wallets)
opened by avimak 9
Code review findings - submit should also confirm + few other minor suggestions
Hi Equilibrium team 👋

Internally, Chainlink and ShardLabs teams have reviewed the current multisig codebase and we'll present our findings in this GH Issue. No critical findings surfaced, one UX optimisation that we'd like to have and few other minor suggestions (inconsistencies or code style).

submit_transaction should also confirm transaction, as onlySigner is allowed. This would avoid the need to invoke a subsequent confirm_transaction from the same signer. Serum on Solana also implements it like this. (medium - functional)

Event names mix present and past tense, e.g. ConfirmTransaction vs SignersSet (minor - API). We suggest past tense should be used for events, as do these resources: a. https://twitter.com/james_zaki/status/1323763725145239552 b. https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/GUIDELINES.md#solidity-code

with_attr error_message("No direct invocations allowed"): is slightly confusing (LOC here). A better error message would be something like "Access denied - only multisig". (minor - API)

_get_signers, _get_transaction_calldata, and _set_transaction_calldata functions should be considered to be renamed with an _range suffix , as to be consistent with other _range fn names. (minor - code style inconsistency)

Function signature style inconsistent at Multisig.cairo#L208. (minor - code style inconsistency)

In Multisig.test.ts there is some mixing of camelCase & snake_case. To improve TS readability we suggest using camelCase throughout the codebase (TS). (minor - code style inconsistency)

Hope this helps prepare the codebase for an third-party audit 🙌

Thank you!
opened by krebernisak 8
Separate the UI to a different repository
This repository can still be named starknet-multisig.

TODO (in order!):

[x] Separate the UI to a repo called ´starknet-multisig-ui`

[x] Close all pending pull requests from this contract repo

[x] Remove the frontend code from this repo in another PR
opened by JaniAnttonen 4
Upgrade Account contract
Change Account contract to the newest OpenZeppelin version. Not bringing in all of the OZ files, just hand-picked the required ones to one folder and fixed their imports

Non-account related contracts needed to be moved to their own folder, because compilation has to be done separately for account contracts and non-account contracts

Updated compilation script to reflect the changes

deployed
opened by microbecode 4
Fix dummy UI to support StarkNet 0.9

Fix the current minimal UI to utilize the new StarkNet 0.9 contract deployment pattern.

This is a good exercise to get hands dirty with the new deployment system.

opened by microbecode 2
Fix unit test deployment for StarkNet 0.9

StarkNet version 0.9.0 introduced a new way of deploying contracts (https://starknet.io/docs/hello_starknet/deploying_from_contracts.html#the-deploy-system-call). Old way will be deprecated.

Fix unit tests to use the new way of deploying contracts.

opened by microbecode 2
Optimize for new devnet version
New devnet version was released.

Re-enable devnet restart in unit tests

Remove superfluous dump delays

Update hardhat at the same time. Running all unit tests in venv went down from 10mins to 3 mins!

deployed
opened by microbecode 1

Owner

Equilibrium

Equilibrium is a research and development company focused on core infrastructure for the distributed web.

GitHub starknet-multisig.vercel.app

StarkNet support extension for VSCode. Visualize StarkNet contracts: view storage variables, external and view functions, and events.

StarkNet Explorer extension This VSCode extension quickly shows relevant aspects of StarkNet contracts: Storage variables of the current contract, and

6 Nov 4, 2022

Grupprojekt för kurserna 'Javascript med Ramverk' och 'Agil Utveckling'

JavaScript-med-Ramverk-Laboration-3 Grupprojektet för kurserna Javascript med Ramverk och Agil Utveckling. Utvecklingsguide För information om hur utv

3 May 18, 2022

Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

4 May 3, 2022

Kurs-repo för kursen Webbserver och Databaser

Webbserver och databaser This repository is meant for CME students to access exercises and codealongs that happen throughout the course. I hope you wi

14 Jan 3, 2023

Simple-load-more - This jQuery function will add a functionality to load 5 (or custom) more items. No AJAX functionality.

Simple Load More This jQuery plugin will add a functionality to load 5 (or custom) more items. Best for lists that are long and you want to hide all e

28 Jan 4, 2023

JavaScript OAuth 1.0a signature generator (RFC 5849) for node and the browser

OAuth 1.0a signature generator for node and the browser Compliant with RFC 5843 + Errata ID 2550 and community spec Installation Install with npm: npm

230 Dec 16, 2022

Simple implementation of online contract signature.

react-pdf-signaturer Simple implementation of online contract signature. Example online demo: https://buynao.github.io/react-pdf-signaturer/ Usage $ g

20 Nov 28, 2022

A component built in angular 13 which can generate an signature image in different fonts based on the selection.

AngularSignatureGenerator This project was generated with Angular CLI version 13.2.6. Development server Run ng serve for a dev server. Navigate to ht

4 Apr 26, 2022

I'm trying to create simple program for adding the digital signature to a pdf file with self-signed certificate. I use node-signpdf and pdf-lib library.

pdf-digital-signature-with-node-signpdf-ejs I'm trying to create simple program for adding the digital signature to a pdf file with self-signed certif