keeper

package
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Mar 5, 2021 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewMsgServerImpl

func NewMsgServerImpl(keeper Keeper) types.MsgServer

NewMsgServerImpl returns an implementation of the distribution MsgServer interface for the provided Keeper.

func NewQuerier

func NewQuerier(k Keeper, legacyQuerierCdc *codec.LegacyAmino) sdk.Querier

NewQuerier creates a querier for auth REST endpoints

Types

type Keeper

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

Keeper is the concrete state-based API for the metadata module.

func NewKeeper

func NewKeeper(
	cdc codec.BinaryMarshaler, key sdk.StoreKey, paramSpace paramtypes.Subspace,
	authKeeper authkeeper.AccountKeeper,
) Keeper

NewKeeper creates new instances of the metadata Keeper.

func (Keeper) AccountIsMarker

func (k Keeper) AccountIsMarker(ctx sdk.Context, address string) bool

AccountIsMarker determines if account is marker

func (Keeper) ContractSpecification added in v0.1.5

ContractSpecification returns a specific contract specification by id

func (Keeper) ContractSpecificationExtended added in v0.2.0

ContractSpecificationExtended returns a specific contract specification and record specifications by contract specification id

func (Keeper) CreateAccountForKey

func (k Keeper) CreateAccountForKey(ctx sdk.Context, addr sdk.AccAddress, pubKey cryptotypes.PubKey) error

CreateAccountForKey creates a new account for the given address with a public key set if given.

func (Keeper) CreateRawSignature

func (k Keeper) CreateRawSignature(txf clienttx.Factory, name string, txBuilder client.TxBuilder, message []byte, appendSignature bool) error

CreateRawSignature creates a standard TX signature but uses the message bytes as provided instead of the typical approach of building a signing structure with sequence, chain-id, and account number. This approach is required for independent signatures like those used in the contract memorialize process which are independent of blockchain tx and their replay protection.

func (Keeper) ExportGenesis

func (k Keeper) ExportGenesis(ctx sdk.Context) (data *types.GenesisState)

ExportGenesis exports the current keeper state of the metadata module.ExportGenesis

func (Keeper) GetAccount

func (k Keeper) GetAccount(ctx sdk.Context, addr sdk.AccAddress) authtypes.AccountI

GetAccount looks up an account by address

func (Keeper) GetContractSpecification added in v0.1.5

func (k Keeper) GetContractSpecification(ctx sdk.Context, contractSpecID types.MetadataAddress) (spec types.ContractSpecification, found bool)

GetContractSpecification returns the contract spec with the given id.

func (Keeper) GetParams

func (k Keeper) GetParams(ctx sdk.Context) (params types.Params)

GetParams returns the total set of metadata parameters.

func (Keeper) GetRecord

func (k Keeper) GetRecord(ctx sdk.Context, id types.MetadataAddress) (record types.Record, found bool)

GetRecord returns the record with the given id.

func (Keeper) GetRecordSpecification added in v0.2.0

func (k Keeper) GetRecordSpecification(ctx sdk.Context, recordSpecID types.MetadataAddress) (spec types.RecordSpecification, found bool)

GetRecordSpecification returns the record spec with the given id.

func (Keeper) GetRecordSpecificationsForContractSpecificationID added in v0.2.0

func (k Keeper) GetRecordSpecificationsForContractSpecificationID(ctx sdk.Context, contractSpecID types.MetadataAddress) ([]*types.RecordSpecification, error)

GetRecordSpecificationsForContractSpecificationID returns all the record specifications associated with given contractSpecID

func (Keeper) GetRecords added in v0.1.5

func (k Keeper) GetRecords(ctx sdk.Context, scopeAddress types.MetadataAddress, name string) ([]*types.Record, error)

GetRecords returns records with scopeAddress and name

func (Keeper) GetScope

func (k Keeper) GetScope(ctx sdk.Context, id types.MetadataAddress) (scope types.Scope, found bool)

GetScope returns the scope with the given id.

func (Keeper) GetScopeSpecification

func (k Keeper) GetScopeSpecification(ctx sdk.Context, scopeSpecID types.MetadataAddress) (spec types.ScopeSpecification, found bool)

GetScopeSpecification returns the record with the given id.

func (Keeper) GetSession added in v0.2.0

