metadata

package
v1.2.4 Latest Latest
Warning

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

 Go to latest Published: Jan 12, 2024 License: GPL-3.0 Imports: 34 Imported by: 0

README

Metadata

Metadata service is to supply better query service for the Inscription network. Users can interact with SP for some complex query services. Some interfaces can be costly to implement on the chain or can cause significant latency. metadata service is designed to implement the corresponding interface under the chain and provide it to the SP to achieve high performance and low latency. The events' data are optimally stored by the block syncer and provided to the metadata. Also, it provides additional extensions such as Pagination, Sort Key, and filtering. etc.

Role

Sync all the Greenfield chain data to the distributed stores, and offers the read RPC requests for chain data(in addition to payload). SP service will query the info, E.g. permission, ListBucket, ListObject, etc. It will reduce the pressure on the Greenfield chain.

Scalability

At present, the main role of metadata is to provide better scalability, and two main points are considered in the process of interface development:

  1. the creation of interfaces that are not currently supported on the chain
  2. metadata can provide better performance and low latency interfaces compared to those on the chain

Documentation

Index

Constants

View Source 
const (
	// DefaultQuerySPParallelPerNode defines the max parallel for retrieving request
	DefaultQuerySPParallelPerNode int64 = 10240
	// DefaultBsDBSwitchCheckIntervalSec defines the default db switch check interval in seconds
	DefaultBsDBSwitchCheckIntervalSec = 30
)
View Source 
const (
	DefaultMetadataStatisticsInterval = 60
)

Variables

View Source 
var (
	ErrDanglingPointer   = gfsperrors.Register(coremodule.MetadataModularName, http.StatusBadRequest, 90001, "OoooH... request lost, try again later")
	ErrExceedRequest     = gfsperrors.Register(coremodule.MetadataModularName, http.StatusNotAcceptable, 90002, "request exceed")
	ErrNoRecord          = gfsperrors.Register(coremodule.MetadataModularName, http.StatusNotFound, 90003, "no uploading record")
	ErrNoSuchSP          = gfsperrors.Register(coremodule.MetadataModularName, http.StatusNotFound, 90004, "no such sp")
	ErrExceedBlockHeight = gfsperrors.Register(coremodule.MetadataModularName, http.StatusBadRequest, 90005, "request block height exceed latest height")
	// ErrInvalidParams defines invalid params
	ErrInvalidParams = gfsperrors.Register(coremodule.MetadataModularName, http.StatusBadRequest, 90006, "invalid params")
	// ErrInvalidBucketName defines invalid bucket name
	ErrInvalidBucketName = gfsperrors.Register(coremodule.MetadataModularName, http.StatusBadRequest, 90007, "invalid bucket name")
	// ErrNoSuchBucket defines not existed bucket error
	ErrNoSuchBucket = gfsperrors.Register(coremodule.MetadataModularName, http.StatusNotFound, 90008, "the specified bucket does not exist")
	// ErrNoSuchGroup defines not existed group error
	ErrNoSuchGroup = gfsperrors.Register(coremodule.MetadataModularName, http.StatusNotFound, 90009, "the specified group does not exist")
	// ErrNoSuchObject defines not existed object error
	ErrNoSuchObject = gfsperrors.Register(coremodule.MetadataModularName, http.StatusNotFound, 90010, "the specified object does not exist")
)
View Source 
var (
	BsModules []string
	BsWorkers uint

	ChainID      string
	ChainAddress []string

	SpOperatorAddress string
	GatewayDomainName string
)

Functions

func DefaultMetadataOptions 

func DefaultMetadataOptions(metadata *MetadataModular, cfg *gfspconfig.GfSpConfig) error

func ErrGfSpDBWithDetail added in v0.2.4 

func ErrGfSpDBWithDetail(detail string) *gfsperrors.GfSpError

func NewMetadataModular 

func NewMetadataModular(app *gfspapp.GfSpBaseApp, cfg *gfspconfig.GfSpConfig) (coremodule.Modular, error)

