feat: Add `signInMulti` method #811

kujtimprenkuSQA · 2023-05-19T12:33:44Z

Description

This PR is about adding the signInMulti method to the public API of the wallets in Wallet Selector based on near/NEPs#428 .

Added interfaces in wallet.types for the signInMulti.
Added signInMulti in each wallet, it initially throws when calling this method.
Added logic in the core package to allow sign-in with multiple contracts.
Updated modal-ui and modal-ui-js to pass the list of contracts to the signInMulti method.
Added docs for signInMulti.

Wallets that support `signInMulti` in this PR

none

Checklist:

I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings

Type of change.

MaximusHaximus

Added comments around keeping state for signInMulti() separate from signIn() -- we need to make sure that a combination of signIn() and signInMulti() being called with the same contracts will result in sane and deterministic behaviour.

MaximusHaximus · 2023-06-26T12:33:28Z

packages/core/src/lib/services/wallet-modules/wallet-modules.service.ts

+      return accounts;
+    };
+
+    wallet.signInMulti = async (params: never) => {


Rather than having every wallet module be required by convention to implement a signInMulti() method that throw's an error if it isn't supported, can we instead not add a signInMulti() method in the modules that do not support it, and make this decorator check if the method exists and throw the error

throw new Error( `The signInMulti method is not supported by ${metadata.name}` );

if it hasn't been implemented?

This has two benefits:

If any wallet module doesn't implement the method for whatever reason, callers will always get a consistent error thrown instead of there being a '_signInMulti() is not a function' type of error thrown from our attempt to call it in those cases

We don't need to inform wallet module authors about the need to add a stub, ensure their modules have the stub during code reviews, etc. -- we can treat the lack of implementation as a 'not supported'.

Addressed it in this commit: 8121e5e

MaximusHaximus · 2023-06-26T12:40:13Z

packages/core/src/lib/store.types.ts

+  /**
+   * The list of contracts when SignInMulti is supported.
+   */
+  contracts: MultiContractState | null;


We need to handle cases where:

A dapp might call signIn() for a contract that was previously signed into using signInMulti(). For example, let's say that a dapp uses 3 contracts regularly, and their access key allowance expires for just one of those three contracts. The dapp author does not need to request the user re-signIn to all 3 contracts using signInMulti() -- they would just request signIn() for the one contract whose allowance has been used up.

A dapp might call signInMulti() with an array that includes a contract that they had previously signed in to using signIn()

If we always store results from signInMulti() in contracts and results from signIn() in contract, we will end up with duplicate entries in these keys when a mixture of calls is used by the dapp developer -- we need to have one-and-only-one entry for a given contract across these two fields (contract and contracts) to make sure everything is sane and deterministic.

This PR should solve these issues: #847

…ting wallet if it does not exist.

ailisp · 2023-08-18T06:55:41Z

Hi @kujtimprenkuSQA @MaximusHaximus What is the status of this PR? Our team is recently tried to add a relevant feature and discovered this. WIP branch. I wonder if we can move this forward

kujtimprenkuSQA · 2023-08-18T08:49:51Z

Hi @kujtimprenkuSQA @MaximusHaximus What is the status of this PR? Our team is recently tried to add a relevant feature and discovered this. WIP branch. I wonder if we can move this forward

Hi, this PR is not ready to be merged yet as we still need this additional PR #847 related to the comment #811 (comment) to be reviewed and make a decision if we should go with it or not since it will introduce breaking changes in Wallet Selector.

As of right now, we are not aware if any wallet supports the signInMulti.
For browser wallets I think this update in NAJ is needed: near/near-api-js#1153 there was some work done related to it: near/near-api-js#1163

petersalomonsen · 2023-08-18T15:23:06Z

OK, so maybe I may move forward with my experiments in here then: #887 ?

This approach does not require change in wallets, and does not introduce any breaking change to the wallet selector. It simply offers the option to add a function access key to another contract, and store it in a separate keystore ( near-api-js supports multiple keystore with different prefixes ).

As you can see from the test case there's a new method addContractConnection that you can call to add a function access key to an additional contract and store it locally.

For the particular issue for NEAR DevHub the idea is then to create the access key for the devhub contract when you submit something for the first time, and then reuse that access keys for later calls. This way, the user could also authenticate with other contracts on demand.

cc @ailisp @frol

petersalomonsen · 2023-08-20T11:03:45Z

See a proof of concept demo video here ( for the wallet-selector guestbook ):

https://www.youtube.com/watch?v=ocZKP2-Lxes

ailisp · 2023-09-04T02:30:53Z

@petersalomonsen the demo is very cool! I wonder how can we invoke wallet.addContractConnection from the DevHub widget, since there is no BOS api to access wallet directly

petersalomonsen · 2023-09-04T16:27:09Z

@petersalomonsen the demo is very cool! I wonder how can we invoke wallet.addContractConnection from the DevHub widget, since there is no BOS api to access wallet directly

@ailisp thanks, and actually you don't need to invoke that from the DevHub widget. This should be handled by the nearsocial viewer ( or maybe VM ) so that it detects if there's a wallet redirection, and then offers to add a function access key for that contract. Here's an example of how I've added this to the viewer for my PoC with the DevHub widget: https://github.com/NearSocial/viewer/pull/189/files

And this is also what's used in the demo you can see here: https://youtu.be/DVoZK5CJ2uE

…llet-selector into SQC-540/add-signin-multi

petarvujovic98 · 2023-09-21T09:28:13Z

What is the plan for this feature moving forward? Any timeline estimates or prediction of when it could be available?

kujtimprenkuSQA · 2023-09-22T10:00:00Z

What is the plan for this feature moving forward? Any timeline estimates or prediction of when it could be available?

The initial work for adding the signInMulti into the wallet-selector has been done in this PR, but to address the comment left here #811 (comment) there was a need to make some additional changes #847 that would be breaking changes in wallet-selector.

We still need a review from Pagoda and further discuss this implementation before it's merged.

As mentioned in the above comments the currently available keystores will have to catch up in order to support multiple keys per account near/near-api-js#1153 there was some work done related to it: near/near-api-js#1163

kujtimprenkuSQA added 9 commits May 19, 2023 09:40

Added interfaces for signInMulti in wallet types.

264f904

Add signInMulti method to each wallet.

627d59b

Merge branch 'dev' into SQC-540/add-signin-multi

142ecb3

Fix jsdoc warnings and improved docs.

d40159a

Added logic to allow sign-in with multiple contracts.

35448f4

Fix build for here wallet.

60ac5a0

Added contracts to ModalOptions interface.

6e3d5f3

Added logic to handle signInMulti in modal-ui and modal-ui-js.

512f12b

Added docs for .

fb519ea

kujtimprenkuSQA marked this pull request as ready for review May 23, 2023 08:20

github-actions bot changed the title ~~Add signInMulti method~~ feat: Add signInMulti method May 23, 2023

kujtimprenkuSQA requested review from HarisSQA and DamirSQA May 23, 2023 08:49

kujtimprenkuSQA added 3 commits May 23, 2023 13:13

Fix docs since permissions is required for signInMulti.

5f6bfd4

Remove contracts from setupModal in angular example.

da54351

Export MultiContractState interface.

72b83e5

DamirSQA previously approved these changes May 23, 2023

View reviewed changes

This was referenced May 25, 2023

Make account optional for SignInParams and SignInMultiParams on Injected Wallets near/NEPs#484

Open

Add support for signing in to more than one contract at once to Injected Wallet Standard near/NEPs#428

Merged

amirsaran3 previously approved these changes May 29, 2023

View reviewed changes

MaximusHaximus suggested changes Jun 26, 2023

View reviewed changes

kujtimprenkuSQA added 2 commits June 27, 2023 12:49

Removed signInMulti from inside the modules instead throw when decora…

8121e5e

…ting wallet if it does not exist.

Merge branch 'dev' into SQC-540/add-signin-multi

f910c39

kujtimprenkuSQA dismissed stale reviews from amirsaran3 and DamirSQA via f910c39 June 27, 2023 10:55

amirsaran3 mentioned this pull request Jul 3, 2023

Removed contractId and added made contracts required, signAndSendTran… #847

Open

14 tasks

kujtimprenkuSQA added 2 commits July 20, 2023 18:14

Merge branch 'dev' into SQC-540/add-signin-multi

1188905

Merge branch 'dev' into SQC-540/add-signin-multi

47bedc6

AmmarHumackicSQA mentioned this pull request Jul 24, 2023

[Research] Multiple contract support #403

Closed

kujtimprenkuSQA mentioned this pull request Aug 1, 2023

feat: Add signMessage method #779

Merged

14 tasks

petersalomonsen mentioned this pull request Aug 17, 2023

Avoid a need to confirm every DevHub post/like through a Wallet NEAR-DevHub/neardevhub-bos#137

Closed

kujtimprenkuSQA mentioned this pull request Aug 18, 2023

add function access keys to additional contracts by using multiple key stores #887

Closed

AmmarHumackicSQA requested a review from MaximusHaximus September 7, 2023 17:48

This was referenced Sep 13, 2023

NEP-428 Wallet Selector Interface #917

Open

Review PR #887 (add function access keys to additional contracts by using multiple key stores) #920

Closed

kujtimprenkuSQA added 2 commits September 18, 2023 16:38

Merge branch 'SQC-540/add-signin-multi' of https://github.com/near/wa…

9c487aa

…llet-selector into SQC-540/add-signin-multi

Merge branch 'dev' into SQC-540/add-signin-multi

8433139

Merge branch 'dev' into SQC-540/add-signin-multi

45da765

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add `signInMulti` method #811

feat: Add `signInMulti` method #811

kujtimprenkuSQA commented May 19, 2023 •

edited

MaximusHaximus left a comment

MaximusHaximus Jun 26, 2023

kujtimprenkuSQA Jun 27, 2023

MaximusHaximus Jun 26, 2023

amirsaran3 Jul 5, 2023

ailisp commented Aug 18, 2023 •

edited

kujtimprenkuSQA commented Aug 18, 2023

petersalomonsen commented Aug 18, 2023

petersalomonsen commented Aug 20, 2023

ailisp commented Sep 4, 2023

petersalomonsen commented Sep 4, 2023

petarvujovic98 commented Sep 21, 2023

kujtimprenkuSQA commented Sep 22, 2023

feat: Add signInMulti method #811

Are you sure you want to change the base?

feat: Add signInMulti method #811

Conversation

kujtimprenkuSQA commented May 19, 2023 • edited

Description

Wallets that support signInMulti in this PR

Checklist:

Type of change.

MaximusHaximus left a comment

Choose a reason for hiding this comment

MaximusHaximus Jun 26, 2023

Choose a reason for hiding this comment

kujtimprenkuSQA Jun 27, 2023

Choose a reason for hiding this comment

MaximusHaximus Jun 26, 2023

Choose a reason for hiding this comment

amirsaran3 Jul 5, 2023

Choose a reason for hiding this comment

ailisp commented Aug 18, 2023 • edited

kujtimprenkuSQA commented Aug 18, 2023

petersalomonsen commented Aug 18, 2023

petersalomonsen commented Aug 20, 2023

ailisp commented Sep 4, 2023

petersalomonsen commented Sep 4, 2023

petarvujovic98 commented Sep 21, 2023

kujtimprenkuSQA commented Sep 22, 2023

feat: Add `signInMulti` method #811

feat: Add `signInMulti` method #811

kujtimprenkuSQA commented May 19, 2023 •

edited

Wallets that support `signInMulti` in this PR

ailisp commented Aug 18, 2023 •

edited