func (k Keeper) GetSession(ctx sdk.Context, id types.MetadataAddress) (session types.Session, found bool)

GetSession returns the scope with the given id.

func (Keeper) HasSignerWithMarkerValueAuthority

func (k Keeper) HasSignerWithMarkerValueAuthority(ctx sdk.Context, valueOwner string, signers []string, role markertypes.Access) bool

HasSignerWithMarkerValueAuthority checks the list of signers for any that have the requested role.

func (Keeper) InitGenesis

func (k Keeper) InitGenesis(ctx sdk.Context, data *types.GenesisState)

InitGenesis creates the initial genesis state for the metadata module.

func (Keeper) IterateContractSpecs added in v0.1.5

func (k Keeper) IterateContractSpecs(ctx sdk.Context, handler func(specification types.ContractSpecification) (stop bool)) error

IterateContractSpecs processes all contract specs using a given handler.

func (Keeper) IterateContractSpecsForOwner added in v0.1.5

func (k Keeper) IterateContractSpecsForOwner(ctx sdk.Context, ownerAddress sdk.AccAddress, handler func(contractSpecID types.MetadataAddress) (stop bool)) error

IterateContractSpecsForOwner processes all contract specs owned by an address using a given handler.

func (Keeper) IterateRecordSpecs added in v0.2.0

func (k Keeper) IterateRecordSpecs(ctx sdk.Context, handler func(specification types.RecordSpecification) (stop bool)) error

IterateRecordSpecs processes all record specs using a given handler.

func (Keeper) IterateRecordSpecsForContractSpec added in v0.2.0

func (k Keeper) IterateRecordSpecsForContractSpec(ctx sdk.Context, contractSpecID types.MetadataAddress, handler func(recordSpecID types.MetadataAddress) (stop bool)) error

IterateRecordSpecsForContractSpec processes all record specs for a contract spec using a given handler.

func (Keeper) IterateRecordSpecsForOwner added in v0.2.0

func (k Keeper) IterateRecordSpecsForOwner(ctx sdk.Context, ownerAddress sdk.AccAddress, handler func(recordSpecID types.MetadataAddress) (stop bool)) error

IterateRecordSpecsForOwner processes all record specs owned by an address using a given handler.

func (Keeper) IterateRecords

func (k Keeper) IterateRecords(ctx sdk.Context, scopeID types.MetadataAddress, handler func(types.Record) (stop bool)) error

IterateRecords processes all records in a scope with the given handler.

func (Keeper) IterateScopeSpecs added in v0.1.5

func (k Keeper) IterateScopeSpecs(ctx sdk.Context, handler func(specification types.ScopeSpecification) (stop bool)) error

IterateScopeSpecs processes all scope specs using a given handler.

func (Keeper) IterateScopeSpecsForContractSpec added in v0.1.5

func (k Keeper) IterateScopeSpecsForContractSpec(ctx sdk.Context, contractSpecID types.MetadataAddress, handler func(scopeSpecID types.MetadataAddress) (stop bool)) error

IterateScopeSpecsForContractSpec processes all scope specs associated with a contract spec id using a given handler.

func (Keeper) IterateScopeSpecsForOwner added in v0.1.5

func (k Keeper) IterateScopeSpecsForOwner(ctx sdk.Context, ownerAddress sdk.AccAddress, handler func(scopeSpecID types.MetadataAddress) (stop bool)) error

IterateScopeSpecsForOwner processes all scope specs owned by an address using a given handler.

func (Keeper) IterateScopes

func (k Keeper) IterateScopes(ctx sdk.Context, handler func(types.Scope) (stop bool)) error

IterateScopes processes all stored scopes with the given handler.

func (Keeper) IterateScopesForAddress

func (k Keeper) IterateScopesForAddress(ctx sdk.Context, address sdk.AccAddress, handler func(scopeID types.MetadataAddress) (stop bool)) error

IterateScopesForAddress processes scopes associated with the provided address with the given handler.

func (Keeper) IterateScopesForScopeSpec

func (k Keeper) IterateScopesForScopeSpec(ctx sdk.Context, scopeSpecID types.MetadataAddress,
	handler func(scopeID types.MetadataAddress) (stop bool),
) error

IterateScopesForScopeSpec processes scopes associated with the provided scope specification id with the given handler.