Types

type MetadataModular 

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

func (*MetadataModular) GfSpGetBucketByBucketID 

func (r *MetadataModular) GfSpGetBucketByBucketID(ctx context.Context, req *types.GfSpGetBucketByBucketIDRequest) (
	resp *types.GfSpGetBucketByBucketIDResponse, err error)

GfSpGetBucketByBucketID get buckets info by by a bucket id

func (*MetadataModular) GfSpGetBucketByBucketName 

func (r *MetadataModular) GfSpGetBucketByBucketName(ctx context.Context, req *types.GfSpGetBucketByBucketNameRequest) (resp *types.GfSpGetBucketByBucketNameResponse, err error)

GfSpGetBucketByBucketName get buckets info by a bucket name

func (*MetadataModular) GfSpGetBucketMeta 

func (r *MetadataModular) GfSpGetBucketMeta(ctx context.Context, req *types.GfSpGetBucketMetaRequest) (
	resp *types.GfSpGetBucketMetaResponse, err error)

GfSpGetBucketMeta get bucket metadata

func (*MetadataModular) GfSpGetBucketReadQuota 

func (r *MetadataModular) GfSpGetBucketReadQuota(
	ctx context.Context,
	req *types.GfSpGetBucketReadQuotaRequest) (
	*types.GfSpGetBucketReadQuotaResponse, error)

func (*MetadataModular) GfSpGetBucketSize added in v1.1.0 

func (r *MetadataModular) GfSpGetBucketSize(ctx context.Context, req *types.GfSpGetBucketSizeRequest) (resp *types.GfSpGetBucketSizeResponse, err error)

GfSpGetBucketSize get bucket total object size

func (*MetadataModular) GfSpGetEndpointBySpID added in v0.2.4 

func (r *MetadataModular) GfSpGetEndpointBySpID(
	ctx context.Context,
	req *types.GfSpGetEndpointBySpIDRequest) (
	resp *types.GfSpGetEndpointBySpIDResponse, err error)

GfSpGetEndpointBySpID get endpoint by sp id

func (*MetadataModular) GfSpGetGlobalVirtualGroup added in v0.2.3 

func (r *MetadataModular) GfSpGetGlobalVirtualGroup(ctx context.Context, req *types.GfSpGetGlobalVirtualGroupRequest) (resp *types.GfSpGetGlobalVirtualGroupResponse, err error)

GfSpGetGlobalVirtualGroup get global virtual group by lvg id and bucket id

func (*MetadataModular) GfSpGetGlobalVirtualGroupByGvgID added in v0.2.3 

func (r *MetadataModular) GfSpGetGlobalVirtualGroupByGvgID(ctx context.Context, req *types.GfSpGetGlobalVirtualGroupByGvgIDRequest) (resp *types.GfSpGetGlobalVirtualGroupByGvgIDResponse, err error)

GfSpGetGlobalVirtualGroupByGvgID get global virtual group by gvg id

func (*MetadataModular) GfSpGetGroupList 

func (r *MetadataModular) GfSpGetGroupList(ctx context.Context, req *types.GfSpGetGroupListRequest) (resp *types.GfSpGetGroupListResponse, err error)

GfSpGetGroupList get group list by queryName/prefix/sourceType

func (*MetadataModular) GfSpGetGroupMembers added in v0.2.4 

func (r *MetadataModular) GfSpGetGroupMembers(ctx context.Context, req *types.GfSpGetGroupMembersRequest) (resp *types.GfSpGetGroupMembersResponse, err error)

GfSpGetGroupMembers get group members by group id

func (*MetadataModular) GfSpGetLatestBucketReadQuota added in v1.1.0 

func (r *MetadataModular) GfSpGetLatestBucketReadQuota(
	ctx context.Context,
	req *types.GfSpGetLatestBucketReadQuotaRequest) (
	*types.GfSpGetLatestBucketReadQuotaResponse, error)

