CIP-0062? | Cardano dApp-Wallet Web Bridge Catalyst Extension #296

ehanoc · 2022-07-14T10:59:52Z

This proposal can be seen as an "extension" of the existing CIP-30 (Cardano dApp-Wallet Web Bridge) to add voting delegation functionality spec'ed in CIP-36 (Catalyst/Voltaire Registration Transaction Metadata Format - Updated).

This extension also defines the API required for implementation by wallet providers to submit votes to Jormungandr.

see rendered Markdown

…scription enable()

… to sign and submit delegation cert into one step api.submitDelegation

…wallet should manage these internally

CIP-0062/README.md

…o the API

CIP-0062/README.md

refi93 · 2022-09-13T09:34:25Z

CIP-0062/README.md

+
+Errors: `APIError`, `TxSendError`
+
+## **Delegation Cert process**


I would expect a similar breakdown for the Voting process, it would make the motivation behind the available calls clearer to the reader

CIP-0062/README.md

refi93 · 2022-09-14T09:55:02Z

CIP-0062/README.md

+
+This api being an extension of [CIP-30 (Cardano dApp-Wallet Web Bridge)](https://cips.cardano.org/cips/cip30/), expects that `cardano.{walletName}.enable()` to be enabled and added to CIP-30 whitelist implicitly.
+
+When both this API and **CIP-30** is being enabled, is up to the wallet to decide the number of prompts requesting permissions to be displayed to the user.


This api being an extension of CIP-30 (Cardano dApp-Wallet Web Bridge), expects that cardano.{walletName}.enable() to be enabled and added to CIP-30 whitelist implicitly.

Doesn't this sentence imply that the dapp has to always enable first the CIP-30 API and only then request the governance one? On the other hand this sentence

When both this API and CIP-30 is being enabled, is up to the wallet to decide the number of prompts requesting permissions to be displayed to the user.

seems to contradict that, hinting that it may not always be the case that CIP-30 is being enabled before CIP-62. Is my understanding that CIP-30 always has to be enabled before CIP-62 correct?

That's correct @refi93 . I've updated this section, could you have a re-read?

I'm checking https://github.com/cardano-foundation/CIPs/pull/296/files#diff-d3ac75d45e4e621f6ad95567378e0dc2b671f44d3c32425dda9ca08210e18876R265-R272 but I didn't notice a difference, am I checking perhaps the wrong commit/branch?

Doesn't this sentence imply that the dapp has to always enable first the CIP-30 API and only then request the governance one? On the other hand this sentence

Yes, it ties to explain that CIP-30 should be enabled as well, if not so already.

Maybe Is there a reason why it shouldn't?

Is my understanding that CIP-30 always has to be enabled before CIP-62 correct?

Yes, that was the idea.

Would it be more clear if i were to remove the section that states:

When both this API and CIP-30 is being enabled, is up to the wallet to decide the number of prompts requesting permissions to be displayed to the user.

refi93 · 2022-09-14T10:10:40Z

CIP-0062/README.md

+proposal information. Include the range of options we can use to vote. This defines the allowed values in `choice`.
+
+```
+interface Proposal {


will there be an API where the wallet could fetch the proposal metadata to show something more user friendly in the confirmation prompt to the user than a list of numbers?

I see; this would definitely be easier to implement on the client side.

About some sort of Map<string,string> // <planId, proposalTitle> ?

CIP-0062/README.md

…llet-connector

Minimum changes to generalize description and explains how to use it in any voting system (not just catalyst). Small fixes, typos.

ehanoc · 2023-01-19T10:09:30Z

@ehanoc - tagging this as Waiting for Author because of the number of unresolved conversations above (particularly the still-missing Rationale section) and the recent incoming references to this proposal (so visitors can more easily see its status).

@rphair Rationale section in now and a few updates.

Co-authored-by: Rafael Korbaš <rafael.korbas@gmail.com>

rphair · 2023-01-19T17:31:27Z

@ehanoc: @rphair Rationale section in now and a few updates.

Thanks: Rationale looks good. There have been a few changes to the document format since you originally submitted your proposal and it would be helpful if you could edit to conform to them while this document is still fluid:

New header preamble (https://github.com/cardano-foundation/CIPs/tree/master/CIP-0001#header-preamble) has some fields added & others removed.

All top level headings like Abstract, Motivation, Specification, etc. should be H2's (markdown: ##) as per https://github.com/cardano-foundation/CIPs/blob/master/.github/CIP-TEMPLATE.md, with the smaller headings descending from there (it would be cleaner if you were to edit the rank of your many minor section headings, rather than us possibility messing it up).

All proposals must have a Path to Active, even if already active & completed (in that case having a description of the path taken so far). This section & its two sections (acceptance & implementation) are described here (there are some live examples in the CIP archive already): https://github.com/cardano-foundation/CIPs/tree/master/CIP-0001#status-proposed

CIP-0062/README.md

refi93 · 2023-01-20T18:16:05Z

CIP-0062/README.md

+Errors: [`APIError`](#extended-apierror), [`TxSignError`](#extended-txsignerror)
+
+* `votes` - an array of up to 10 votes to be validated with the wallet user and, if valid, signed.
+* `settings` - *Optional*. Settings which are universally applicable to all `votes` being signed.  This is a json string.  The fields within the settings json string depend on the format of the vote record.  The wallet does not need to interpret this field and should pass it unchanged to the logic used to format the vote transaction.  However, to support multiple future vote transaction formats, the `settings` must contain at least:


if the wallet doesn't validate the purpose in settings, can't a malicious actor abuse that to pass a different purpose than the one whitelisted by the wallet, causing it to sign a vote for a different purpose? If so, I'd consider removing the purpose from the settings and passing it separately, or at least specifying that the wallet should validate that field in the settings

though looking at the js bidings lib to sign votes, I don't see the purpose field being used at all: https://github.com/input-output-hk/catalyst-core/blob/f5865be9a9d227e975689e32e6c03b5b34ff5d96/src/chain-wallet-libs/bindings/wallet-wasm-js/js-test/test/vote_cast.js#L10 - what's the benefit of passing purpose in the settings parameter then?

The intent of including the purpose here is to allow wallets to validate. Wallets should be able to show the supplied purpose of a vote to user at signing time for them to validate.

…01-refactor Refactor to fit the new CIP-0001 template

Amendments from discussion on 01/26

Rescope CIP-62 to be Catalyst Focussed

Ryun1 · 2023-03-09T09:31:36Z

Motivation for last two commits:

With CIP-1694 starting the age of Voltaire, Cardano's governance is becoming clearer. We don't want this API to be confused with future protocol governance, thus the rescope to aim this specification strictly to Project Catalyst.

SebastienGllmt · 2023-05-16T08:33:19Z

CIP-0062/README.md

+
+#### Voting
+
+TODO


SebastienGllmt · 2023-05-16T08:34:59Z

CIP-0062/README.md

+
+To provide [CIP-36](https://cips.cardano.org/cips/cip36/) style governance specific functionality for Catalyst to wallet's and expose such API to the dApps (i.e Catalyst Voting Centers).
+
+This also addresses some short-comings of [CIP-30](https://cips.cardano.org/cips/cip30/); which signData can only be done by known an address; This signature is not relevant to a specific address, nor the dApp will know an address attached to the voting key. The voting key derivation is defined in [CIP-36](https://cips.cardano.org/cips/cip36/).


typo? "by known an address"

Ryun1 · 2023-11-13T15:46:02Z

At the request of the Catalyst team, I am closing this CIP for now.
They intend to completely overhaul this proposal, and will open a separate PR when ready.

ehanoc added 6 commits July 14, 2022 09:43

Jurmungandr api submitVote, connect to Node

81c7596

Jurmungandr unnecessary connectToNode

e360eb5

Removing requirement for single voting key for mnemonic. Rewording de…

ad82668

…scription enable()

Support batching of votes in api.submitVotes. Refactor multiple steps…

5cfa051

… to sign and submit delegation cert into one step api.submitDelegation

Typo, 32 bytes not 64 for ed25519 pub key

25fff85

remove reward address, nonce and staking key from delegation object. …

da74c10

…wallet should manage these internally

KtorZ added Candidate CIP labels Aug 2, 2022

KtorZ reviewed Aug 2, 2022

View reviewed changes

CIP-0062/README.md Show resolved Hide resolved

KtorZ reviewed Aug 2, 2022

View reviewed changes

CIP-0062/README.md Outdated Show resolved Hide resolved

KtorZ reviewed Aug 2, 2022

View reviewed changes

CIP-0062/README.md Outdated Show resolved Hide resolved

KtorZ reviewed Aug 2, 2022

View reviewed changes

CIP-0062/README.md Outdated Show resolved Hide resolved

KtorZ reviewed Aug 2, 2022

View reviewed changes

CIP-0062/README.md Outdated Show resolved Hide resolved

ehanoc added 2 commits August 8, 2022 11:29

Add getVotingKeys, rotateVotingKey, getCurrentVotingKey api methods t…

3c7db95

…o the API

Removing unnecessary keypath type

8e9d58f

dkijania reviewed Aug 8, 2022

View reviewed changes

CIP-0062/README.md Outdated Show resolved Hide resolved

Align naming of variables and update setup-by-step guide

20feaf3

gyorgy-kurucz-vacuum reviewed Aug 30, 2022

View reviewed changes

CIP-0062/README.md Outdated Show resolved Hide resolved

CIP-0062/README.md Outdated Show resolved Hide resolved

CIP-0062/README.md Outdated Show resolved Hide resolved

CIP-0062/README.md Outdated Show resolved Hide resolved

CIP-0062/README.md Outdated Show resolved Hide resolved

stevenj reviewed Sep 5, 2022

View reviewed changes

CIP-0062/README.md Show resolved Hide resolved

CIP-0062/README.md Show resolved Hide resolved

CIP-0062/README.md Show resolved Hide resolved

clean changes ready for merge

66d8cf1

refi93 reviewed Sep 13, 2022

View reviewed changes

CIP-0062/README.md Outdated Show resolved Hide resolved

refi93 reviewed Sep 13, 2022

View reviewed changes

CIP-0062/README.md Outdated Show resolved Hide resolved

refi93 reviewed Sep 13, 2022

View reviewed changes

CIP-0062/README.md Outdated Show resolved Hide resolved

refi93 reviewed Sep 14, 2022

View reviewed changes

Remove unnecessary rotateVotingKeys and getVotingKeys

da063a4

ehanoc force-pushed the cip-governance-wallet-connector branch from 106ff34 to da063a4 Compare September 15, 2022 06:28

Add sample data for delegation certificates and related keys

a12b8a6

refi93 reviewed Sep 15, 2022

View reviewed changes

CIP-0062/README.md Outdated Show resolved Hide resolved

ehanoc added 2 commits January 19, 2023 10:04

Merge branch 'cip-governance-wallet-connector' into cip-governance-wa…

d5d50c7

…llet-connector

Merge pull request #6 from stevenj/cip-governance-wallet-connector

591bb10

Minimum changes to generalize description and explains how to use it in any voting system (not just catalyst). Small fixes, typos.

Update CIP-0062/README.md

d931f42

Co-authored-by: Rafael Korbaš <rafael.korbas@gmail.com>

rphair mentioned this pull request Jan 19, 2023

CIP-0001 | Section heading specifications #439

Closed

rphair removed the Waiting for Author Proposal showing lack of activity or participation from their authors. label Jan 19, 2023

Ryun1 added 2 commits January 20, 2023 15:59

Refactor to match new CIP-01 requirements

d8b140b

Fixed Copyright link

9a07508

Ryun1 mentioned this pull request Jan 20, 2023

Refactor to fit the new CIP-0001 template ehanoc/CIPs#8

Merged

refi93 reviewed Jan 20, 2023

View reviewed changes

CIP-0062/README.md Outdated Show resolved Hide resolved

refi93 reviewed Jan 20, 2023

View reviewed changes

CIP-0062/README.md Outdated Show resolved Hide resolved

refi93 reviewed Jan 20, 2023

View reviewed changes

Merge pull request #8 from Ryun1/cip-governance-wallet-connector-cip-…

9bba6d6

…01-refactor Refactor to fit the new CIP-0001 template

ehanoc mentioned this pull request Jan 23, 2023

CIP-0030 | Upgrade to latest format & propose version / extension scheme #446

Merged

Ryun1 and others added 2 commits February 9, 2023 12:18

Addressed weekly meetings comments

04edd0c

Merge pull request #9 from Ryun1/cip-62-update-01-27

3db6476

Amendments from discussion on 01/26

Ryun1 mentioned this pull request Mar 7, 2023

CIP Editor Application | Ryan Williams (@Ryun1) #473

Merged

Ryun1 and others added 3 commits March 7, 2023 18:24

Rescope to Catalyst

46d6c98

Changed title to match CIP-30's naming

a00b591

Merge pull request #14 from Ryun1/cip-62-scope-catalyst

0201fd5

Rescope CIP-62 to be Catalyst Focussed

ehanoc changed the title ~~CIP-0062? | Governance API for dApp Connectors (dApps<->Wallet Web-bridge)~~ CIP-0062? | Cardano dApp-Wallet Web Bridge Catalyst Extension Mar 9, 2023

KtorZ added Category: Wallets Proposals belonging to the 'Wallets' category. and removed Candidate CIP labels Mar 18, 2023

SebastienGllmt reviewed May 16, 2023

View reviewed changes

Ryun1 closed this Nov 13, 2023

rphair mentioned this pull request May 19, 2024

Update top-level README: post meeting #88 #820

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CIP-0062? | Cardano dApp-Wallet Web Bridge Catalyst Extension #296

CIP-0062? | Cardano dApp-Wallet Web Bridge Catalyst Extension #296

ehanoc commented Jul 14, 2022 •

edited by rphair

refi93 Sep 13, 2022

Ryun1 Mar 20, 2023

refi93 Sep 14, 2022 •

edited

ehanoc Nov 30, 2022

refi93 Nov 30, 2022

ehanoc Dec 19, 2022

refi93 Sep 14, 2022 •

edited

ehanoc Dec 19, 2022

ehanoc commented Jan 19, 2023

rphair commented Jan 19, 2023 •

edited

refi93 Jan 20, 2023 •

edited

refi93 Jan 20, 2023

Ryun1 Jan 26, 2023

Ryun1 commented Mar 9, 2023 •

edited

SebastienGllmt May 16, 2023

SebastienGllmt May 16, 2023

Ryun1 commented Nov 13, 2023


		Errors: `APIError`, `TxSendError`

		## Delegation Cert process


		This api being an extension of [CIP-30 (Cardano dApp-Wallet Web Bridge)](https://cips.cardano.org/cips/cip30/), expects that `cardano.{walletName}.enable()` to be enabled and added to CIP-30 whitelist implicitly.

		When both this API and CIP-30 is being enabled, is up to the wallet to decide the number of prompts requesting permissions to be displayed to the user.


		To provide [CIP-36](https://cips.cardano.org/cips/cip36/) style governance specific functionality for Catalyst to wallet's and expose such API to the dApps (i.e Catalyst Voting Centers).

		This also addresses some short-comings of [CIP-30](https://cips.cardano.org/cips/cip30/); which signData can only be done by known an address; This signature is not relevant to a specific address, nor the dApp will know an address attached to the voting key. The voting key derivation is defined in [CIP-36](https://cips.cardano.org/cips/cip36/).


		#### Voting

		TODO

CIP-0062? | Cardano dApp-Wallet Web Bridge Catalyst Extension #296

CIP-0062? | Cardano dApp-Wallet Web Bridge Catalyst Extension #296

Conversation

ehanoc commented Jul 14, 2022 • edited by rphair

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refi93 Sep 14, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refi93 Sep 14, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ehanoc commented Jan 19, 2023

rphair commented Jan 19, 2023 • edited

refi93 Jan 20, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ryun1 commented Mar 9, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ryun1 commented Nov 13, 2023

ehanoc commented Jul 14, 2022 •

edited by rphair

refi93 Sep 14, 2022 •

edited

refi93 Sep 14, 2022 •

edited

rphair commented Jan 19, 2023 •

edited

refi93 Jan 20, 2023 •

edited

Ryun1 commented Mar 9, 2023 •

edited