usersvc

package
v0.9.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 29 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	SpecInfo = openrpc.Info{
		Title:       "Kwil DB user service",
		Description: `The JSON-RPC user service for Kwil DB.`,
		License: &openrpc.License{
			Name: "CC0-1.0",
			URL:  "https://creativecommons.org/publicdomain/zero/1.0/legalcode",
		},
		Version: "0.1.0",
	}
)

Functions

func OpenRPCSpec 

func OpenRPCSpec() openrpc.Spec

Types

type ABCI added in v0.9.0 

type ABCI interface {
	Price(ctx context.Context, db sql.DB, tx *transactions.Transaction) (*big.Int, error)
	GetMigrationMetadata(ctx context.Context) (*types.MigrationMetadata, error)
}

type BlockchainTransactor 

type BlockchainTransactor interface {
	Status(ctx context.Context) (*adminTypes.Status, error)
	Peers(context.Context) ([]*adminTypes.PeerInfo, error)
	BroadcastTx(ctx context.Context, tx []byte, sync uint8) (*cmtCoreTypes.ResultBroadcastTx, error)
	TxQuery(ctx context.Context, hash []byte, prove bool) (*cmtCoreTypes.ResultTx, error)
}

type DB added in v0.9.0 

type DB interface {
	sql.ReadTxMaker
	sql.DelayedReadTxMaker
}

type EngineReader 

type EngineReader interface {
	Procedure(ctx *common.TxContext, tx sql.DB, options *common.ExecutionData) (*sql.ResultSet, error)
	GetSchema(dbid string) (*types.Schema, error)
	ListDatasets(owner []byte) ([]*types.DatasetIdentifier, error)
	Execute(ctx *common.TxContext, tx sql.DB, dbid string, query string, values map[string]any) (*sql.ResultSet, error)
}

type Migrator added in v0.9.0 

type Migrator interface {
	GetChangesetMetadata(height int64) (*migrations.ChangesetMetadata, error)
	GetChangeset(height int64, index int64) ([]byte, error)
	GetGenesisSnapshotChunk(chunkIdx uint32) ([]byte, error)
}

type NodeApplication 

type NodeApplication interface {
	AccountInfo(ctx context.Context, db sql.DB, identifier []byte, getUncommitted bool) (balance *big.Int, nonce int64, err error)
}

type Opt 

type Opt func(*serviceCfg)

Opt is a Service option.

func WithBlockAgeHealth added in v0.9.0 

func WithBlockAgeHealth(ageThresh time.Duration) Opt

func WithChallengeExpiry added in v0.9.0 

func WithChallengeExpiry(expiry time.Duration) Opt

func WithChallengeRateLimit added in v0.9.0 

func WithChallengeRateLimit(limit float64) Opt

func WithPrivateMode added in v0.9.0 

func WithPrivateMode(privateMode bool) Opt

func WithReadTxTimeout 

func WithReadTxTimeout(timeout time.Duration) Opt

WithReadTxTimeout sets a timeout for read-only DB transactions, as used by the Query and Call methods of Service.

type Service 

type Service struct {
	// contains filtered or unexported fields
}

Service is the "user" RPC service, also known as txsvc in other contexts.

func NewService 

func NewService(db DB, engine EngineReader, chainClient BlockchainTransactor,
	nodeApp NodeApplication, abci ABCI, migrator Migrator, logger log.Logger, opts ...Opt) *Service

NewService creates a new instance of the user RPC service.

func (*Service) Account 

func (svc *Service) Account(ctx context.Context, req *userjson.AccountRequest) (*userjson.AccountResponse, *jsonrpc.Error)

func (*Service) Broadcast 

func (svc *Service) Broadcast(ctx context.Context, req *userjson.BroadcastRequest) (*userjson.BroadcastResponse, *jsonrpc.Error)

func (*Service) Call 

func (svc *Service) Call(ctx context.Context, req *userjson.CallRequest) (*userjson.CallResponse, *jsonrpc.Error)

func (*Service) CallChallenge added in v0.9.0 

