EIP-0012 - dApp-Wallet Web Bridge #23

rooooooooob · 2020-08-10T12:42:54Z

Technical spec for wallet-dApp communication.

eip-0012.md

kushti · 2020-08-11T13:06:32Z

eip-0012.md

+
+### Value
+
+BigNum-like object. Represents a value which may or may not be ERG. Value is in the smallest possible unit (e.g. nanoErg for ERG). It can be either a `number` or a `string` using standard unsigned integer text representation.


Value is a positive but encoded as i64 number actually.

@kushti Actually it was a "raw" u64 initially, but now I made a newtype BoxValue(u64)

If it's positive somewhere (even if Long/i64 encoded), then it should be fine as-is here, right? I didn't look into how Scala handles Long deserialization from JSON for numbers too big to fit, but in sigma-rust the wrapped u64 should take in a string-encoded uint like "1053546432154" afaik. Please correct me if I'm wrong and this should be changed.

Scala representation of Long is signed, so max value is 2^63-1.

For JSON deserialization in the full node is this description fine though? Wouldn't the max possible value for nanoergs be much smaller than this? I guess for other token types it could be relevant - in which case should we keep it as-is but specify that it cant' be more than a 64-bit signed number or what?

eip-0012.md

gagarin55 · 2021-01-17T05:12:42Z

I suggest you to specify data types in language independent way, not types from sigma-rust implementation

rooooooooob · 2021-02-04T02:52:39Z

I suggest you to specify data types in language independent way, not types from sigma-rust implementation

We do specify the types in language-independant JSON. This was intended to mirror what sigma-rust had at the time for ease of interopability, but they are specified at the bottom of the document.

…ementation of it in Yoroi. Type definitions are specified using flow types now instead of some pseudo JS schema. API errors are added to all API calls to handle things that can go wrong for any call,e.g. internal error in the wallet, incorrect params specified to API calls. get_change_address() was added as an explicit API since it should be easy to support and allows for an easier way during tx creation rather than arbitrarily choosing an address from the used or unused API calls, which aren't garuanteed to be non-empty. add_external_box was removed as we are still unsure how any wallets would be able to implement it in any meaningful way. This could be reversed and have most wallets treat it as a no-op.

rooooooooob · 2021-03-12T11:53:08Z

I made some minor changes based on issues encountered during our initial implementation inside of Yoroi:

Type definitions are specified using flow types now instead of some
pseudo JS schema.

API errors are added to all API calls to handle things that can go wrong
for any call,e.g. internal error in the wallet, incorrect params
specified to API calls.

get_change_address() was added as an explicit API since it should be
easy to support and allows for an easier way during tx creation rather
than arbitrarily choosing an address from the used or unused API calls,
which aren't guaranteed to be non-empty.

add_external_box() was removed as we are still unsure how any wallets
would be able to implement it in any meaningful way. This could be
reversed and have most wallets treat it as a no-op.

We removed BoxCandidate in favor of just Box to make things simpler. It also allows interop with sigma-rust/full nodes for now.

It would be ideal to not reference sigma-rust in any way for things that are more specific than just the underlying javascript type for example:

Uses `sigma-rust` rep - Hex-encoded bytes for `SigmaSerialize` of a constant.

which specify things like encoding, length, etc.

eip-0012.md

The id field has been removed, as well as the tx id/box id from outputs which are now BoxCandidates. This was only used before to help with interop with exisitng tooling but now that sigma-rust no longer requires these there's no reason to keep them around. They only made it more difficult to construct an unsigned transaction. Now one can be a lot more easily constructed even without using other tooling to calculate the IDs/etc.

rooooooooob · 2021-05-31T18:12:07Z

BoxCandidate was restored as it was only removed to ease support with sigma-rust/for simplicity, but the additional information was never necessary. Now that the data model was updated in sigma-rust it makes more sense to revert that change to the original BoxCandidate model and remove tx IDs from the unsigned Tx which makes it potentially easier to construct by the dApp.

Full box contents are now included in UnsignedTransaction to help light wallets support P2S inputs + for all wallets in processing recently created outputs. Wallets can check that the content matches the ID so there should be no security issues with that.

eip-0012.md

typo in type name Co-authored-by: Denys Zadorozhnyi <[email protected]>

greenhat · 2021-07-22T14:08:46Z

eip-0012.md

+
+### Box
+
+Transaction output box. Format is the same as `sigma-rust`:


There is no Box in sigma-rust. I suppose ErgoBox is meant here.

greenhat · 2021-07-22T14:09:45Z

eip-0012.md

