-
-
Notifications
You must be signed in to change notification settings - Fork 14
feat: Add KnownCaipNamespacedChainId type
#258
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Add KnownCaipNamespacedChainId type
#258
Conversation
mcmire
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll defer to @ccharly for final say here, but I think this is a useful addition. That being said, I think the reasoning (and the jsdoc comment) may need to be adjusted. /**
* A CAIP-2 chain ID that is guaranteed to have a known CAIP namespace
* (see {@link KnownCaipNamespace}).
*
* This is a narrower, more type-safe alternative to {@link CaipChainId} for use cases
* where the chain namespace must be one of the known standards.
*/ |
Co-authored-by: Eric Wolff <erwolff@gmail.com>
|
Sorry, completely miss the notification here. But that sounds like a good addition to me yes! Thanks 💪 |
…eter (#262) This commit refactors `KnownCaipNamespacedChainId` (introduced in [#258](#258)) into a generic type by adding a `Namespace` type parameter. This allows the type to be narrowed down to chain IDs with a specific namespace. This is not a breaking change, as `Namespace` defaults to a type union of known CAIP namespaces. The type's previous behavior is preserved when its generic type parameter is omitted.
This commit adds a type for CAIP chain IDs that are namespaced by a known CAIP namespace.
This type enables the usage of safer literal string types for namespaced CAIP chain IDs, and is intended as a narrower alternative to
CaipChainId.Any and all suggestions about type name, jsdoc comments etc. are welcome.