func (Keeper) IterateSessions added in v0.2.0

func (k Keeper) IterateSessions(ctx sdk.Context, scopeID types.MetadataAddress, handler func(types.Session) (stop bool)) error

IterateSessions processes all stored scopes with the given handler.

func (Keeper) Logger

func (k Keeper) Logger(ctx sdk.Context) log.Logger

Logger returns a module-specific logger.

func (Keeper) Ownership

Ownership returns a list of scope identifiers that list the given address as a data or value owner

func (Keeper) Params

Params queries params of metadata module

func (Keeper) RecordSpecification added in v0.2.0

RecordSpecification returns a specific record specification by contract spec id and name

func (Keeper) RecordSpecificationsForContractSpecification added in v0.2.0

RecordSpecificationsForContractSpecification returns the record specifications associated with a contract specification

func (Keeper) RecordsByScopeID added in v0.1.5

RecordsByScopeID returns a collection of the records in a scope or a specific one by name

func (Keeper) RecordsByScopeUUID added in v0.1.5

RecordsByScopeUUID returns a collection of the records in a scope or a specific one by name

func (Keeper) RemoveContractSpecification added in v0.1.5

func (k Keeper) RemoveContractSpecification(ctx sdk.Context, contractSpecID types.MetadataAddress) error

RemoveContractSpecification removes a contract specification from the module kv store.

func (Keeper) RemoveRecord

func (k Keeper) RemoveRecord(ctx sdk.Context, id types.MetadataAddress)

RemoveRecord removes a scope from the module kv store.

func (Keeper) RemoveRecordSpecification added in v0.2.0

func (k Keeper) RemoveRecordSpecification(ctx sdk.Context, recordSpecID types.MetadataAddress) error

RemoveRecordSpecification removes a record specification from the module kv store.

func (Keeper) RemoveScope added in v0.1.5

func (k Keeper) RemoveScope(ctx sdk.Context, id types.MetadataAddress)

RemoveScope removes a scope from the module kv store.

func (Keeper) RemoveScopeSpecification added in v0.1.5

func (k Keeper) RemoveScopeSpecification(ctx sdk.Context, scopeSpecID types.MetadataAddress) error

RemoveScopeSpecification removes a scope specification from the module kv store.

func (Keeper) RemoveSession added in v0.2.0

func (k Keeper) RemoveSession(ctx sdk.Context, id types.MetadataAddress)

RemoveSession removes a scope from the module kv store.

func (Keeper) Scope

Scope returns a specific scope by id

func (Keeper) ScopeSpecification added in v0.1.5

ScopeSpecification returns a specific scope specification by id

func (Keeper) SessionContextByID added in v0.2.0

SessionContextByID returns a specific session context within a scope (or all groups)

func (Keeper) SessionContextByUUID added in v0.2.0

SessionContextByUUID returns a specific group context within a scope (or all groups)

func (Keeper) SetContractSpecification added in v0.1.5

func (k Keeper) SetContractSpecification(ctx sdk.Context, spec types.ContractSpecification)

SetContractSpecification stores a contract specification in the module kv store.

func (Keeper) SetParams

func (k Keeper) SetParams(ctx sdk.Context, params types.Params)

SetParams sets the metadata parameters to the param space.

func (Keeper) SetRecord

func (k Keeper) SetRecord(ctx sdk.Context, record types.Record)

SetRecord stores a record in the module kv store.

func (Keeper) SetRecordSpecification added in v0.2.0

func (k Keeper) SetRecordSpecification(ctx sdk.Context, spec types.RecordSpecification)

SetRecordSpecification stores a record specification in the module kv store.

func (Keeper) SetScope

func (k Keeper) SetScope(ctx sdk.Context, scope types.Scope)

SetScope stores a scope in the module kv store.

func (Keeper) SetScopeSpecification

func (k Keeper) SetScopeSpecification(ctx sdk.Context, spec types.ScopeSpecification)

SetScopeSpecification stores a scope specification in the module kv store.

func (Keeper) SetSession added in v0.2.0

func (k Keeper) SetSession(ctx sdk.Context, session types.Session)

SetSession stores a session in the module kv store.

func (Keeper) ValidateAllOwnersAreSigners added in v0.1.5

