feat: add portal to aa-signers #303

avasisht23 · 2023-12-04T18:26:57Z

Pull Request Checklist

Did you add new tests and confirm existing tests pass? (yarn test)
Did you update relevant docs? (docs are found in the site folder, and guidelines for updating/adding docs can be found in the contribution guide)
Do your commits follow the Conventional Commits standard?
Does your PR title also follow the Conventional Commits standard?
If you have a breaking change, is it correctly reflected in your commit message? (e.g. feat!: breaking change)
Did you run lint (yarn lint:check) and fix any issues? (yarn lint:write)
Did you follow the contribution guidelines?

PR-Codex overview

Detailed summary

Added PortalSigner to the @alchemy/aa-signers package.
Updated packages/signers/package.json to include @portal-hq/web as a dependency.
Added PortalAuthenticationParams and PortalUserInfo interfaces to packages/signers/src/portal/types.ts.
Updated templates/typescript/base.json to include "dom" in the lib array and "es2021" as the target in the compilerOptions.
Updated site/.vitepress/config.ts to include a new section for Portal Signer in the navigation menu.
Added new Markdown files for getAddress, signMessage, getAuthDetails, and authenticate methods of PortalSigner in site/packages/aa-signers/portal directory.
Updated site/packages/aa-signers/portal/guides/portal.md with installation instructions for @portal-hq/web SDK and updated code snippets.
Added PortalSigner class to packages/signers/src/portal/signer.ts with methods for getAddress, signMessage, signTypedData, and authenticate.

The following files were skipped due to too many changes: packages/signers/src/portal/signer.ts, site/packages/aa-signers/portal/signTypedData.md, site/packages/aa-signers/portal/introduction.md, site/packages/aa-signers/portal/constructor.md, packages/signers/src/portal/__tests__/signer.test.ts

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

avasisht23 · 2023-12-04T18:27:11Z

Current dependencies on/for this PR:

main
- PR docs: reorganize the sidebar #300
  - PR feat: add fireblocks to aa-signers #301
    - PR feat: add particle to aa-signers #304
      - PR feat: add capsule to aa-signers #305
    - PR feat: add portal to aa-signers #303 👈

This stack of pull requests is managed by Graphite.

avasisht23 · 2023-12-04T18:30:03Z

@moldy530 @denniswon see this post as to why this fails CI checks.

tldr; portal SDK doesn't export things properly. I've asked them to revise. When I go into node_modules myself and edit, build and tests pass.

packages/signers/src/portal/signer.ts

moldy530 · 2023-12-05T21:07:03Z

site/snippets/portal.ts

-  autoApprove: true,
-  gatewayConfig: `${polygonMumbai.rpcUrls.alchemy.http}/${process.env.ALCHEMY_API_KEY}`,
-  chainId: 80001,
-  host: process.env.PORTAL_WEB_HOST,


is this not necessary anymore?

nope it was optional on their constructor params, but fair can add it back if necessary

moldy530 · 2023-12-05T21:07:53Z

templates/typescript/base.json