func (*MetadataModular) GfSpGetLatestObjectID added in v1.2.0 

func (r *MetadataModular) GfSpGetLatestObjectID(ctx context.Context, req *types.GfSpGetLatestObjectIDRequest) (resp *types.GfSpGetLatestObjectIDResponse, err error)

GfSpGetLatestObjectID get latest object id

func (*MetadataModular) GfSpGetObjectMeta 

func (r *MetadataModular) GfSpGetObjectMeta(ctx context.Context, req *types.GfSpGetObjectMetaRequest) (resp *types.GfSpGetObjectMetaResponse, err error)

GfSpGetObjectMeta get object metadata

func (*MetadataModular) GfSpGetPaymentByBucketID 

func (r *MetadataModular) GfSpGetPaymentByBucketID(ctx context.Context, req *types.GfSpGetPaymentByBucketIDRequest) (resp *types.GfSpGetPaymentByBucketIDResponse, err error)

GfSpGetPaymentByBucketID get bucket payment info by a bucket id

func (*MetadataModular) GfSpGetPaymentByBucketName 

func (r *MetadataModular) GfSpGetPaymentByBucketName(ctx context.Context, req *types.GfSpGetPaymentByBucketNameRequest) (resp *types.GfSpGetPaymentByBucketNameResponse, err error)

GfSpGetPaymentByBucketName get bucket payment info by a bucket name

func (*MetadataModular) GfSpGetSPInfo added in v0.2.3 

func (r *MetadataModular) GfSpGetSPInfo(ctx context.Context, req *types.GfSpGetSPInfoRequest) (resp *types.GfSpGetSPInfoResponse, err error)

GfSpGetSPInfo get sp info by operator address

func (*MetadataModular) GfSpGetSPMigratingBucketNumber added in v0.2.5 

func (r *MetadataModular) GfSpGetSPMigratingBucketNumber(ctx context.Context, req *types.GfSpGetSPMigratingBucketNumberRequest) (resp *types.GfSpGetSPMigratingBucketNumberResponse, err error)

GfSpGetSPMigratingBucketNumber get the latest active migrating bucket by specific sp

func (*MetadataModular) GfSpGetStatus added in v0.2.4 

func (r *MetadataModular) GfSpGetStatus(ctx context.Context, req *types.GfSpGetStatusRequest) (resp *types.GfSpGetStatusResponse, err error)

func (*MetadataModular) GfSpGetUserBuckets 

func (r *MetadataModular) GfSpGetUserBuckets(ctx context.Context, req *types.GfSpGetUserBucketsRequest) (
	resp *types.GfSpGetUserBucketsResponse, err error)

func (*MetadataModular) GfSpGetUserBucketsCount 

func (r *MetadataModular) GfSpGetUserBucketsCount(ctx context.Context, req *types.GfSpGetUserBucketsCountRequest) (
	resp *types.GfSpGetUserBucketsCountResponse, err error)

GfSpGetUserBucketsCount get buckets count by a user address

func (*MetadataModular) GfSpGetUserGroups added in v0.2.4 

func (r *MetadataModular) GfSpGetUserGroups(ctx context.Context, req *types.GfSpGetUserGroupsRequest) (resp *types.GfSpGetUserGroupsResponse, err error)

GfSpGetUserGroups get groups info by a user address

func (*MetadataModular) GfSpGetUserOwnedGroups added in v0.2.4 

func (r *MetadataModular) GfSpGetUserOwnedGroups(ctx context.Context, req *types.GfSpGetUserOwnedGroupsRequest) (resp *types.GfSpGetUserOwnedGroupsResponse, err error)

GfSpGetUserOwnedGroups retrieve groups where the user is the owner

func (*MetadataModular) GfSpGetVirtualGroupFamily added in v0.2.3 

func (r *MetadataModular) GfSpGetVirtualGroupFamily(ctx context.Context, req *types.GfSpGetVirtualGroupFamilyRequest) (resp *types.GfSpGetVirtualGroupFamilyResponse, err error)

