Documentation
¶
Index ¶
- Variables
- func NewBlockchainRouter(config *configuration.Configuration, client Client, ...) http.Handler
- type AccountAPIService
- type BlockAPIService
- type Client
- type ConstructionAPIService
- func (s *ConstructionAPIService) ConstructionCombine(ctx context.Context, request *types.ConstructionCombineRequest) (*types.ConstructionCombineResponse, *types.Error)
- func (s *ConstructionAPIService) ConstructionDerive(ctx context.Context, request *types.ConstructionDeriveRequest) (*types.ConstructionDeriveResponse, *types.Error)
- func (s *ConstructionAPIService) ConstructionHash(ctx context.Context, request *types.ConstructionHashRequest) (*types.TransactionIdentifierResponse, *types.Error)
- func (s *ConstructionAPIService) ConstructionMetadata(ctx context.Context, request *types.ConstructionMetadataRequest) (*types.ConstructionMetadataResponse, *types.Error)
- func (s *ConstructionAPIService) ConstructionParse(ctx context.Context, request *types.ConstructionParseRequest) (*types.ConstructionParseResponse, *types.Error)
- func (s *ConstructionAPIService) ConstructionPayloads(ctx context.Context, request *types.ConstructionPayloadsRequest) (*types.ConstructionPayloadsResponse, *types.Error)
- func (s *ConstructionAPIService) ConstructionPreprocess(ctx context.Context, request *types.ConstructionPreprocessRequest) (*types.ConstructionPreprocessResponse, *types.Error)
- func (s *ConstructionAPIService) ConstructionSubmit(ctx context.Context, request *types.ConstructionSubmitRequest) (*types.TransactionIdentifierResponse, *types.Error)
- type NetworkAPIService
- func (s *NetworkAPIService) NetworkList(ctx context.Context, request *types.MetadataRequest) (*types.NetworkListResponse, *types.Error)
- func (s *NetworkAPIService) NetworkOptions(ctx context.Context, request *types.NetworkRequest) (*types.NetworkOptionsResponse, *types.Error)
- func (s *NetworkAPIService) NetworkStatus(ctx context.Context, request *types.NetworkRequest) (*types.NetworkStatusResponse, *types.Error)
Constants ¶
This section is empty.
Variables ¶
var ( // Errors contains all errors that could be returned // by this Rosetta implementation. Errors = []*types.Error{ ErrUnimplemented, ErrUnavailableOffline, ErrGvite, ErrUnableToDecompressPubkey, ErrUnclearIntent, ErrUnableToParseIntermediateResult, ErrSignatureInvalid, ErrBroadcastFailed, ErrCallParametersInvalid, ErrInvalidAddress, ErrGviteNotReady, } // ErrUnimplemented is returned when an endpoint // is called that is not implemented. ErrUnimplemented = &types.Error{ Code: 0, Message: "Endpoint not implemented", } // is called that is not available offline. ErrUnavailableOffline = &types.Error{ Code: 1, Message: "Endpoint unavailable offline", } // ErrGvite is returned when gvite // errors on a request. ErrGvite = &types.Error{ Code: 2, Message: "gvite error", } // ErrUnableToDecompressPubkey is returned when // the *types.PublicKey provided in /construction/derive // cannot be decompressed. ErrUnableToDecompressPubkey = &types.Error{ Code: 3, Message: "Unable to decompress public key", } // ErrUnclearIntent is returned when operations // provided in /construction/preprocess or /construction/payloads // are not valid. ErrUnclearIntent = &types.Error{ Code: 4, Message: "Unable to parse intent", } // ErrUnableToParseIntermediateResult is returned // when a data structure passed between Construction // API calls is not valid. ErrUnableToParseIntermediateResult = &types.Error{ Code: 5, Message: "Unable to parse intermediate result", } // ErrSignatureInvalid is returned when a signature // cannot be parsed. ErrSignatureInvalid = &types.Error{ Code: 6, Message: "Signature invalid", } // ErrBroadcastFailed is returned when transaction // broadcast fails. ErrBroadcastFailed = &types.Error{ Code: 7, Message: "Unable to broadcast transaction", } // ErrCallParametersInvalid is returned when // the parameters for a particular call method // are considered invalid. ErrCallParametersInvalid = &types.Error{ Code: 8, Message: "Call parameters invalid", } // ErrInvalidAddress is returned when an address // is not valid. ErrInvalidAddress = &types.Error{ Code: 12, Message: "Invalid address", } // ErrGviteNotReady is returned when gvite // cannot yet serve any queries. ErrGviteNotReady = &types.Error{ Code: 13, Message: "gvite not ready", Retriable: true, } )
Functions ¶
func NewBlockchainRouter ¶
func NewBlockchainRouter( config *configuration.Configuration, client Client, asserter *asserter.Asserter, ) http.Handler
NewBlockchainRouter creates a Mux http.Handler from a collection of server controllers.
Types ¶
type AccountAPIService ¶
type AccountAPIService struct {
// contains filtered or unexported fields
}
AccountAPIService implements the server.AccountAPIServicer interface.
func NewAccountAPIService ¶
func NewAccountAPIService( cfg *configuration.Configuration, client Client, ) *AccountAPIService
NewAccountAPIService returns a new *AccountAPIService.
func (*AccountAPIService) AccountBalance ¶
func (s *AccountAPIService) AccountBalance( ctx context.Context, request *types.AccountBalanceRequest, ) (*types.AccountBalanceResponse, *types.Error)
AccountBalance implements /account/balance.
func (*AccountAPIService) AccountCoins ¶
func (s *AccountAPIService) AccountCoins( ctx context.Context, request *types.AccountCoinsRequest, ) (*types.AccountCoinsResponse, *types.Error)
AccountCoins implements /account/coins.
type BlockAPIService ¶
type BlockAPIService struct {
// contains filtered or unexported fields
}
BlockAPIService implements the server.BlockAPIServicer interface.
func NewBlockAPIService ¶
func NewBlockAPIService( cfg *configuration.Configuration, client Client, ) *BlockAPIService
NewBlockAPIService creates a new instance of a BlockAPIService.
func (*BlockAPIService) Block ¶
func (s *BlockAPIService) Block( ctx context.Context, request *types.BlockRequest, ) (*types.BlockResponse, *types.Error)
Block implements the /block endpoint.
func (*BlockAPIService) BlockTransaction ¶
func (s *BlockAPIService) BlockTransaction( ctx context.Context, request *types.BlockTransactionRequest, ) (*types.BlockTransactionResponse, *types.Error)
BlockTransaction implements the /block/transaction endpoint.
type Client ¶
type Client interface { Status(context.Context) ( *types.BlockIdentifier, int64, *types.SyncStatus, []*types.Peer, error, ) GenesisBlockIdentifier() *types.BlockIdentifier Block( context.Context, *types.PartialBlockIdentifier, ) (*types.Block, []*types.TransactionIdentifier, error) BlockTransaction( context.Context, *types.BlockTransactionRequest, ) (*types.Transaction, error) Balance( context.Context, *types.AccountIdentifier, []*types.Currency, *types.PartialBlockIdentifier, ) (*types.AccountBalanceResponse, error) ConstructionMetadata( context.Context, *vite.ConstructionOptions, ) (*vite.ConstructionMetadata, error) SendTransaction(context.Context, *api.AccountBlock) error }
Client is used by the services to get block data and to submit transactions.
type ConstructionAPIService ¶
type ConstructionAPIService struct {
// contains filtered or unexported fields
}
ConstructionAPIService implements the server.ConstructionAPIServicer interface.
func NewConstructionAPIService ¶
func NewConstructionAPIService( cfg *configuration.Configuration, client Client, ) *ConstructionAPIService
NewConstructionAPIService creates a new instance of a ConstructionAPIService.
func (*ConstructionAPIService) ConstructionCombine ¶
func (s *ConstructionAPIService) ConstructionCombine( ctx context.Context, request *types.ConstructionCombineRequest, ) (*types.ConstructionCombineResponse, *types.Error)
ConstructionCombine implements the /construction/combine endpoint.
func (*ConstructionAPIService) ConstructionDerive ¶
func (s *ConstructionAPIService) ConstructionDerive( ctx context.Context, request *types.ConstructionDeriveRequest, ) (*types.ConstructionDeriveResponse, *types.Error)
ConstructionDerive implements the /construction/derive endpoint.
func (*ConstructionAPIService) ConstructionHash ¶
func (s *ConstructionAPIService) ConstructionHash( ctx context.Context, request *types.ConstructionHashRequest, ) (*types.TransactionIdentifierResponse, *types.Error)
ConstructionHash implements the /construction/hash endpoint.
func (*ConstructionAPIService) ConstructionMetadata ¶
func (s *ConstructionAPIService) ConstructionMetadata( ctx context.Context, request *types.ConstructionMetadataRequest, ) (*types.ConstructionMetadataResponse, *types.Error)
ConstructionMetadata implements the /construction/metadata endpoint.
func (*ConstructionAPIService) ConstructionParse ¶
func (s *ConstructionAPIService) ConstructionParse( ctx context.Context, request *types.ConstructionParseRequest, ) (*types.ConstructionParseResponse, *types.Error)
ConstructionParse implements the /construction/parse endpoint.
func (*ConstructionAPIService) ConstructionPayloads ¶
func (s *ConstructionAPIService) ConstructionPayloads( ctx context.Context, request *types.ConstructionPayloadsRequest, ) (*types.ConstructionPayloadsResponse, *types.Error)
ConstructionPayloads implements the /construction/payloads endpoint.
func (*ConstructionAPIService) ConstructionPreprocess ¶
func (s *ConstructionAPIService) ConstructionPreprocess( ctx context.Context, request *types.ConstructionPreprocessRequest, ) (*types.ConstructionPreprocessResponse, *types.Error)
ConstructionPreprocess implements the /construction/preprocess endpoint.
func (*ConstructionAPIService) ConstructionSubmit ¶
func (s *ConstructionAPIService) ConstructionSubmit( ctx context.Context, request *types.ConstructionSubmitRequest, ) (*types.TransactionIdentifierResponse, *types.Error)
ConstructionSubmit implements the /construction/submit endpoint.
type NetworkAPIService ¶
type NetworkAPIService struct {
// contains filtered or unexported fields
}
NetworkAPIService implements the server.NetworkAPIServicer interface.
func NewNetworkAPIService ¶
func NewNetworkAPIService( cfg *configuration.Configuration, client Client, ) *NetworkAPIService
NewNetworkAPIService creates a new instance of a NetworkAPIService.
func (*NetworkAPIService) NetworkList ¶
func (s *NetworkAPIService) NetworkList( ctx context.Context, request *types.MetadataRequest, ) (*types.NetworkListResponse, *types.Error)
NetworkList implements the /network/list endpoint
func (*NetworkAPIService) NetworkOptions ¶
func (s *NetworkAPIService) NetworkOptions( ctx context.Context, request *types.NetworkRequest, ) (*types.NetworkOptionsResponse, *types.Error)
NetworkOptions implements the /network/options endpoint.
func (*NetworkAPIService) NetworkStatus ¶
func (s *NetworkAPIService) NetworkStatus( ctx context.Context, request *types.NetworkRequest, ) (*types.NetworkStatusResponse, *types.Error)
NetworkStatus implements the /network/status endpoint.