@@ -2,7 +2,7 @@
  "$schema": "https://json.schemastore.org/tsconfig",
  "display": "Default",
  "compilerOptions": {
-    "lib": ["es2022"],
+    "lib": ["es2022", "dom"],


why do we need this?

yeah I forgot to send the screenshot, but portal has a bunch of window/dom-related elements in their SDK. I had to add this to build, other was "window not defined" related errors when trying to build.

We'll update our docs to include that the Portal SDK requires this!

dscrobonia · 2023-12-11T18:14:50Z

packages/signers/src/portal/types.ts

+
+export interface PortalAuthenticationParams {}
+
+// taken from Portal SDK since not exported


We can export this for y'all!

We'll queue up an update.

dscrobonia

Looks good!

moldy530

had small nit, but LGTM otherwise

moldy530 · 2023-12-12T00:01:58Z

packages/signers/src/portal/signer.ts

+  };
+
+  authenticate = async () => {
+    this.signer = new WalletClientSigner(


why not just create this in the constructor and have authenticate return this.getAuthDetails?

just for convention, because we want the dev to call authenticate before calling getAddress, sendMessage, etc. like is necessary with the other signers

avasisht23 requested review from moldy530, rthomare, dancoombs, mokok123 and denniswon as code owners December 4, 2023 18:26

This was referenced Dec 4, 2023

docs: reorganize the sidebar #300

Merged

feat: add fireblocks to aa-signers #301

Merged

avasisht23 force-pushed the 12-03-feat_add_fireblocks_to_aa-signers branch from 8ee5ca3 to dee199a Compare December 4, 2023 19:42

avasisht23 force-pushed the 12-04-feat_add_portal_to_aa-signers branch from 33bc19c to ce64f04 Compare December 4, 2023 19:42

avasisht23 mentioned this pull request Dec 4, 2023

feat: add particle to aa-signers #304

Merged

7 tasks

avasisht23 force-pushed the 12-03-feat_add_fireblocks_to_aa-signers branch from dee199a to ccdca68 Compare December 4, 2023 19:44

avasisht23 force-pushed the 12-04-feat_add_portal_to_aa-signers branch from ce64f04 to d072eb3 Compare December 4, 2023 19:44

avasisht23 force-pushed the 12-03-feat_add_fireblocks_to_aa-signers branch from ccdca68 to e55a747 Compare December 4, 2023 21:57

avasisht23 force-pushed the 12-04-feat_add_portal_to_aa-signers branch from d072eb3 to 1b2c722 Compare December 4, 2023 21:57

avasisht23 mentioned this pull request Dec 5, 2023

feat: add capsule to aa-signers #305

Merged

7 tasks

moldy530 reviewed Dec 5, 2023

View reviewed changes

packages/signers/src/portal/signer.ts Outdated Show resolved Hide resolved

moldy530 reviewed Dec 5, 2023

View reviewed changes

avasisht23 force-pushed the 12-04-feat_add_portal_to_aa-signers branch from 1b2c722 to f9ab1a3 Compare December 7, 2023 22:18

avasisht23 force-pushed the 12-03-feat_add_fireblocks_to_aa-signers branch from f369f33 to 6f369aa Compare December 11, 2023 18:31

avasisht23 force-pushed the 12-04-feat_add_portal_to_aa-signers branch from f9ab1a3 to 6352450 Compare December 11, 2023 18:31

dscrobonia reviewed Dec 11, 2023

View reviewed changes

avasisht23 force-pushed the 12-04-feat_add_portal_to_aa-signers branch from 6352450 to 92e0783 Compare December 11, 2023 19:54

Base automatically changed from 12-03-feat_add_fireblocks_to_aa-signers to main December 11, 2023 20:04

avasisht23 force-pushed the 12-04-feat_add_portal_to_aa-signers branch from 92e0783 to a222990 Compare December 11, 2023 20:08

avasisht23 added 3 commits December 11, 2023 15:36

feat: add portal to aa-signers

ab11d5b

feat: add portal to aa-signers

c0f9dd1

feat: add portal to aa-signers

dacceee

avasisht23 added 4 commits December 11, 2023 15:37

feat: add portal to aa-signers

3c3fd1c

feat: add portal to aa-signers

cadd82f

feat: bump portal version to build

25ef3af

feat: remove unneeded check

926fd84

avasisht23 force-pushed the 12-04-feat_add_portal_to_aa-signers branch from f62b803 to 926fd84 Compare December 11, 2023 20:38

dscrobonia reviewed Dec 11, 2023

View reviewed changes

moldy530 approved these changes Dec 12, 2023

View reviewed changes

avasisht23 merged commit eb8a0c3 into main Dec 12, 2023
4 checks passed

avasisht23 deleted the 12-04-feat_add_portal_to_aa-signers branch December 12, 2023 00:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add portal to aa-signers #303

feat: add portal to aa-signers #303

avasisht23 commented Dec 4, 2023 •

edited by pr-codex bot

avasisht23 commented Dec 4, 2023 •

edited

avasisht23 commented Dec 4, 2023 •

edited

moldy530 Dec 5, 2023

avasisht23 Dec 5, 2023

moldy530 Dec 5, 2023

avasisht23 Dec 5, 2023

dscrobonia Dec 11, 2023

dscrobonia Dec 11, 2023

dscrobonia Dec 11, 2023

dscrobonia left a comment

moldy530 left a comment

moldy530 Dec 12, 2023

avasisht23 Dec 12, 2023


		export interface PortalAuthenticationParams {}

		// taken from Portal SDK since not exported

feat: add portal to aa-signers #303

feat: add portal to aa-signers #303

Conversation

avasisht23 commented Dec 4, 2023 • edited by pr-codex bot

Pull Request Checklist

PR-Codex overview

Detailed summary

avasisht23 commented Dec 4, 2023 • edited

avasisht23 commented Dec 4, 2023 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dscrobonia left a comment

Choose a reason for hiding this comment

moldy530 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

avasisht23 commented Dec 4, 2023 •

edited by pr-codex bot

avasisht23 commented Dec 4, 2023 •

edited

avasisht23 commented Dec 4, 2023 •

edited