GfSpGetVirtualGroupFamily get virtual group families by vgf id

func (*MetadataModular) GfSpListBucketReadRecord 

func (r *MetadataModular) GfSpListBucketReadRecord(
	ctx context.Context,
	req *types.GfSpListBucketReadRecordRequest) (
	*types.GfSpListBucketReadRecordResponse,
	error)

func (*MetadataModular) GfSpListBucketsByIDs added in v0.2.4 

func (r *MetadataModular) GfSpListBucketsByIDs(ctx context.Context, req *types.GfSpListBucketsByIDsRequest) (
	resp *types.GfSpListBucketsByIDsResponse, err error)

GfSpListBucketsByIDs list buckets by bucket ids

func (*MetadataModular) GfSpListDeletedObjectsByBlockNumberRange 

func (r *MetadataModular) GfSpListDeletedObjectsByBlockNumberRange(ctx context.Context, req *types.GfSpListDeletedObjectsByBlockNumberRangeRequest) (resp *types.GfSpListDeletedObjectsByBlockNumberRangeResponse, err error)

GfSpListDeletedObjectsByBlockNumberRange list deleted objects info by a block number range

func (*MetadataModular) GfSpListExpiredBucketsBySp 

func (r *MetadataModular) GfSpListExpiredBucketsBySp(ctx context.Context, req *types.GfSpListExpiredBucketsBySpRequest) (
	resp *types.GfSpListExpiredBucketsBySpResponse, err error)

GfSpListExpiredBucketsBySp list expired bucket by sp

func (*MetadataModular) GfSpListGlobalVirtualGroupsByBucket added in v0.2.3 

func (r *MetadataModular) GfSpListGlobalVirtualGroupsByBucket(ctx context.Context, req *types.GfSpListGlobalVirtualGroupsByBucketRequest) (resp *types.GfSpListGlobalVirtualGroupsByBucketResponse, err error)

GfSpListGlobalVirtualGroupsByBucket list global virtual group by bucket id

func (*MetadataModular) GfSpListGlobalVirtualGroupsBySecondarySP added in v0.2.3 

func (r *MetadataModular) GfSpListGlobalVirtualGroupsBySecondarySP(ctx context.Context, req *types.GfSpListGlobalVirtualGroupsBySecondarySPRequest) (resp *types.GfSpListGlobalVirtualGroupsBySecondarySPResponse, err error)

GfSpListGlobalVirtualGroupsBySecondarySP list global virtual group by secondary sp id

func (*MetadataModular) GfSpListGroupsByIDs added in v0.2.5 

func (r *MetadataModular) GfSpListGroupsByIDs(ctx context.Context, req *types.GfSpListGroupsByIDsRequest) (resp *types.GfSpListGroupsByIDsResponse, err error)

GfSpListGroupsByIDs list groups by group ids

func (*MetadataModular) GfSpListMigrateBucketEvents added in v0.2.3 

func (r *MetadataModular) GfSpListMigrateBucketEvents(ctx context.Context, req *types.GfSpListMigrateBucketEventsRequest) (resp *types.GfSpListMigrateBucketEventsResponse, err error)

GfSpListMigrateBucketEvents list migrate bucket events

func (*MetadataModular) GfSpListObjectPolicies added in v0.2.5 

func (r *MetadataModular) GfSpListObjectPolicies(ctx context.Context, req *types.GfSpListObjectPoliciesRequest) (resp *types.GfSpListObjectPoliciesResponse, err error)

GfSpListObjectPolicies list policies by object info

func (*MetadataModular) GfSpListObjectsByBucketName 

func (r *MetadataModular) GfSpListObjectsByBucketName(ctx context.Context, req *types.GfSpListObjectsByBucketNameRequest) (resp *types.GfSpListObjectsByBucketNameResponse, err error)

GfSpListObjectsByBucketName list objects info by a bucket name

func (*MetadataModular) GfSpListObjectsByGVGAndBucketForGC added in v0.2.3 

