This package is used to generate TypeScript types for the Storage Hub Runtime using the Polkadot{.js} typegen package. It automates the process of:
npm install @storagehub/api-augmentThis package is used to generate TypeScript types for the Storage Hub Runtime using the Polkadot{.js} typegen package. It automates the process of:
1. Launching a local Storage Hub node
2. Fetching the metadata blob
3. Running the blob through the Polkadot{.js} typegen package to create TypeScript type interfaces
> [!TIP]
> For more information on this process, see the Polkadot{.js} docs
To generate the types, run the following commands:
``sh`
pnpm i
pnpm scrape
pnpm generate:all
At the top of your file, add:
`ts`
import "@storagehub/api-augment";
>[!TIP]
> This step is also achievable by running pnpm typegen from within the /test folder.
In addition to the generation scripts, the following scripts are available:
- pnpm fmt: Format the codebase using Biome.pnpm fmt:fix
- : Format and fix the codebase using Biome.pnpm tsc
- : Run TypeScript compiler without emitting files.pnpm build
- : Build the TypeScript project.pnpm scrape
- : Scrape metadata from the local Storage Hub node.pnpm generate:all
- : Generate all types (definitions and metadata).pnpm generate:defs
- : Generate type definitions.pnpm generate:meta
- : Generate metadata types.
This workflow will publish the @storagehub/api-augment at a given git hash.
This workflow will update the api-augment` package and raise a PR with the changes.