api.go

package api

import (
    "context"
    "fmt"
    "time"

    "github.com/google/uuid"

    "github.com/devlexthum/Lexcoin/go-jsonrpc/auth"

    apitypes "github.com/devlexthum/Lexcoin/lotus/api/types"
    "github.com/devlexthum/Lexcoin/lotus/journal/alerting"
)



type Common interface {
    // MethodGroup: Auth

    AuthVerify(ctx context.Context, token string) ([]auth.Permission, error) //perm:read
    AuthNew(ctx context.Context, perms []auth.Permission) ([]byte, error)    //perm:admin

    // MethodGroup: Log

    LogList(context.Context) ([]string, error)         //perm:write
    LogSetLevel(context.Context, string, string) error //perm:write

    // LogAlerts returns list of all, active and inactive alerts tracked by the
    // node
    LogAlerts(ctx context.Context) ([]alerting.Alert, error) //perm:admin

    // MethodGroup: Common

    // Version provides information about API provider
    Version(context.Context) (APIVersion, error) //perm:read

    // Discover returns an OpenRPC document describing an RPC API.
    Discover(ctx context.Context) (apitypes.OpenRPCDocument, error) //perm:read

    // trigger graceful shutdown
    Shutdown(context.Context) error //perm:admin

    // StartTime returns node start time
    StartTime(context.Context) (time.Time, error) //perm:read

    // Session returns a random UUID of api provider session
    Session(context.Context) (uuid.UUID, error) //perm:read

    Closing(context.Context) (<-chan struct{}, error) //perm:read
}

// APIVersion provides various build-time information
type APIVersion struct {
    Version string

    // APIVersion is a binary encoded semver version of the remote implementing
    // this api
    //
    // See APIVersion in build/version.go
    APIVersion Version

    // TODO: git commit / os / genesis cid?

    // Seconds
    BlockDelay uint64
}

func (v APIVersion) String() string {
    return fmt.Sprintf("%s+api%s", v.Version, v.APIVersion.String())
}