Add Caip Types #116

jiexi · 2023-07-12T23:34:48Z

Add Caip types from @metamask/snaps-utils

See: MetaMask/core#1489
See: MetaMask/metamask-extension#19991

src/caip-chaid-id.test-d.ts

src/caip-chain-id.ts

mcmire · 2023-07-13T16:55:43Z

@jiexi Do you mind renaming the title of this PR so that it will be easier to understand at-a-glance in the commit history later on?

mcmire

Hey @jiexi, I had some comments below.

I know your PR on the extension side is in flux but I think to understand this PR better it'd be nice to know how you plan on using these functions and tools — could you talk about that a bit?

src/caip-chain-id.ts

src/caip-chaid-id.test-d.ts

hmalik88

What's the motivation behind re-doing the work that already exists in @metamask/snaps-utils? https://github.com/MetaMask/snaps/blob/main/packages/snaps-utils/src/namespace.ts

jiexi · 2023-07-20T18:25:21Z

What's the motivation behind re-doing the work that already exists in @metamask/snaps-utils? https://github.com/MetaMask/snaps/blob/main/packages/snaps-utils/src/namespace.ts

Nice, @hmalik88 ! Didn't know that this was already done. Looks wonderful! I feel like the term "Chain ID" is pretty overloaded now. I don't believe Namespace nor Reference are very clear terms either even though they are the terms used in the CAIP specs. What are your thoughts on this? I think renaming the types to include a Caip prefix would help make this less ambiguous. Moving the Caip types from @metamask/snap-utils to @metamask/utils might make more sense as well given this will be more applicable to entirety of metamask as we shift towards multichain

hmalik88 · 2023-07-20T19:54:53Z

@jiexi You're right, it is an overloaded term. We're releasing the name resolver API soon and I was going to make some type changes. Perhaps you're right that we may want to prefix with Caip, but that also means we're making a distinction internally. In what contexts are we using Chain ID? Seems sensible to move to utils, these types were mostly added when our team was doing keyrings work ~ 10 months ago.

jiexi · 2023-07-20T22:17:59Z

@hmalik88 I'm currently trying to replace our usage of Eth chain id with CAIP chain id. I'm in the process of replacing chainId (eth, decimal or hex) with caipChainId in all of core and extension, so soon all contexts will include CAIP chain id.

Do you happen to know if there is an estimate for when these changes will be available?

src/caip-types.ts

jiexi · 2023-07-26T21:43:05Z

I've scrapped my types and brought in Caip types from @metamask/snaps-utils. The plan is to make this the new home for these types and to update all usage of @snap-utils to caip types to this new one

src/caip-types.ts

jiexi · 2023-07-28T18:22:26Z

Okay. pretty happy with this now

jiexi · 2023-07-28T18:23:06Z

@metamaskbot publish-preview

adonesky1 · 2023-07-31T00:07:05Z

LGTM, however I defer to @hmalik88 and @mcmire if they have any outstanding concerns

mcmire

Just had a couple of questions, but this all seems reasonable to me.

mcmire · 2023-07-31T17:27:28Z

src/caip-types.test-d.ts

+// Valid caip strings:
+
+expectAssignable<CaipChainId>('namespace:reference');
+expectAssignable<CaipChainId>('namespace:');


I'm assuming that this is non-enforceable via TypeScript, is that correct?

Unfortunately not. We could try to hack it by doing something like this

type Character = "a" | "b" | "c" | "d" | "e" | "f" | "g" | ... export type CaipChainId = `${Character}${string}:${Character}${string}`;

But I believe this makes a type with n^2 definitions since they get crossmulitplied

mcmire · 2023-07-31T17:28:41Z

src/caip-types.test-d.ts

+expectAssignable<CaipReference>(`${embeddedString}`);
+
+expectAssignable<CaipAccountId>('namespace:reference:accountAddress');
+expectAssignable<CaipAccountId>('namespace:reference:');


Similar as above — I'm assuming this is non-enforceable via TypeScript?

hmalik88

LGTM

jiexi added 2 commits July 12, 2023 14:29

add caip chain id

7e5ef64

add parsing

05127fc

jiexi requested a review from a team as a code owner July 12, 2023 23:34

jiexi commented Jul 12, 2023

View reviewed changes

src/caip-chaid-id.test-d.ts Outdated Show resolved Hide resolved

jiexi commented Jul 12, 2023

View reviewed changes

src/caip-chain-id.ts Outdated Show resolved Hide resolved

jiexi commented Jul 12, 2023

View reviewed changes

src/caip-chain-id.ts Outdated Show resolved Hide resolved

jiexi commented Jul 12, 2023

View reviewed changes

src/caip-chain-id.ts Outdated Show resolved Hide resolved

Update parseCaipChainIdString behavior

0478ad2

This was referenced Jul 12, 2023

CAIP-2 Chain ID MetaMask/metamask-extension#19991

Closed

CAIP-2 Chain ID MetaMask/core#1489

Closed

lint

0304a09

mcmire reviewed Jul 13, 2023

View reviewed changes

src/caip-chain-id.ts Outdated Show resolved Hide resolved

src/caip-chain-id.ts Outdated Show resolved Hide resolved

