DipDup framework
Search…
init
This command generates type classes and handler templates based on the DipDup configuration file. It's an idempotent command meaning that it won't overwrite previously generated files unless asked explicitly.
1
dipdup [-c dipdup.yml] init [--overwrite-types]
Copied!
DipDup will generate all the necessary directories and files inside the project's root. Those include contracts' type definitions and callback stubs to be implemented by the developer. See 4.4. Project structure page to learn more about the project structure.
init command does not overwrite typeclasses already generated. Use the --overwrite-types flag if it's not the desired behavior. Also, you can mark some files as immune from rewriting; see 8.2. Reusing typename for different contracts.Nested packages for hooks and handlers
Callback modules don't have to be in top-level
hooks/handlers directories. Add one or multiple dots to callback name to define nested packages:1
package: indexer
2
hooks:
3
foo.bar:
4
callback: foo.bar
Copied!
After running
init command, you'll get the following directory tree (shortened for readability):1
indexer
2
├── hooks
3
│ ├── foo
4
│ │ ├── bar.py
5
│ │ └── __init__.py
6
│ └── __init__.py
7
└── sql
8
└── foo
9
└── bar
10
└── .keep
Copied!
The same rules apply to handler callbacks. Note that
callback field must be a valid Python package name - lowercase letters, underscores, and dots.Last modified 3mo ago
Copy link