func (k Keeper) ValidateAllOwnersAreSigners(existingOwners []string, signers []string) error

ValidateAllOwnersAreSigners makes sure that all entries in the existingOwners list are contained in the signers list.

func (Keeper) ValidateContractSpecUpdate added in v0.1.5

func (k Keeper) ValidateContractSpecUpdate(ctx sdk.Context, existing *types.ContractSpecification, proposed types.ContractSpecification) error

ValidateContractSpecUpdate full validation of a proposed contract spec possibly against an existing one.

func (Keeper) ValidatePartiesInvolved added in v0.2.0

func (k Keeper) ValidatePartiesInvolved(parties []types.Party, requiredParties []types.PartyType) error

ValidatePartiesInvolved validate that all required parties are involved

func (Keeper) ValidateRawSignature

func (k Keeper) ValidateRawSignature(signature signing.SignatureDescriptor, message []byte) (addr sdk.AccAddress, err error)

ValidateRawSignature takes a given message and verifies the signature instance is valid for it directly without calculating a signing structure to wrap it. ValidateRawSignature returns the address of the user who created the signature and any encountered errors.

func (Keeper) ValidateRecordRemove added in v0.2.0

func (k Keeper) ValidateRecordRemove(ctx sdk.Context, existing types.Record, proposedID types.MetadataAddress, signers []string) error

ValidateRecordRemove checks the current record and the proposed removal scope to determine if the the proposed remove is valid based on the existing state

func (Keeper) ValidateRecordSpecUpdate added in v0.2.0

func (k Keeper) ValidateRecordSpecUpdate(ctx sdk.Context, existing *types.RecordSpecification, proposed types.RecordSpecification) error

ValidateRecordSpecUpdate full validation of a proposed record spec possibly against an existing one.

func (Keeper) ValidateRecordUpdate added in v0.1.5

func (k Keeper) ValidateRecordUpdate(ctx sdk.Context, existing, proposed types.Record, signers []string) error

ValidateRecordUpdate checks the current record and the proposed record to determine if the the proposed changes are valid based on the existing state

func (Keeper) ValidateRequiredSignatures added in v0.2.0

func (k Keeper) ValidateRequiredSignatures(owners []types.Party, signers []string) error

ValidateRequiredSignatures validate all owners are signers

func (Keeper) ValidateScopeRemove

func (k Keeper) ValidateScopeRemove(ctx sdk.Context, existing, proposed types.Scope, signers []string) error

ValidateScopeRemove checks the current scope and the proposed removal scope to determine if the the proposed remove is valid based on the existing state

func (Keeper) ValidateScopeSpecUpdate added in v0.1.5

func (k Keeper) ValidateScopeSpecUpdate(ctx sdk.Context, existing *types.ScopeSpecification, proposed types.ScopeSpecification) error

ValidateScopeSpecUpdate - full validation of a scope specification.

func (Keeper) ValidateScopeUpdate

func (k Keeper) ValidateScopeUpdate(ctx sdk.Context, existing, proposed types.Scope, signers []string) error

ValidateScopeUpdate checks the current scope and the proposed scope to determine if the the proposed changes are valid based on the existing state

func (Keeper) ValidateSessionUpdate added in v0.2.0

func (k Keeper) ValidateSessionUpdate(ctx sdk.Context, existing, proposed types.Session, signers []string) error

ValidateSessionUpdate checks the current session and the proposed session to determine if the the proposed changes are valid based on the existing state

func (Keeper) ValueOwnership

ValueOwnership returns a list of scope identifiers that list the given address as a value owner

type MetadataKeeperI

