@dao-dao/types
v2.5.0-rc.2
Published
A collection of types used across packages.
Downloads
27
Readme
@dao-dao/types
A collection of types used across packages.
Layout
| Location | Summary |
| ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| components | Types related to both stateless and stateful components and the respective packages. |
| contracts | Smart contract types generated by @cosmwasm/ts-codegen
. |
| protobuf | Protobuf types generated by @cosmology/telescope
. |
| actions.ts | Types related to the @dao-dao/stateful/actions
system. |
| chain.ts | Types related to the chain. |
| command.ts | Types related to the @dao-dao/stateful/command
system. |
| dao.ts | Types related to DAOs. |
| helpers.ts | Helper types. |
| inbox.ts | Types related to the inbox. |
| nft.ts | Types related to NFTs. |
| proposal-module-adapter.ts | Types related to the @dao-dao/stateful/proposal-module-adapter
system. |
| proposal.ts | Types related to proposals. |
| state.ts | Types related to the @dao-dao/state
package. |
| units.ts | Types related to units. |
| voting-module-adapter.ts | Types related to the @dao-dao/stateful/voting-module-adapter
system. |
| wallet.ts | Types related to wallets. |
Protobufs
This package contains Cosmos SDK protobuf definitions generated by Cosmology's Telescope.
To generate protobufs:
yarn protobuf
Sometimes definitions need to be manually fixed due to bugs and other
discrepancies. There is a patch file that records these modifications in
protobuf/patches.diff
.
To update the patch file when new changes are made:
Commit the changes so that the current branch is up-to-date with the desired changes.
Run:
yarn protobuf:patch:update
This will regenerate the protobufs, undoing all patches. Then, it records the reverse diff between the committed changes and the regenerated protobufs (since we want to undo the current changes). Lastly, it reapplies the latest patches, and all changes should be made. If this works, only the
patches.diff
file should have changes.Update the previous commit with the new patches.
git add protobuf/patches.diff git commit --amend