Documentation ¶
Index ¶
- Constants
- func AddOperationIndexes(msgOps []*rosettatypes.Operation, balanceOps []*rosettatypes.Operation) (finalOps []*rosettatypes.Operation)
- func MakeCodec() (*codec.ProtoCodec, codectypes.InterfaceRegistry)
- func ServerFromConfig(conf *Config) (crg.Server, error)
- func SetFlags(flags *pflag.FlagSet)
- type Client
- func (c *Client) AccountIdentifierFromPublicKey(pubKey *types.PublicKey) (*types.AccountIdentifier, error)
- func (c *Client) Balances(ctx context.Context, addr string, height *int64) ([]*rosettatypes.Amount, error)
- func (c *Client) BlockByHash(ctx context.Context, hash string) (crgtypes.BlockResponse, error)
- func (c *Client) BlockByHeight(ctx context.Context, height *int64) (crgtypes.BlockResponse, error)
- func (c *Client) BlockTransactionsByHash(ctx context.Context, hash string) (crgtypes.BlockTransactionsResponse, error)
- func (c *Client) BlockTransactionsByHeight(ctx context.Context, height *int64) (crgtypes.BlockTransactionsResponse, error)
- func (c *Client) Bootstrap() error
- func (c *Client) ConstructionMetadataFromOptions(ctx context.Context, options map[string]interface{}) (meta map[string]interface{}, err error)
- func (c *Client) ConstructionPayload(_ context.Context, request *types.ConstructionPayloadsRequest) (resp *types.ConstructionPayloadsResponse, err error)
- func (c *Client) GetTx(ctx context.Context, hash string) (*rosettatypes.Transaction, error)
- func (c *Client) GetUnconfirmedTx(ctx context.Context, hash string) (*rosettatypes.Transaction, error)
- func (c *Client) Mempool(ctx context.Context) ([]*rosettatypes.TransactionIdentifier, error)
- func (c *Client) OperationStatuses() []*types.OperationStatus
- func (c *Client) Peers(ctx context.Context) ([]*rosettatypes.Peer, error)
- func (c *Client) PostTx(txBytes []byte) (*rosettatypes.TransactionIdentifier, map[string]interface{}, error)
- func (c *Client) PreprocessOperationsToOptions(_ context.Context, req *types.ConstructionPreprocessRequest) (response *types.ConstructionPreprocessResponse, err error)
- func (c *Client) Ready() error
- func (c *Client) SignedTx(_ context.Context, txBytes []byte, signatures []*types.Signature) (signedTxBytes []byte, err error)
- func (c *Client) Status(ctx context.Context) (*rosettatypes.SyncStatus, error)
- func (c *Client) SupportedOperations() []string
- func (c *Client) TxOperationsAndSignersAccountIdentifiers(signed bool, txBytes []byte) (ops []*rosettatypes.Operation, signers []*rosettatypes.AccountIdentifier, ...)
- func (c *Client) Version() string
- type Config
- type ConstructionMetadata
- type ConstructionPreprocessMetadata
- type Converter
- type PreprocessOperationsOptionsResponse
- type SignerData
- type ToRosettaConverter
- type ToSDKConverter
- type TransactionType
Constants ¶
const ( // DefaultBlockchain defines the default blockchain identifier name DefaultBlockchain = "app" // DefaultAddr defines the default rosetta binding address DefaultAddr = ":8080" // DefaultRetries is the default number of retries DefaultRetries = 5 // DefaultTendermintEndpoint is the default value for the tendermint endpoint DefaultTendermintEndpoint = "localhost:26657" // DefaultGRPCEndpoint is the default value for the gRPC endpoint DefaultGRPCEndpoint = "localhost:9090" // DefaultNetwork defines the default network name DefaultNetwork = "network" // DefaultOffline defines the default offline value DefaultOffline = false )
configuration defaults constants
const ( FlagBlockchain = "blockchain" FlagNetwork = "network" FlagTendermintEndpoint = "tendermint" FlagGRPCEndpoint = "grpc" FlagAddr = "addr" FlagRetries = "retries" FlagOffline = "offline" )
configuration flags
const ( StatusTxSuccess = "Success" StatusTxReverted = "Reverted" StatusPeerSynced = "synced" StatusPeerSyncing = "syncing" )
statuses
const ( DeliverTxSize = sha256.Size BeginEndBlockTxSize = DeliverTxSize + 1 EndBlockHashStart = 0x0 BeginBlockHashStart = 0x1 )
In rosetta all state transitions must be represented as transactions since in tendermint begin block and end block are state transitions which are not represented as transactions we mock only the balance changes happening at those levels as transactions. (check BeginBlockTxHash for more info)
const ( // BurnerAddressIdentifier mocks the account identifier of a burner address // all coins burned in the sdk will be sent to this identifier, which per sdk.AccAddress // design we will never be able to query (as of now). // Rosetta does not understand supply contraction. BurnerAddressIdentifier = "burner" )
const (
Log = "log"
)
misc
Variables ¶
This section is empty.
Functions ¶
func AddOperationIndexes ¶
func AddOperationIndexes(msgOps []*rosettatypes.Operation, balanceOps []*rosettatypes.Operation) (finalOps []*rosettatypes.Operation)
AddOperationIndexes adds the indexes to operations adhering to specific rules: operations related to messages will be always before than the balance ones
func MakeCodec ¶
func MakeCodec() (*codec.ProtoCodec, codectypes.InterfaceRegistry)
MakeCodec generates the codec required to interact with the soominhyunwoo APIs used by the rosetta gateway
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client implements a single network client to interact with soominhyunwoo based chains
func (*Client) AccountIdentifierFromPublicKey ¶
func (*Client) BlockByHash ¶
func (*Client) BlockByHeight ¶
func (*Client) BlockTransactionsByHash ¶
func (*Client) BlockTransactionsByHeight ¶
func (*Client) ConstructionMetadataFromOptions ¶
func (c *Client) ConstructionMetadataFromOptions(ctx context.Context, options map[string]interface{}) (meta map[string]interface{}, err error)
ConstructionMetadataFromOptions builds the metadata given the options
func (*Client) ConstructionPayload ¶
func (c *Client) ConstructionPayload(_ context.Context, request *types.ConstructionPayloadsRequest) (resp *types.ConstructionPayloadsResponse, err error)
func (*Client) GetTx ¶
func (c *Client) GetTx(ctx context.Context, hash string) (*rosettatypes.Transaction, error)
GetTx returns a transaction given its hash. For Rosetta we make a synthetic transaction for BeginBlock
and EndBlock to adhere to balance tracking rules.
func (*Client) GetUnconfirmedTx ¶
func (c *Client) GetUnconfirmedTx(ctx context.Context, hash string) (*rosettatypes.Transaction, error)
GetUnconfirmedTx gets an unconfirmed transaction given its hash
func (*Client) Mempool ¶
func (c *Client) Mempool(ctx context.Context) ([]*rosettatypes.TransactionIdentifier, error)
Mempool returns the unconfirmed transactions in the mempool
func (*Client) OperationStatuses ¶
func (c *Client) OperationStatuses() []*types.OperationStatus
func (*Client) PostTx ¶
func (c *Client) PostTx(txBytes []byte) (*rosettatypes.TransactionIdentifier, map[string]interface{}, error)
func (*Client) PreprocessOperationsToOptions ¶
func (c *Client) PreprocessOperationsToOptions(_ context.Context, req *types.ConstructionPreprocessRequest) (response *types.ConstructionPreprocessResponse, err error)
func (*Client) Ready ¶
Ready performs a health check and returns an error if the client is not ready.
func (*Client) Status ¶
func (c *Client) Status(ctx context.Context) (*rosettatypes.SyncStatus, error)
func (*Client) SupportedOperations ¶
func (*Client) TxOperationsAndSignersAccountIdentifiers ¶
func (c *Client) TxOperationsAndSignersAccountIdentifiers(signed bool, txBytes []byte) (ops []*rosettatypes.Operation, signers []*rosettatypes.AccountIdentifier, err error)
type Config ¶
type Config struct { // Blockchain defines the blockchain name // defaults to DefaultBlockchain Blockchain string // Network defines the network name Network string // TendermintRPC defines the endpoint to connect to // tendermint RPC, specifying 'tcp://' before is not // required, usually it's at port 26657 of the TendermintRPC string // GRPCEndpoint defines the soominhyunwoo application gRPC endpoint // usually it is located at 9090 port GRPCEndpoint string // Addr defines the default address to bind the rosetta server to // defaults to DefaultAddr Addr string // Retries defines the maximum number of retries // rosetta will do before quitting Retries int // Offline defines if the server must be run in offline mode Offline bool // Codec overrides the default data and construction api client codecs Codec *codec.ProtoCodec // InterfaceRegistry overrides the default data and construction api interface registry InterfaceRegistry codectypes.InterfaceRegistry }
Config defines the configuration of the rosetta server
func (*Config) NetworkIdentifier ¶
func (c *Config) NetworkIdentifier() *types.NetworkIdentifier
NetworkIdentifier returns the network identifier given the configuration
func (*Config) WithCodec ¶
func (c *Config) WithCodec(ir codectypes.InterfaceRegistry, cdc *codec.ProtoCodec)
WithCodec extends the configuration with a predefined Codec
type ConstructionMetadata ¶
type ConstructionMetadata struct { ChainID string `json:"chain_id"` SignersData []*SignerData `json:"signer_data"` GasLimit uint64 `json:"gas_limit"` GasPrice string `json:"gas_price"` Memo string `json:"memo"` }
ConstructionMetadata are the metadata options used to construct a transaction. It is returned by ConstructionMetadataFromOptions and fed to ConstructionPayload to process the bytes to sign.
func (*ConstructionMetadata) FromMetadata ¶
func (c *ConstructionMetadata) FromMetadata(meta map[string]interface{}) error
func (ConstructionMetadata) ToMetadata ¶
func (c ConstructionMetadata) ToMetadata() (map[string]interface{}, error)
type ConstructionPreprocessMetadata ¶
type ConstructionPreprocessMetadata struct { Memo string `json:"memo"` GasLimit uint64 `json:"gas_limit"` GasPrice string `json:"gas_price"` }
ConstructionPreprocessMetadata is used to represent the metadata rosetta can provide during preprocess options
func (*ConstructionPreprocessMetadata) FromMetadata ¶
func (c *ConstructionPreprocessMetadata) FromMetadata(meta map[string]interface{}) error
type Converter ¶
type Converter interface { // ToSDK exposes the methods that convert // rosetta types to soominhyunwoo sdk and tendermint types ToSDK() ToSDKConverter // ToRosetta exposes the methods that convert // sdk and tendermint types to rosetta types ToRosetta() ToRosettaConverter }
Converter is a utility that can be used to convert back and forth from rosetta to sdk and tendermint types IMPORTANT NOTES:
- IT SHOULD BE USED ONLY TO DEAL WITH THINGS IN A STATELESS WAY! IT SHOULD NEVER INTERACT DIRECTLY WITH TENDERMINT RPC AND soominhyunwoo GRPC
- IT SHOULD RETURN soominhyunwoo rosetta gateway error types!
func NewConverter ¶
func NewConverter(cdc *codec.ProtoCodec, ir codectypes.InterfaceRegistry, cfg sdkclient.TxConfig) Converter
type PreprocessOperationsOptionsResponse ¶
type PreprocessOperationsOptionsResponse struct { ExpectedSigners []string `json:"expected_signers"` Memo string `json:"memo"` GasLimit uint64 `json:"gas_limit"` GasPrice string `json:"gas_price"` }
PreprocessOperationsOptionsResponse is the structured metadata options returned by the preprocess operations endpoint
func (*PreprocessOperationsOptionsResponse) FromMetadata ¶
func (c *PreprocessOperationsOptionsResponse) FromMetadata(meta map[string]interface{}) error
func (PreprocessOperationsOptionsResponse) ToMetadata ¶
func (c PreprocessOperationsOptionsResponse) ToMetadata() (map[string]interface{}, error)
type SignerData ¶
type SignerData struct { AccountNumber uint64 `json:"account_number"` Sequence uint64 `json:"sequence"` }
SignerData contains information on the signers when the request is being created, used to populate the account information
type ToRosettaConverter ¶
type ToRosettaConverter interface { // BlockResponse returns a block response given a result block BlockResponse(block *tmcoretypes.ResultBlock) crgtypes.BlockResponse // BeginBlockToTx converts the given begin block hash to rosetta transaction hash BeginBlockTxHash(blockHash []byte) string // EndBlockTxHash converts the given endblock hash to rosetta transaction hash EndBlockTxHash(blockHash []byte) string // Amounts converts sdk.Coins to rosetta.Amounts Amounts(ownedCoins []sdk.Coin, availableCoins sdk.Coins) []*rosettatypes.Amount // Ops converts an sdk.Msg to rosetta operations Ops(status string, msg sdk.Msg) ([]*rosettatypes.Operation, error) // OpsAndSigners takes raw transaction bytes and returns rosetta operations and the expected signers OpsAndSigners(txBytes []byte) (ops []*rosettatypes.Operation, signers []*rosettatypes.AccountIdentifier, err error) // Meta converts an sdk.Msg to rosetta metadata Meta(msg sdk.Msg) (meta map[string]interface{}, err error) // SignerData returns account signing data from a queried any account SignerData(anyAccount *codectypes.Any) (*SignerData, error) // SigningComponents returns rosetta's components required to build a signable transaction SigningComponents(tx authsigning.Tx, metadata *ConstructionMetadata, rosPubKeys []*rosettatypes.PublicKey) (txBytes []byte, payloadsToSign []*rosettatypes.SigningPayload, err error) // Tx converts a tendermint transaction and tx result if provided to a rosetta tx Tx(rawTx tmtypes.Tx, txResult *abci.ResponseDeliverTx) (*rosettatypes.Transaction, error) // TxIdentifiers converts a tendermint tx to transaction identifiers TxIdentifiers(txs []tmtypes.Tx) []*rosettatypes.TransactionIdentifier // BalanceOps converts events to balance operations BalanceOps(status string, events []abci.Event) []*rosettatypes.Operation // SyncStatus converts a tendermint status to sync status SyncStatus(status *tmcoretypes.ResultStatus) *rosettatypes.SyncStatus // Peers converts tendermint peers to rosetta Peers(peers []tmcoretypes.Peer) []*rosettatypes.Peer }
ToRosettaConverter is an interface that exposes all the functions used to convert sdk and tendermint types to rosetta known types
type ToSDKConverter ¶
type ToSDKConverter interface { // UnsignedTx converts rosetta operations to an unsigned soominhyunwoo sdk transactions UnsignedTx(ops []*rosettatypes.Operation) (tx authsigning.Tx, err error) // SignedTx adds the provided signatures after decoding the unsigned transaction raw bytes // and returns the signed tx bytes SignedTx(txBytes []byte, signatures []*rosettatypes.Signature) (signedTxBytes []byte, err error) // Msg converts metadata to an sdk message Msg(meta map[string]interface{}, msg sdk.Msg) (err error) // HashToTxType returns the transaction type (end block, begin block or deliver tx) // and the real hash to query in order to get information HashToTxType(hashBytes []byte) (txType TransactionType, realHash []byte) // PubKey attempts to convert a rosetta public key to soominhyunwoo sdk one PubKey(pk *rosettatypes.PublicKey) (cryptotypes.PubKey, error) }
ToSDKConverter is an interface that exposes all the functions used to convert rosetta types to tendermint and sdk types
type TransactionType ¶
type TransactionType int
TransactionType is used to distinguish if a rosetta provided hash represents endblock, beginblock or deliver tx
const ( UnrecognizedTx TransactionType = iota BeginBlockTx EndBlockTx DeliverTxTx )