func (r *MetadataModular) GfSpListObjectsByGVGAndBucketForGC(ctx context.Context, req *types.GfSpListObjectsByGVGAndBucketForGCRequest) (resp *types.GfSpListObjectsByGVGAndBucketForGCResponse, err error)

GfSpListObjectsByGVGAndBucketForGC list objects by gvg and bucket for gc

func (*MetadataModular) GfSpListObjectsByIDs added in v0.2.4 

func (r *MetadataModular) GfSpListObjectsByIDs(ctx context.Context, req *types.GfSpListObjectsByIDsRequest) (resp *types.GfSpListObjectsByIDsResponse, err error)

GfSpListObjectsByIDs list objects by object ids

func (*MetadataModular) GfSpListObjectsInGVG added in v0.2.3 

func (r *MetadataModular) GfSpListObjectsInGVG(ctx context.Context, req *types.GfSpListObjectsInGVGRequest) (resp *types.GfSpListObjectsInGVGResponse, err error)

GfSpListObjectsInGVG list objects by gvg and bucket id

func (*MetadataModular) GfSpListObjectsInGVGAndBucket added in v0.2.3 

func (r *MetadataModular) GfSpListObjectsInGVGAndBucket(ctx context.Context, req *types.GfSpListObjectsInGVGAndBucketRequest) (resp *types.GfSpListObjectsInGVGAndBucketResponse, err error)

GfSpListObjectsInGVGAndBucket list objects by gvg and bucket id

func (*MetadataModular) GfSpListPaymentAccountStreams added in v0.2.5 

func (r *MetadataModular) GfSpListPaymentAccountStreams(ctx context.Context, req *types.GfSpListPaymentAccountStreamsRequest) (resp *types.GfSpListPaymentAccountStreamsResponse, err error)

GfSpListPaymentAccountStreams list payment account streams

func (*MetadataModular) GfSpListSpExitEvents added in v0.2.3 

func (r *MetadataModular) GfSpListSpExitEvents(ctx context.Context, req *types.GfSpListSpExitEventsRequest) (resp *types.GfSpListSpExitEventsResponse, err error)

GfSpListSpExitEvents list migrate sp exit events

func (*MetadataModular) GfSpListSwapOutEvents added in v0.2.3 

func (r *MetadataModular) GfSpListSwapOutEvents(ctx context.Context, req *types.GfSpListSwapOutEventsRequest) (resp *types.GfSpListSwapOutEventsResponse, err error)

GfSpListSwapOutEvents list swap out events

func (*MetadataModular) GfSpListUserPaymentAccounts added in v0.2.5 

func (r *MetadataModular) GfSpListUserPaymentAccounts(ctx context.Context, req *types.GfSpListUserPaymentAccountsRequest) (resp *types.GfSpListUserPaymentAccountsResponse, err error)

GfSpListUserPaymentAccounts list payment accounts by owner address

func (*MetadataModular) GfSpListVirtualGroupFamiliesBySpID added in v0.2.3 

func (r *MetadataModular) GfSpListVirtualGroupFamiliesBySpID(ctx context.Context, req *types.GfSpListVirtualGroupFamiliesBySpIDRequest) (resp *types.GfSpListVirtualGroupFamiliesBySpIDResponse, err error)

GfSpListVirtualGroupFamiliesBySpID list virtual group families by sp id

func (*MetadataModular) GfSpPrimarySpIncomeDetails added in v1.1.0 

func (r *MetadataModular) GfSpPrimarySpIncomeDetails(ctx context.Context, req *types.GfSpPrimarySpIncomeDetailsRequest) (resp *types.GfSpPrimarySpIncomeDetailsResponse, err error)

func (*MetadataModular) GfSpQueryResumableUploadSegment added in v0.2.3 

func (r *MetadataModular) GfSpQueryResumableUploadSegment(ctx context.Context, req *types.GfSpQueryResumableUploadSegmentRequest) (
	*types.GfSpQueryResumableUploadSegmentResponse, error)

