Create WDK Module
CLI scaffolding tool to generate new WDK wallet and protocol modules with a single command.
Scaffold new WDK modules with a single command. The CLI generates a fully configured project with source files, tests, TypeScript type definitions, and CI workflows — ready for you to add your blockchain or protocol integration logic.
Powered by create-wdk-module.
Quick Start
Run the scaffolding command
npx @tetherto/create-wdk-module@latestYou can also pass arguments directly to skip the interactive prompts:
npx @tetherto/create-wdk-module@latest wallet stellarInstall and run tests
cd wdk-wallet-stellar
npm install
npm testModule Types
The CLI supports all five WDK module categories. The generated package name follows WDK naming conventions automatically.
| Type | Description | Generated Package Example |
|---|---|---|
wallet | Blockchain wallet integration | wdk-wallet-stellar |
swap | DEX/token swap protocol | wdk-protocol-swap-jupiter-solana |
bridge | Cross-chain bridge protocol | wdk-protocol-bridge-wormhole-evm |
lending | DeFi lending protocol | wdk-protocol-lending-compound-evm |
fiat | Fiat on/off-ramp provider | wdk-protocol-fiat-moonpay |
CLI Options
| Option | Alias | Description | Default |
|---|---|---|---|
[type] | Module type (wallet, swap, bridge, lending, fiat) | (interactive prompt) | |
[name] | Module or protocol name | (interactive prompt) | |
[blockchain] | Target blockchain | (interactive prompt) | |
--scope <scope> | -s | npm scope (e.g., @myorg) | none |
--git | Initialize a git repository | true | |
--no-git | Skip git initialization | ||
--yes | -y | Skip prompts, use defaults | false |
--version | -v | Show version | |
--help | -h | Show help |
Examples
# Create a wallet module with an npm scope
npx @tetherto/create-wdk-module@latest wallet stellar --scope @myorg
# Create a swap protocol module
npx @tetherto/create-wdk-module@latest swap jupiter solana
# Create with all defaults, no prompts
npx @tetherto/create-wdk-module@latest wallet stellar --yesInteractive Mode
When run without arguments, the CLI guides you through module setup step by step:
$ npx @tetherto/create-wdk-module@latest
Create WDK Module
? What type of module do you want to create?
> Wallet Module (blockchain wallet integration)
Swap Module (DEX/token swap integration)
Bridge Module (cross-chain bridging)
Lending Module (DeFi lending protocol)
Fiat Module (fiat on/off-ramp)
? What is the blockchain name? (e.g., "stellar", "solana")
> stellar
? npm scope (leave empty for none, e.g., @myorg):
>
? Initialize git repository?
> Yes
Creating wdk-wallet-stellar...
✓ Template files copied
✓ Initialized git repository
Success! Created wdk-wallet-stellar at ./wdk-wallet-stellar
Next steps:
cd wdk-wallet-stellar
npm install
npm testGenerated Project Structure
The scaffolded project includes source files, tests, TypeScript definitions, and GitHub CI workflows out of the box.
Next Steps
Wallet Modules
See how official wallet modules are structured and documented
Community Modules
Explore community-built modules and submit your own
Reference implementation: The wdk-wallet-solana module is a good reference for understanding how a production wallet module implements the WDK interfaces. The wdk-wallet package defines the base classes your module must extend.