type MetadataKeeperI interface {
	// GetScope returns the scope with the given address.
	GetScope(sdk.Context, types.MetadataAddress) (types.Scope, bool)
	// SetScope persists the provided scope
	SetScope(sdk.Context, types.Scope)
	// RemoveScope removes the provided scope
	RemoveScope(sdk.Context, types.MetadataAddress)

	// IterateScopes processes all stored scopes with the given handler.
	IterateScopes(sdk.Context, func(types.Scope) bool) error

	// GetSession returns the scope with the given address.
	GetSession(sdk.Context, types.MetadataAddress) (types.Session, bool)
	// SetSession persists the provided scope
	SetSession(sdk.Context, types.Session)
	// RemoveSession persists the provided scope
	RemoveSession(sdk.Context, types.MetadataAddress)

	// GetRecord returns the record with the given address.
	GetRecord(sdk.Context, types.MetadataAddress) (types.Record, bool)
	// GetRecords returns records with giving scope and/or name
	GetRecords(sdk.Context, types.MetadataAddress, string) ([]*types.Record, error)
	// SetRecord persists the provided record
	SetRecord(sdk.Context, types.Record)
	// RemoveRecord persists the provided scope
	RemoveRecord(sdk.Context, types.MetadataAddress)

	// IterateRecords processes all stored record for a scope with the given handler.
	IterateRecords(sdk.Context, types.MetadataAddress, func(types.Record) bool) error

	// GetScopeSpecification returns the record with the given address.
	GetScopeSpecification(sdk.Context, types.MetadataAddress) (types.ScopeSpecification, bool)
	// SetScopeSpecification persists the provided scope specification
	SetScopeSpecification(sdk.Context, types.ScopeSpecification)
	// RemoveScopeSpecification removes a scope specification from the module kv store.
	RemoveScopeSpecification(sdk.Context, types.MetadataAddress) error

	// IterateScopeSpecs processes all scope specs using a given handler.
	IterateScopeSpecs(ctx sdk.Context, handler func(specification types.ScopeSpecification) (stop bool)) error
	// IterateScopeSpecsForOwner processes all scope specs owned by an address using a given handler.
	IterateScopeSpecsForOwner(ctx sdk.Context, ownerAddress sdk.AccAddress, handler func(scopeSpecID types.MetadataAddress) (stop bool)) error
	// IterateScopeSpecsForContractSpec processes all scope specs associated with a contract spec id using a given handler.
	IterateScopeSpecsForContractSpec(ctx sdk.Context, contractSpecID types.MetadataAddress, handler func(scopeSpecID types.MetadataAddress) (stop bool)) error

	// GetContractSpecification returns the contract specification with the given address.
	GetContractSpecification(sdk.Context, types.MetadataAddress) (types.ContractSpecification, bool)
	// SetContractSpecification persists the provided contract specification
	SetContractSpecification(sdk.Context, types.ContractSpecification)
	// RemoveContractSpecification removes a contract specification from the module kv store.
	RemoveContractSpecification(sdk.Context, types.MetadataAddress) error

	// IterateContractSpecs processes all contract specs using the given handler.
	IterateContractSpecs(ctx sdk.Context, handler func(specification types.ContractSpecification) (stop bool)) error
	// IterateContractSpecsForOwner processes all contract specs owned by an address using a given handler.
	IterateContractSpecsForOwner(ctx sdk.Context, ownerAddress sdk.AccAddress, handler func(contractSpecID types.MetadataAddress) (stop bool)) error

	// GetRecordSpecification returns the record specification with the given address.
	GetRecordSpecification(sdk.Context, types.MetadataAddress) (types.RecordSpecification, bool)
	// SetRecordSpecification persists the provided record specification
	SetRecordSpecification(sdk.Context, types.RecordSpecification)
	// RemoveRecordSpecification removes a record specification from the module kv store.
	RemoveRecordSpecification(sdk.Context, types.MetadataAddress) error

	// IterateRecordSpecs processes all record specs using a given handler.
	IterateRecordSpecs(ctx sdk.Context, handler func(specification types.RecordSpecification) (stop bool)) error
	// IterateRecordSpecsForOwner processes all record specs owned by an address using a given handler.
	IterateRecordSpecsForOwner(ctx sdk.Context, ownerAddress sdk.AccAddress, handler func(recordSpecID types.MetadataAddress) (stop bool)) error
	// IterateRecordSpecsForContractSpec processes all record specs for a contract spec using a given handler.
	IterateRecordSpecsForContractSpec(ctx sdk.Context, contractSpecID types.MetadataAddress, handler func(recordSpecID types.MetadataAddress) (stop bool)) error
	// GetRecordSpecificationsForContractSpecificationID returns all the record specifications associated with given contractSpecID
	GetRecordSpecificationsForContractSpecificationID(ctx sdk.Context, contractSpecID types.MetadataAddress) ([]*types.RecordSpecification, error)
}

MetadataKeeperI is the internal state api for the metadata module.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL