Add typescript declarations for `cardano-wasm` API and generate it automatically from `ApiInfo` #901

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

Merged

palas merged 10 commits into master from cardano-wasm-typescript

Jul 18, 2025

Contributor

palas commented Jul 14, 2025 •

edited

Loading

Changelog

- description: |
    Added typescript declaration for `cardano-wasm` API
  type:
  - feature
  - documentation
  projects:
  - cardano-wasm

Context

Because JavaScript is untyped, this PR adds TypeScript declarations that both help users of cardano-wasm API to get types right, and also they will get detailed contextual documentation when using it from IDEs.

How to trust this PR

What I checked is that the generated d.ts file is the same as the manually written one (pretty much). I also checked that you can use it from VSCode and get autocompletion and contextual documentation.

I would check the style and that there are no bugs. You can also try running the .d.ts generation (which is the main executable of cardano-wasm)

Checklist

Commit sequence broadly makes sense and commits have useful messages
New tests are added if needed and existing tests are updated. See Running tests for more details
Self-reviewed the diff

palas self-assigned this

palas requested review from CarlosLopezDeLara, Jimbo4350, carbolymer, dcoutts, disassembler, erikd, kevinhammond and newhoggy as code owners

July 14, 2025 17:01

palas force-pushed the cardano-wasm-balancing branch from 166c823 to 7c9eb4c Compare

July 14, 2025 17:02

palas force-pushed the cardano-wasm-typescript branch from 62e88cb to c21e28a Compare

July 14, 2025 17:02

carbolymer reviewed

View reviewed changes

cardano-wasm/example/cardano-api.d.ts Outdated Show resolved Hide resolved

carbolymer reviewed

View reviewed changes

cardano-wasm/src/Cardano/Wasm/Internal/Api/TypeScriptDefs.hs Outdated Show resolved Hide resolved

carbolymer reviewed

View reviewed changes

cardano-wasm/src/Cardano/Wasm/Internal/Api/TypeScriptDefs.hs Show resolved Hide resolved

carbolymer reviewed

View reviewed changes

cardano-wasm/src/Cardano/Wasm/Internal/Api/TypeScriptDefs.hs Show resolved Hide resolved

carbolymer reviewed

View reviewed changes

cardano-wasm/example/cardano-api.d.ts Show resolved Hide resolved

Base automatically changed from cardano-wasm-balancing to master

July 15, 2025 14:34

palas force-pushed the cardano-wasm-typescript branch 4 times, most recently from 78690aa to 69d5af6 Compare

July 16, 2025 14:50

palas requested a review from a team as a code owner

July 16, 2025 14:50

palas requested a review from carbolymer

July 16, 2025 15:27

palas force-pushed the cardano-wasm-typescript branch 3 times, most recently from 2cc682c to c84ad5b Compare

July 17, 2025 14:53

palas and others added 4 commits

July 17, 2025 16:54


          Created TypeScript definition for existing API

d502193


          Generate TypeScript definitions from ApiInfo

7c95dcc


          Add test to ensure the generated TypeScript file matches

3c35371


          Make cardano-wasm-golden test build in nix

4986b03

palas force-pushed the cardano-wasm-typescript branch from c84ad5b to 8d2423f Compare

July 17, 2025 14:56


          Make test suite build minimally for wasm

d4a5e5b

palas force-pushed the cardano-wasm-typescript branch from 8d2423f to d4a5e5b Compare

July 17, 2025 15:13

carbolymer reviewed

View reviewed changes

cabal.project Outdated Show resolved Hide resolved

carbolymer reviewed

View reviewed changes

cardano-wasm/cardano-wasm.cabal Outdated Show resolved Hide resolved

carbolymer reviewed

View reviewed changes

cardano-wasm/src/Cardano/Wasm/Internal/Api/TypeScriptDefs.hs Outdated Show resolved Hide resolved

carbolymer approved these changes

View reviewed changes

Jimbo4350 approved these changes

View reviewed changes

cardano-wasm/example/cardano-api.d.ts Show resolved Hide resolved

cardano-wasm/src/Cardano/Wasm/Internal/Api/Info.hs Show resolved Hide resolved

cardano-wasm/src/Cardano/Wasm/Internal/Api/Info.hs Show resolved Hide resolved


          Clarify explanation for adding max-backjumps: 50000

88979f1

Co-authored-by: Mateusz Galazyn <[email protected]>

carbolymer mentioned this pull request

Remove max-backjumps from cabal.project. #909

Open

palas and others added 3 commits

July 18, 2025 17:55


          Move golden tests to test/cardano-wasm-golden

57555f5

Co-authored-by: Mateusz Galazyn <[email protected]>


          Use OverloadedStrings

8dc0d12


          Improve haddocks for datatypes in Info.hs

6a3f545

palas force-pushed the cardano-wasm-typescript branch 2 times, most recently from 9556681 to 50928d4 Compare

July 18, 2025 16:38


          Move wrapper files outside of the example folder (into lib-wrapper …

bb53acb

…folder)

palas force-pushed the cardano-wasm-typescript branch from 50928d4 to bb53acb Compare

July 18, 2025 16:42

palas added this pull request to the merge queue

Merged via the queue into master with commit f037d0d

29 checks passed

palas deleted the cardano-wasm-typescript branch

July 18, 2025 18:02

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

Reviewers

carbolymer carbolymer approved these changes

Jimbo4350 Jimbo4350 approved these changes

dcoutts Awaiting requested review from dcoutts dcoutts is a code owner

erikd Awaiting requested review from erikd erikd is a code owner

newhoggy Awaiting requested review from newhoggy newhoggy is a code owner

kevinhammond Awaiting requested review from kevinhammond kevinhammond is a code owner

CarlosLopezDeLara Awaiting requested review from CarlosLopezDeLara CarlosLopezDeLara is a code owner

disassembler Awaiting requested review from disassembler disassembler is a code owner

Labels

None yet