+
+A candidate (no TX/box IDs) for an output in an `UnsignedTransaction`
+```
+type BoxCandidate = {|


Probably should mention that it's ErgoBoxCandidate in sigma-rust?

greenhat · 2021-07-22T14:11:40Z

eip-0012.md

+
+### SignedTx
+
+Uses `sigma-rust` rep for a transaction:


Suggested change

Uses `sigma-rust` rep for a transaction:

Uses `sigma-rust` `Transaction` rep for a transaction:

rooooooooob · 2021-08-26T03:14:09Z

We're currently also developing a similar spec to this for Cardano here. There has been a lot of discussion there, some of which is relevant to Ergo. Here are some things that we might want to cover here too:

Handling multiple wallets installed (for Cardano we solve this by injecting into a namespaced object - for Ethereum they just tell you to only have one installed e.g. MetaMask)
Versioning (i.e. if this spec gets updated and some API changes)
Phishing prevention (this could be assumed to be a wallet implementation detail, e.g. showing some user-known secret image in connector popups to stop phishing sites from creating similar looking popups to a user's wallet to farm passwords or other info)

capt-nemo429 · 2022-01-19T13:13:17Z

eip-0012.md

+
+The proposed API is limited to just the minimum wallet <-> dApp communication needed rather than providing lots of utility functions (tx building, data conversions, etc) or node-access (for UTXO scanning). This is different compared to web3 as that functionality could be modular in a separate library and Ergo smart contracts don't need as much direct node access for basic dApp functionality compared to Ethereum.
+
+This API is accessible from a javascript object `ergo` that is injected into the web context upon wallet consent. Before this just the free `ergo_request_read_access()` and `ergo_check_read_access()` functions are injected into the web context. An event handler can also be registered to the web context to detect wallet disconnects tagged as `"ergo_wallet_disconnected"`.


In order to avoid conflicts with multiple wallets, can we do a slight change on the access API? Maybe something like ergo.{walletName}.requestReadAccess() and ergo.{walletName}.checkReadAccess()

Yeah that's what we ended up doing for CIP-0030 for Cardano which I based off of this. I'm not sure if it's fine to do such a breaking change at this point since this has been up for a long time although it's still a draft PR. I'll wait and see what the Ergo devs think about this. We also don't have any functionality for versioning either. I mentioned both of these in my comment above in August. There are additional events that can be of use for dApps as well that could be added.

Agree with @capt-nemo429 . Explicitly distinguishing wallets in the dApp connector API is a crucial feature. Shouldn't be too problematic to migrate.

eip-0012.md

Initial draft of EIP-0012

720b188

Technical spec for wallet-dApp communication.

rooooooooob marked this pull request as draft August 10, 2020 12:47

kushti requested changes Aug 11, 2020

View reviewed changes

responding to comments

c745a55

rooooooooob mentioned this pull request Mar 16, 2021

Connector: disconnects Emurgo/yoroi-frontend#1994

Merged

SebastienGllmt reviewed Apr 12, 2021

View reviewed changes

eip-0012.md Show resolved Hide resolved

rooooooooob mentioned this pull request Apr 30, 2021

CIP-0030 | Dapp-Connector cardano-foundation/CIPs#88

Merged

rooooooooob added 2 commits May 31, 2021 12:44

Include full box information in UnsignedInput

3feb014

greenhat reviewed Jun 1, 2021

View reviewed changes

eip-0012.md Outdated Show resolved Hide resolved

rooooooooob mentioned this pull request Jun 9, 2021

API and DApps integration Emurgo/yoroi-frontend#2155

Closed

Update eip-0012.md

b70f406

typo in type name Co-authored-by: Denys Zadorozhnyi <[email protected]>

This was referenced Jul 21, 2021

EIP-12: Encode/decode box value and token amount from JSON as either a number or a string ergoplatform/sigma-rust#346

Merged

Check EIP-12 PR and find out what is missing in sigma-rust ergoplatform/sigma-rust#347

Closed

greenhat reviewed Jul 22, 2021

View reviewed changes

rooooooooob mentioned this pull request Sep 14, 2021

cardano dapp-connector status Emurgo/yoroi-frontend#2364

Open

capt-nemo429 reviewed Jan 19, 2022

View reviewed changes

MrStahlfelge requested changes Dec 5, 2022

View reviewed changes

eip-0012.md Show resolved Hide resolved

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EIP-0012 - dApp-Wallet Web Bridge #23

EIP-0012 - dApp-Wallet Web Bridge #23

rooooooooob commented Aug 10, 2020

kushti Aug 11, 2020

greenhat Aug 11, 2020

rooooooooob Aug 12, 2020

kushti Aug 17, 2020

rooooooooob Aug 19, 2020

gagarin55 commented Jan 17, 2021

rooooooooob commented Feb 4, 2021

rooooooooob commented Mar 12, 2021

rooooooooob commented May 31, 2021

greenhat Jul 22, 2021

greenhat Jul 22, 2021 •

edited

Loading

greenhat Jul 22, 2021

rooooooooob commented Aug 26, 2021

capt-nemo429 Jan 19, 2022

rooooooooob Jan 20, 2022

oskin1 Jan 20, 2022


		### Value

		BigNum-like object. Represents a value which may or may not be ERG. Value is in the smallest possible unit (e.g. nanoErg for ERG). It can be either a `number` or a `string` using standard unsigned integer text representation.


		### Box

		Transaction output box. Format is the same as `sigma-rust`:

	Uses `sigma-rust` rep for a transaction:
	Uses `sigma-rust` `Transaction` rep for a transaction:


		The proposed API is limited to just the minimum wallet <-> dApp communication needed rather than providing lots of utility functions (tx building, data conversions, etc) or node-access (for UTXO scanning). This is different compared to web3 as that functionality could be modular in a separate library and Ergo smart contracts don't need as much direct node access for basic dApp functionality compared to Ethereum.

		This API is accessible from a javascript object `ergo` that is injected into the web context upon wallet consent. Before this just the free `ergo_request_read_access()` and `ergo_check_read_access()` functions are injected into the web context. An event handler can also be registered to the web context to detect wallet disconnects tagged as `"ergo_wallet_disconnected"`.

EIP-0012 - dApp-Wallet Web Bridge #23

Are you sure you want to change the base?

EIP-0012 - dApp-Wallet Web Bridge #23

Conversation

rooooooooob commented Aug 10, 2020

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

Choose a reason for hiding this comment

gagarin55 commented Jan 17, 2021

rooooooooob commented Feb 4, 2021

rooooooooob commented Mar 12, 2021

rooooooooob commented May 31, 2021

Choose a reason for hiding this comment

greenhat Jul 22, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rooooooooob commented Aug 26, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greenhat Jul 22, 2021 •

edited

Loading