Package rosetta implements the rosetta API for the current cosmos sdk release series.
There are two ways in which you can customize and extend the implementation with your custom settings.
# Message extension
In order to make an
sdk.Msg understandable by rosetta the only thing which is required is adding the methods to your message that satisfy the
Examples on how to do so can be found in the staking types such as
MsgDelegate, or in bank types such as
# Client interface override
In case more customization is required, it's possible to embed the Client type and override the methods which require customizations.
# Error extension
Since rosetta requires to provide 'returned' errors to network options. In order to declare a new rosetta error, we use the
errors package in cosmos-rosetta-gateway.
Note: errors must be registered before cosmos-rosetta-gateway's
Start method is called. Otherwise the registration will be ignored. Errors with same code will be ignored too.
# Integration in app.go
To integrate rosetta as a command in your application, in app.go, in your root command simply use the
A full implementation example can be found in
NOTE: when using a customized client, the command cannot be used as the constructors required may differ, so it's required to create a new one. We intend to provide a way to init a customized client without writing extra code in the future.