func (svc *Service) CallChallenge(ctx context.Context, req *userjson.ChallengeRequest) (*userjson.ChallengeResponse, *jsonrpc.Error)

CallChallenge is the handler for the user.challenge RPC. It gives the user a new challenge for use with a signed call request. They are single use, and they expire according to the service's challenge expiry configuration.

func (*Service) ChainInfo 

func (svc *Service) ChainInfo(ctx context.Context, req *userjson.ChainInfoRequest) (*userjson.ChainInfoResponse, *jsonrpc.Error)

func (*Service) EstimatePrice 

func (svc *Service) EstimatePrice(ctx context.Context, req *userjson.EstimatePriceRequest) (*userjson.EstimatePriceResponse, *jsonrpc.Error)

func (*Service) Handlers 

func (svc *Service) Handlers() map[jsonrpc.Method]rpcserver.MethodHandler

func (*Service) Health added in v0.9.0 

func (svc *Service) Health(ctx context.Context) (json.RawMessage, bool)

Health for the user service responds with details from publicly available information from the chain_info response such as best block age. The health boolean also considers node state.

func (*Service) HealthMethod added in v0.9.0 

func (svc *Service) HealthMethod(ctx context.Context, _ *userjson.HealthRequest) (*userjson.HealthResponse, *jsonrpc.Error)

HealthMethod is a JSON-RPC method handler for service health.

func (*Service) ListDatabases 

func (svc *Service) ListDatabases(ctx context.Context, req *userjson.ListDatabasesRequest) (*userjson.ListDatabasesResponse, *jsonrpc.Error)

func (*Service) ListPendingMigrations added in v0.9.0 

func (svc *Service) ListPendingMigrations(ctx context.Context, req *userjson.ListMigrationsRequest) (*userjson.ListMigrationsResponse, *jsonrpc.Error)

func (*Service) LoadChangeset added in v0.9.0 

func (svc *Service) LoadChangeset(ctx context.Context, req *userjson.ChangesetRequest) (*userjson.ChangesetsResponse, *jsonrpc.Error)

func (*Service) LoadChangesetMetadata added in v0.9.0 

func (svc *Service) LoadChangesetMetadata(ctx context.Context, req *userjson.ChangesetMetadataRequest) (*userjson.ChangesetMetadataResponse, *jsonrpc.Error)

func (*Service) Methods 

func (svc *Service) Methods() map[jsonrpc.Method]rpcserver.MethodDef

func (*Service) MigrationGenesisChunk added in v0.9.0 

func (svc *Service) MigrationGenesisChunk(ctx context.Context, req *userjson.MigrationSnapshotChunkRequest) (*userjson.MigrationSnapshotChunkResponse, *jsonrpc.Error)

func (*Service) MigrationMetadata added in v0.9.0 

func (svc *Service) MigrationMetadata(ctx context.Context, req *userjson.MigrationMetadataRequest) (*userjson.MigrationMetadataResponse, *jsonrpc.Error)

func (*Service) MigrationStatus added in v0.9.0 

func (svc *Service) MigrationStatus(ctx context.Context, req *userjson.MigrationStatusRequest) (*userjson.MigrationStatusResponse, *jsonrpc.Error)

func (*Service) Name added in v0.9.0 

func (svc *Service) Name() string

func (*Service) Ping 

func (svc *Service) Ping(ctx context.Context, req *userjson.PingRequest) (*userjson.PingResponse, *jsonrpc.Error)

func (*Service) Query 

func (svc *Service) Query(ctx context.Context, req *userjson.QueryRequest) (*userjson.QueryResponse, *jsonrpc.Error)

func (*Service) Schema 

func (svc *Service) Schema(ctx context.Context, req *userjson.SchemaRequest) (*userjson.SchemaResponse, *jsonrpc.Error)

func (*Service) TxQuery 

func (svc *Service) TxQuery(ctx context.Context, req *userjson.TxQueryRequest) (*userjson.TxQueryResponse, *jsonrpc.Error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.