func (*MetadataModular) GfSpQueryUploadProgress 

func (r *MetadataModular) GfSpQueryUploadProgress(ctx context.Context, req *types.GfSpQueryUploadProgressRequest) (
	*types.GfSpQueryUploadProgressResponse, error)

func (*MetadataModular) GfSpSecondarySpIncomeDetails added in v1.1.0 

func (r *MetadataModular) GfSpSecondarySpIncomeDetails(ctx context.Context, req *types.GfSpSecondarySpIncomeDetailsRequest) (resp *types.GfSpSecondarySpIncomeDetailsResponse, err error)

func (*MetadataModular) GfSpVerifyMigrateGVGPermission added in v0.2.6 

func (r *MetadataModular) GfSpVerifyMigrateGVGPermission(ctx context.Context, req *types.GfSpVerifyMigrateGVGPermissionRequest) (resp *types.GfSpVerifyMigrateGVGPermissionResponse, err error)

GfSpVerifyMigrateGVGPermission verify the destination sp id of bucket migration & swap out When bucketID is not 0, it means bucket migration; otherwise, it means SP exit

func (*MetadataModular) GfSpVerifyPermission 

func (r *MetadataModular) GfSpVerifyPermission(ctx context.Context, req *storagetypes.QueryVerifyPermissionRequest) (resp *storagetypes.QueryVerifyPermissionResponse, err error)

GfSpVerifyPermission Verify the input account’s permission to input items

func (*MetadataModular) GfSpVerifyPermissionByID added in v0.2.3 

func (r *MetadataModular) GfSpVerifyPermissionByID(ctx context.Context, req *types.GfSpVerifyPermissionByIDRequest) (resp *types.GfSpVerifyPermissionByIDResponse, err error)

GfSpVerifyPermissionByID Verify the input account’s permission to input source type and resource id

func (*MetadataModular) Name 

func (r *MetadataModular) Name() string

func (*MetadataModular) ReleaseResource 

func (r *MetadataModular) ReleaseResource(ctx context.Context, span rcmgr.ResourceScopeSpan)

func (*MetadataModular) ReserveResource 

func (r *MetadataModular) ReserveResource(ctx context.Context, state *rcmgr.ScopeStat) (rcmgr.ResourceScopeSpan, error)

func (*MetadataModular) Start 

func (r *MetadataModular) Start(ctx context.Context) error

func (*MetadataModular) Stop 

func (r *MetadataModular) Stop(ctx context.Context) error

func (*MetadataModular) VerifyBucketPermission 

func (r *MetadataModular) VerifyBucketPermission(ctx context.Context, bucketInfo *bsdb.Bucket, operator sdk.AccAddress,
	action permtypes.ActionType, options *permtypes.VerifyOptions) (permtypes.Effect, error)

VerifyBucketPermission verify bucket permission

func (*MetadataModular) VerifyGroupPermission added in v0.2.3 

func (r *MetadataModular) VerifyGroupPermission(ctx context.Context, groupInfo *bsdb.Group, operator sdk.AccAddress,
	action permtypes.ActionType) (permtypes.Effect, error)

VerifyGroupPermission verify group permission

func (*MetadataModular) VerifyObjectPermission 

func (r *MetadataModular) VerifyObjectPermission(ctx context.Context, bucketInfo *bsdb.Bucket, objectInfo *bsdb.Object,
	operator sdk.AccAddress, action permtypes.ActionType) (permtypes.Effect, error)

VerifyObjectPermission verify object permission

func (*MetadataModular) VerifyPolicy 

func (r *MetadataModular) VerifyPolicy(ctx context.Context, resourceID math.Uint, resourceType resource.ResourceType,
	operator sdk.AccAddress, action permtypes.ActionType, opts *permtypes.VerifyOptions) (permtypes.Effect, error)

VerifyPolicy verify policy of permission

Source Files

View all Source files

Directories

Path Synopsis

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.