-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DAOsign #1770
Merged
Merged
DAOsign #1770
Changes from all commits
Commits
Show all changes
34 commits
Select commit
Hold shift + click to select a range
e4ab2f0
DAOsign application
Burmenska 0ef4460
Delete DAOsign
Burmenska 6a41dbd
Create DAOsign.md
Burmenska 9f311da
Update DAOsign.md
Burmenska 9780b40
Update DAOsign.md
Burmenska 2460677
Update DAOsign.md
Burmenska f86961d
Update DAOsign.md
Burmenska cb965f4
Update DAOsign.md
Burmenska 082bd53
Update DAOsign.md
Burmenska ec31d4f
Update DAOsign.md
Burmenska 6982b32
Update DAOsign.md
Burmenska 01640f3
Update DAOsign.md
Burmenska 941c3a4
Update DAOsign.md
Burmenska ae046d8
Update DAOsign.md
Burmenska d343148
Update DAOsign.md
Burmenska 57a4e21
Update DAOsign.md
Burmenska 3d17647
Update DAOsign.md
Burmenska 7e95d95
Update DAOsign.md
Burmenska e3e7e77
Update DAOsign.md
Burmenska 6c92b8f
Update DAOsign.md
Burmenska e5f5c20
Update DAOsign.md
Burmenska 13c0d85
update
ramilexe 4344084
correct name of the pallet
ramilexe cd4e949
update deliverables to deploy to Astar testnet
ramilexe 978bdf3
update m2 deliverables
ramilexe 31167fd
Update DAOsign.md
Burmenska 59cf84a
Update applications/DAOsign.md
ramilexe f9d5adb
add UI design
ramilexe 0a5ab6a
add link to Proof technical design
ramilexe 7c62fc5
* added description for Off-chain Relayer
ramilexe e1a426f
updated seq diagram
ramilexe bca204e
Update applications/DAOsign.md
ramilexe 49500ae
add docker to m2
ramilexe cd0bd68
added relayer as a separate milestone 3
ramilexe File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,243 @@ | ||
# DAOsign | ||
|
||
- **Team Name:** DAOsign | ||
- **Payment Address:** 13s3c37rwrZfa8WQcZPdqE1zi1hGAguf2TWfWMr8f5aLBrg | ||
- **[Level](https://github.com/w3f/Grants-Program/tree/master#level_slider-levels):** 3 | ||
|
||
## Project Overview :page_facing_up: | ||
|
||
|
||
### Overview | ||
|
||
DAOsign is a decentralized platform for agreements and policies with publicly verifiable and authorized cryptographic proofs and Governance Automation, designed for DAOs. | ||
Traditional methods of signing agreements, such as paper-based systems or legacy e-signatures, are prone to fraud and lack transparency, and offer no solution for verification of the signer's identity or signer’s authority to execute the agreement. Instead these systems rely on costly legal proceedings for enforce agreements. | ||
|
||
DAOsign provides publicly verifiable cryptographic proofs; secure, transparent and automated processing of complex Agreements and Policies. | ||
|
||
Furthermore, DAOsign provides robust Governance and Policy Builder platform to provide governance, workflow automation and controls for organization policies and procedures. | ||
|
||
### Project Details | ||
A project goal is to store Agreements Proofs on Polkadot chain using Ink! smart contracts. | ||
|
||
|
||
Deliveries include DAOsign platform with an ability to: | ||
- create agreements including generating using ChatGPT (already implemented on our platform, currently available on our [testnet](https://testnet.daosign.org/) | ||
- add and remove signers and observers of different levels of anonymity | ||
- allow signing the documents with further storing of signature proofs on Astar testnet blockchain. | ||
|
||
|
||
**Core DAOsign components** | ||
|
||
<img width="902" alt="Screenshot 2023-05-27 at 16 51 43" src="https://github.com/Burmenska/Grants-Program/assets/3983591/e6e3e78d-edf4-4d50-a298-e01210d75963"> | ||
|
||
|
||
**Technical design** | ||
|
||
Proofs are implemented in the EIP-712 standard and adjusted to ink! ecosystem. Proofs digned using user’s EVM private key. | ||
We are supporting this standard in Ink! smart contract to be able to verify the signature in ink! smart contract. | ||
Also, we are implementing an adjusted EIP-2771 standard to allow Agreement Signers gas-free delegation to publish proof on-chain. | ||
EIP-712 standard will be used for proofs, adaptation means that user data is converted to a binary bit; we use its hash (serialization vs deserialization) | ||
And EIP-2771 standard - to securely send the proof and receive it. | ||
So that EVM standards will be adapted to ink! ecosystem requirements. | ||
Example (interfaces) of the smart contracts can be found here https://github.com/DAOsign/daosign-smart-contracts (Solidity version). | ||
|
||
|
||
Detailed storyboard can be found here: https://consideritdone.storiesonboard.com/m/PUCLDvQC4kKwoRJ8kbm3MA . | ||
|
||
**Off-chain Relayer** | ||
|
||
Relayer is an off-chain component that accepts transaction (with EIP-712 signature from Metamask) from user, | ||
signs it and sends to the network. This app will be developed using following technology stack: | ||
|
||
* Typescript/NodeJS | ||
* express.js | ||
* polkadot.js | ||
|
||
**Architectural diagram** | ||
|
||
![DAOsign_ Storing proofs using Ink!](https://github.com/Burmenska/Grants-Program/assets/1008882/297093a0-200a-4f78-babb-04ad6314fb35) | ||
|
||
**Definitions**: | ||
* **Creator**: Author of agreement, define agreement content, signers | ||
* **Signer**: Participant (Signer) of the agreement. Signs and sends transactions to a Relay | ||
* **Relayer**: Receives signed requests off-chain from Signers and pays gas to turn it into a valid transaction that goes through a Trusted Forwarder | ||
* **Trusted Forwarder**: A contract trusted by the Recipient to correctly verify signatures before forwarding the request from Signers | ||
* **AgreementProof**: A contract that holds metadata and proofs for agreement.er | ||
|
||
|
||
Agreement Proof entity represent 3 proofs: | ||
* Proof of signature | ||
* Proof of authority | ||
* Proof of agreement | ||
|
||
The detailed Proof Technical Design is [here](https://github.com/w3f/Grants-Program/files/12183424/Proofs.Technical.Design.-.DAOSign.pdf) | ||
|
||
**UI Design** | ||
|
||
In Milestone 2 we have a frontend delivery. Here list of wireframes/designs with comments: | ||
|
||
|
||
1. Adding toggle to allow store Agreement Proof on-chain (toggle above Sign Agreement button) | ||
![Store proofs 0](https://github.com/w3f/Grants-Program/assets/1008882/40f89bfa-50fc-4944-8a64-af84337b713a) | ||
|
||
2. Enable that toggle and select Parity network from dropdown | ||
|
||
![Store proofs 1](https://github.com/w3f/Grants-Program/assets/1008882/87894c58-bc30-4e48-b74b-3eabfcad2779) | ||
|
||
3. After user click `Sign Agreement` and execute transaction, we show `On-chain Proof` transaction hash on Information panel | ||
![Store proofs 6](https://github.com/w3f/Grants-Program/assets/1008882/88dfed66-5f88-4658-88b4-8a6198060de9) | ||
|
||
|
||
### Ecosystem Fit | ||
|
||
DAOsign fit the Governance category and since, Polkadot and Kusama are designed to be community-driven networks that allow for decentralized governance. DAOsign can fit into this ecosystem by providing a platform for DAOs to manage their decision-making processes in a decentralized manner. | ||
Our target audience is not only DAOs, but also all the companies, who have a need to deal with the agreement/policies management including the use case for managing Grants, that was presented to you during our introdution call. | ||
Competitors analysis can be found here: https://docsend.com/view/sbexkxn5su3ahdg8 . Particularly in Substrate / Polkadot / Kusama ecosystems we are not aware about any tools, that provide exactly the same functionality. | ||
|
||
|
||
## Team :busts_in_silhouette: | ||
|
||
### Team members | ||
|
||
- Team Leader, Founder: Eugene Fine https://github.com/ConsiderItDone, | ||
- Solution Architect: Ramil Amerzyanov https://github.com/ramilexe | ||
- Blockchain / Tech lead: Misha Kushka https://github.com/kushkamisha | ||
- Director of Buisiness development and Partnerships: Oleksandra Burmenska https://github.com/burmenska | ||
|
||
|
||
|
||
### Contact | ||
|
||
- **Contact Name:** Eugene Fine | ||
- **Contact Email:** [email protected] | ||
- **Website:** daosign.org | ||
|
||
### Legal Structure | ||
|
||
- **Registered Address:** 2468 Brian Dr. Northbrook, IL 60062 | ||
- **Registered Legal Entity:** DAOSIGN, LLC | ||
|
||
### Team's experience | ||
**Eugene Fine:** CEO, Founder | ||
Background: | ||
Over 20 years of building, scaling, and managing technology organizations. Past experience: | ||
- CTO for https://www.explorersurgical.com | ||
- tech leadership contribution to https://bird.coach | ||
- tech advisor and facilitator for polywrap.io | ||
to name a few. | ||
Also, Eugene is a founder at consideritdone.tech and daosign.org | ||
|
||
**Ramil Amerzyanov:** Solution Architect, CTO | ||
Background: | ||
12+ years in building complex enterprize solutions (all SDLC aspects), including 7+ years in Blockchain industry. | ||
Past projects include: | ||
- contribution to Ethereum standards development | ||
- tech leadership for https://docsend.com/view/fjrvjtyzgm7wgrkj projects | ||
|
||
**Oleksandra Burmenska:** Director of Business Development and Partnerships | ||
Background: | ||
Engineering, MBA, and Psychology diplomas. Over a decade of experience in IT: development and managerial positions, last five years focused on the Blockchain industry. | ||
Experience with enterprises and startup companies, scaling teams, and building blockchain products. | ||
Previous blockchain projects include: | ||
- successfully managed ICOs during 2017-2019 (example: Õpet – Medium ) | ||
- contribution to Polywrap, NEAR, Axelar, GnosisSafe, Avalanche ecosystems | ||
- contribution to nodle.com ecosystem: managing the block explorer development (before it moved to Subscan), leading the Landslide - Avalanche subnet development,etc. | ||
|
||
**Misha Kushka**: Tech Lead and Blockchain Developer | ||
Background: 6+ years of professional experience as a developer, 4+ years of professional experience in the Blockchain field, 4+ years experience as a lead | ||
|
||
### Team Code Repos | ||
|
||
- https://github.com/ConsiderItDone | ||
- https://github.com/DAOsign | ||
|
||
Please also provide the GitHub accounts of all team members. If they contain no activity, references to projects hosted elsewhere or live are also fine. | ||
|
||
- [Eugene Fine](https://github.com/ConsiderItDone) | ||
- [Ramil Amerzyanov](https://github.com/ramilexe) | ||
- [Oleksandra Burmenska](https://github.com/Burmenska) | ||
- [Misha Kushka](https://github.com/kushkamisha) | ||
|
||
### Team LinkedIn Profiles (if available) | ||
|
||
- [Eugene Fine](https://www.linkedin.com/in/eugenefine/) | ||
- [Ramil Amerzyanov](https://www.linkedin.com/in/ramil-amerzyanov/) | ||
- [Oleksandra Burmenska](https://www.linkedin.com/in/oleksandra-burmenska/) | ||
- [Misha Kushka](https://www.linkedin.com/in/mkushka/) | ||
|
||
|
||
## Development Status :open_book: | ||
|
||
We are currently working on a tech demo (kind of a pre-beta version) and non-blockchain version of DAOsign is available here: https://testnet.daosign.org | ||
|
||
## Development Roadmap :nut_and_bolt: | ||
|
||
## Overview | ||
|
||
* **Total Estimated Duration:** 2 months | ||
* **Full-Time Equivalent (FTE):** 2 FTE | ||
* **Total Costs:** 48,100 USD | ||
|
||
### Milestone 1 - Smart Contract Development | ||
|
||
* **Estimated Duration:** 4 weeks | ||
* **FTE:** 2 | ||
* **Costs:** 24,050 USD | ||
|
||
|
||
| Number | Deliverable | Specification | | ||
|-------:|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| 0a. | License | Apache 2.0 | | ||
| 0b. | Documentation | We will provide both inline documentation of the code and a basic tutorial that explains how a user can use DAOsign Smart Contract developed in ink! for proof verification. | | ||
| 0c. | Testing and Testing Guide | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | | ||
| 0d. | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. | | ||
| 0e. | Article | We will publish an **article** that explains what was done as part of the grant. And we will publish a series of articles that explains how DAOsign works from a high-level perspective. The content of the articles will be consistent with the functions at this stage. | | ||
| 1. | Smart Contracts | DAOsign Smart Contract repo that includes following components: Agreement Contract, EIP712/EIP2771 standard implementation on Ink!. These smart contracts can be deployed to any substrate chain with contracts-pallet. | | | ||
|
||
|
||
### Milestone 2 - DAOsign Application integration | ||
|
||
* **Estimated Duration:** 2 weeks | ||
* **FTE:** 2 | ||
* **Costs:** 12,025 USD | ||
|
||
|
||
| Number | Deliverable | Specification | | ||
|-------:|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| 0a. | License | Apache 2.0 | | ||
| 0b. | Documentation | We will provide both inline documentation of the code and a basic tutorial that explains how a user can | | ||
| 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. | | ||
| 0d. | Docker | Dockerfile(s) provided in Milestone 1 will be used to test all the functionality delivered with this milestone. | | ||
| 1. | DAOsign Ink! JS SDK | We will publish a npm/yarn package with the logic how to interact with Smart Contract from JS | | ||
| 2. | DAOsign Application Integration | Integrate DAOsign application using SDK. DAOsign application (which is not part of this grant) will be open sourced as well. DAOsign is written using ReactJS on frontend and Typescript on backend | | ||
|
||
|
||
### Milestone 3 - Relayer Development | ||
|
||
* **Estimated Duration:** 2 weeks | ||
* **FTE:** 2 | ||
* **Costs:** 12,025 USD | ||
|
||
|
||
| Number | Deliverable | Specification | | ||
|-------:|---------------|------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| 0a. | License | Apache 2.0 | | ||
| 0b. | Documentation | We will provide both inline documentation of the code and a basic tutorial that explains how a user can run Relayer and broadcast transactions | | ||
| 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. | | ||
| 0d. | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. | | ||
| 1. | Gas Relayer | Off-chain component for relaying transactions. Will be developed on Typescript/NodeJS using polkadot.js library | | ||
|
||
|
||
|
||
## Future Plans | ||
|
||
After the `ink!` version of the DAOsign protocol stack is fully tested, we would like to implement a `pallet` version for Polkadot ecosystems. Anyone who is integrating it can communicate with other ecosystems conveniently. | ||
|
||
Add support for multi-chain proof verification using [XCM](https://wiki.polkadot.network/docs/learn-xcm) and [IBC](https://ibcprotocol.org/) protocols. | ||
|
||
|
||
## Additional Information :heavy_plus_sign: | ||
|
||
**How did you hear about the Grants Program?** | ||
|
||
By recommendation of Richard Casey from Parity. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current demo uses EVM wallets (MetaMask, WalletConnect, etc.), would functionality be built to sign with substrate SS58 wallets? (Talisman, SubWallet, Polkadot-JS, etc.)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We thought to add support for SS58 wallets as well, but
a) I didn't find in Polkadot-JS wallet ability to sign user-defined payload. We use that approach to authorize a user on the website
b) in the current scope, we would like to keep existing authorization approach using EVM wallets and can add support for SS58 wallets in the future
Does it work for you?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ramilexe the Polkadot-JS API does allow for signing arbitrary payloads using the
sign
method. Essentially you would need to create a keyring instance usingconst keyring = new Keyring();
and then the user-defined payload could be created usingconst payload
, check these docs for more info.Personally, I'm not sure that I would support only EVM wallet functionality, as the majority of our ecosystem's users don't use them (with the exception being the Moonbeam/Moonriver ecosystems). I worry that it might be hard to attract users if they need to switch wallets.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@keeganquigley is it possible to use this
sign
method in browser extension as Metamask does?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems it is not implemented in the extension wallet: polkadot-js/extension#115
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah thanks @ramilexe perhaps it is not currently possible then. I'll look into this further, but if that's the case than I think EVM would be fine for the initial PoC.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@keeganquigley sounds good to start with EVM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ramilexe in the issue you linked you can actually also find the PR where this was implemented. So I think it should work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ramilexe Signing a message is implemented at least in the polkadot.js extension and Talisman (see screenshot below). In any case, I would recommend using a user-friendly wallet as primary target, not the polkadot.js extension.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@takahser @semuelle we evaluated the effort to implement SS58 wallet support and determined that the effort takes us outside of MVP scope. We would like to prioritize this feature as a next milestone, if it is acceptable for you.