Skip to content

Files

types

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Dec 10, 2024
Jan 31, 2025
May 10, 2023
Oct 11, 2024
Feb 14, 2025
Apr 27, 2023
Sep 25, 2024
Feb 14, 2025
Oct 11, 2024
Feb 14, 2025

Tangle Substrate Types

This package is meant to be updated alongside changes to the tangle runtime.

The package builds the types against the tangle standalone runtime.

Updating Types

To update the types after modifying the Tangle APIs, follow these steps:

  1. Build the tangle project with the testnet feature:

    cargo build --release --package tangle --features testnet
  2. Ensure you have Node.js version 18 or higher installed.

  3. Generate the updated TypeScript types by running the generate-ts-types.js script:

    node types/scripts/generate-ts-types.js

This process will automatically update the TypeScript types to reflect the latest changes in the Tangle APIs.

Publishing and consuming types package

Once the types have been updated, open a new PR on this repository to submit your changes. Remember to update the types package's version. Once the PR is merged into the master, a GitHub Actions workflow will automatically publish them to NPM.

In case that you need to use or prototype the types before they are officially published to NPM, consider installing the package locally and using the local package until its updated version is published to NPM.