The Boost V2 Docs are under active development and will be subject to changes.
@boostxyz/signatures
in the creation of your Boost, then you don’t have to do anything else for validation to work.
Otherwise, if you’re supplying a custom event signature unknown to @boostxyz/signatures
and dealing with a Boost using a custom validator, you’ll need to additionally supply your own AbiEvent
to validation methods so event logs can be correctly pulled off transactions.
Contributing new signatures
If using the default Boost validator, you also have the option of submitting your contract events and functions to openchain.xyz or 4byte.directory, but contributing to
@boostxyz/signatures
is preferred due to its approach as a static manifest as opposed to a third party API.- First, check to see if
@boostxyz/signatures
already supports your signature. We include several popular signatures and you may not need to do anything at all. - Fork the
boostxyz/boost-protocol
repository - Add your function or event signature to the correct manifest JSON file following the existing formatting and conventions.
- Entries starting with
//
are treated as comments so you can distinguish a block of related signatures
- Entries starting with
- Commit your modified manifest file
- Create a pull request
@boostxyz/signatures
package so you can continue your Boost Protocol integrations.