CLI

Dedot's Command line interface

Dedot comes by default with a cli when you install dedot package, you can access the cli typing dedot (or djs) in the terminal. dedot cli helps you generate Types & APIs to any Substrate-based chains or ink! smart contracts that you're working with. This enable Types & APIs suggetions/auto-completion via IntelliSense for any on-chain interactions.

dedot chaintypes

Generate Types & APIs for a Substrated-based blockchain given its metadata. The cli can fetch metadata from a WebSocket endpoint, a wasm runtime file or a raw metadata (.scale) file.

Usage:

npx dedot chaintypes -w wss://rpc.polkadot.io

Options:

  • -w, --wsUrl: Fetch metadata from a WebSocket endpoint

  • -r, --wasm: Fetch metadata from a runtime wasm file (.wasm)

  • -m, --medadata: Fetch metadata from a raw metadata file (.scale)

  • -o, --output: Folder to put generated files

  • -c, --chain: Customize the chain name to generate, default to runtimeVersion.specName

  • -d, --dts: Generate .d.ts files instead of .ts, default: true

  • -s, --subpath: Using subpath packages (e.g: dedot/types instead of @dedot/types), default: true

dedot typink

Generate Types & APIs for an ink! smart contract given its metadata.

Usage:

npx dedot typink -m ./path/to/metadata.json # or metadata.contract

Options:

  • -m, --medadata: Path to contract metadata file (.json, .contract)

  • -o, --output: Folder to put generated files

  • -c, --contract: Custom contract name, default is contract name from metadata

  • -d, --dts: Generate .d.ts files instead of .ts, default: true

  • -s, --subpath: Using subpath packages (e.g: dedot/types instead of @dedot/types), default: true

Last updated