src/caip-chain-id.ts Outdated Show resolved Hide resolved

src/caip-chain-id.ts Outdated Show resolved Hide resolved

jiexi changed the title ~~Jl/mmp 901/caip 2~~ Add CaipChainId Jul 18, 2023

jiexi added 2 commits July 18, 2023 15:00

drop string suffix

782e4fb

Merge branch 'main' into jl/mmp-901/caip-2

6d09fb6

adonesky1 reviewed Jul 19, 2023

View reviewed changes

src/caip-chaid-id.test-d.ts Outdated Show resolved Hide resolved

hmalik88 reviewed Jul 19, 2023

View reviewed changes

Switch to @metamask/snap-utils caip types

c2a686c

jiexi changed the title ~~Add CaipChainId~~ Add Caip Types Jul 26, 2023

jiexi commented Jul 26, 2023

View reviewed changes

src/caip-types.ts Outdated Show resolved Hide resolved

jiexi commented Jul 26, 2023

View reviewed changes

src/caip-types.ts Outdated Show resolved Hide resolved

jiexi commented Jul 26, 2023

View reviewed changes

src/caip-types.ts Outdated Show resolved Hide resolved

jiexi added 2 commits July 26, 2023 14:38

lint

488863c

Merge branch 'main' into jl/mmp-901/caip-2

a171671

jiexi requested a review from mcmire July 26, 2023 21:43

jiexi requested review from hmalik88 and adonesky1 July 26, 2023 21:43

jiexi mentioned this pull request Jul 26, 2023

Use Caip Chain ID MetaMask/smart-transactions-controller#184

Closed

hmalik88 reviewed Jul 27, 2023

View reviewed changes

src/caip-types.ts Show resolved Hide resolved

hmalik88 reviewed Jul 27, 2023

View reviewed changes

src/caip-types.ts Outdated Show resolved Hide resolved

hmalik88 reviewed Jul 27, 2023

View reviewed changes

src/caip-types.ts Outdated Show resolved Hide resolved

hmalik88 reviewed Jul 27, 2023

View reviewed changes

src/caip-types.ts Outdated Show resolved Hide resolved

hmalik88 reviewed Jul 27, 2023

View reviewed changes

src/caip-types.ts Outdated Show resolved Hide resolved

jiexi added 2 commits July 27, 2023 14:56

Separate regex const. Add CaipAccountAddressStruct

621e8ae

Add CaipAccountAddress specs

192ebbf

jiexi commented Jul 28, 2023

View reviewed changes

src/caip-types.ts Outdated Show resolved Hide resolved

tighten types

253c92b

jiexi commented Jul 28, 2023

View reviewed changes

src/caip-types.ts Outdated Show resolved Hide resolved

jiexi commented Jul 28, 2023

View reviewed changes

src/caip-types.ts Outdated Show resolved Hide resolved

jiexi commented Jul 28, 2023

View reviewed changes

src/caip-types.ts Show resolved Hide resolved

jiexi added 2 commits July 28, 2023 11:19

remove unused types. cleanup specs. add fixtures

2668bb1

last bit

a70473a

jiexi requested a review from hmalik88 July 28, 2023 18:22

mcmire approved these changes Jul 31, 2023

View reviewed changes

hmalik88 approved these changes Aug 1, 2023

View reviewed changes

adonesky1 merged commit 2653a1a into main Aug 1, 2023
19 checks passed

adonesky1 deleted the jl/mmp-901/caip-2 branch August 1, 2023 14:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Caip Types #116

Add Caip Types #116

jiexi commented Jul 12, 2023 •

edited

Loading

mcmire commented Jul 13, 2023

mcmire left a comment

hmalik88 left a comment

jiexi commented Jul 20, 2023

hmalik88 commented Jul 20, 2023

jiexi commented Jul 20, 2023

jiexi commented Jul 26, 2023

jiexi commented Jul 28, 2023

jiexi commented Jul 28, 2023

adonesky1 commented Jul 31, 2023

mcmire left a comment

mcmire Jul 31, 2023

jiexi Jul 31, 2023

mcmire Jul 31, 2023

jiexi Jul 31, 2023

hmalik88 left a comment

Add Caip Types #116

Add Caip Types #116

Conversation

jiexi commented Jul 12, 2023 • edited Loading

mcmire commented Jul 13, 2023

mcmire left a comment

Choose a reason for hiding this comment

hmalik88 left a comment

Choose a reason for hiding this comment

jiexi commented Jul 20, 2023

hmalik88 commented Jul 20, 2023

jiexi commented Jul 20, 2023

jiexi commented Jul 26, 2023

jiexi commented Jul 28, 2023

jiexi commented Jul 28, 2023

adonesky1 commented Jul 31, 2023

mcmire left a comment

Choose a reason for hiding this comment

mcmire Jul 31, 2023

Choose a reason for hiding this comment

jiexi Jul 31, 2023

Choose a reason for hiding this comment

mcmire Jul 31, 2023

Choose a reason for hiding this comment

jiexi Jul 31, 2023

Choose a reason for hiding this comment

hmalik88 left a comment

Choose a reason for hiding this comment

jiexi commented Jul 12, 2023 •

edited

Loading