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.

Sign up for GitHub

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

Jump to bottom

Typescript Type definitions #668

Open

TrevorJTClarke opened this issue Aug 29, 2022 · 0 comments

Contributor

TrevorJTClarke commented Aug 29, 2022 •

edited

Loading

Would be great for those using typescript to be able to import type definitions, alongside the repo for chain definitions/jsons.

Issue:

Keplr (and others) make various non-standard definitions: https://github.com/chainapsis/keplr-wallet/blob/master/packages/types/src/chain-info.ts (Related: Change to ChainRegistry for type "ChainInfo" chainapsis/keplr-wallet#497)
Unifying the json & the types will help adoption/usage, however until now this doesnt exist so devs use whatever

Requirements:

Create type definitions for the full scope of the most complete JSON file
Create new types that are unsupported currently, to support Keplr missing fields (this will help cosmodal usage & other boilerplate apps that exist)
Document how to import/use types

See: https://github.com/cosmology-tech/chain-registry

Why is this not part of the repo?

Bonus points:

Use the types & a small script to check all PRs against types for required fields & field validations

TrevorJTClarke mentioned this issue

Change to ChainRegistry for type "ChainInfo" chainapsis/keplr-wallet#497

Closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment