keeper

package
v1.5.0 Latest Latest
Warning

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

Go to latest
Published: Feb 21, 2020 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var TestingDocument = types.Document{
	UUID:       "test-document-uuid",
	ContentURI: "https://example.com/document",
	Metadata: types.DocumentMetadata{
		ContentURI: "https://example.com/document/metadata",
		Schema: &types.DocumentMetadataSchema{
			URI:     "https://example.com/document/metadata/schema",
			Version: "1.0.0",
		},
	},
	Checksum: &types.DocumentChecksum{
		Value:     "93dfcaf3d923ec47edb8580667473987",
		Algorithm: "md5",
	},
	Sender:     TestingSender,
	Recipients: ctypes.Addresses{TestingRecipient},
}
View Source
var TestingDocumentReceipt = types.DocumentReceipt{
	UUID:         "testing-document-receipt-uuid",
	Sender:       TestingSender,
	Recipient:    TestingRecipient,
	TxHash:       "txHash",
	DocumentUUID: "6a2f41a3-c54c-fce8-32d2-0324e1c32e22",
	Proof:        "proof",
}
View Source
var TestingRecipient, _ = sdk.AccAddressFromBech32("cosmos1tupew4x3rhh0lpqha9wvzmzxjr4e37mfy3qefm")
View Source
var TestingSender, _ = sdk.AccAddressFromBech32("cosmos1lwmppctrr6ssnrmuyzu554dzf50apkfvd53jx0")
View Source
var TestingSender2, _ = sdk.AccAddressFromBech32("cosmos1nynns8ex9fq6sjjfj8k79ymkdz4sqth06xexae")

Functions

func DocsReceiptsInvariants added in v1.4.0

func DocsReceiptsInvariants(k Keeper) sdk.Invariant

DocsReceiptsInvariants checks that every receipt points to an existing Document.

func DocsSchemasValidInvariant added in v1.4.0

func DocsSchemasValidInvariant(k Keeper) sdk.Invariant

DocsSchemasValidInvariant checks that every Document SchemaType is a supported one.

func NewHandler added in v1.3.2

func NewHandler(keeper Keeper) sdk.Handler

NewHandler is essentially a sub-router that directs messages coming into this module to the proper handler.

func NewQuerier

func NewQuerier(keeper Keeper) sdk.Querier

NewQuerier is the module level router for state queries

func RegisterInvariants added in v1.4.0

func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper)

Types

type Keeper

type Keeper struct {
	StoreKey sdk.StoreKey

	GovernmentKeeper government.Keeper
	// contains filtered or unexported fields
}

func NewKeeper

func NewKeeper(storeKey sdk.StoreKey, gKeeper government.Keeper, cdc *codec.Codec) Keeper

func SetupTestInput

func SetupTestInput() (cdc *codec.Codec, ctx sdk.Context, keeper Keeper)

This function create an environment to test modules

func (Keeper) AddSupportedMetadataScheme

func (keeper Keeper) AddSupportedMetadataScheme(ctx sdk.Context, metadataSchema types.MetadataSchema)

AddSupportedMetadataScheme allows to add or update the given metadata scheme definition as a supported metadata scheme that will be accepted into document sending transactions

func (Keeper) AddTrustedSchemaProposer

func (keeper Keeper) AddTrustedSchemaProposer(ctx sdk.Context, proposer sdk.AccAddress)

AddTrustedSchemaProposer adds the given proposer to the list of trusted addresses that can propose new metadata schemes as officially recognized

func (Keeper) DocumentsIterator added in v1.4.0

func (keeper Keeper) DocumentsIterator(ctx sdk.Context) sdk.Iterator

DocumentsIterator returns an Iterator for all the Documents saved in the store.

func (Keeper) ExtractDocument added in v1.4.0

func (keeper Keeper) ExtractDocument(ctx sdk.Context, keyVal []byte) (types.Document, string, error)

ExtractDocument returns a Document slice instance and its UUID given an iterator byte stream value.

func (Keeper) ExtractMetadataSchema added in v1.4.0

func (keeper Keeper) ExtractMetadataSchema(iterVal []byte) types.MetadataSchema

ExtractMetadataSchema returns a MetadataSchema slice instance and given an iterator byte stream value.

func (Keeper) ExtractReceipt added in v1.4.0

func (keeper Keeper) ExtractReceipt(ctx sdk.Context, iterVal []byte) (types.DocumentReceipt, string, error)

ExtractReceipt returns a DocumentReceipt slice instance and its UUID given an iterator byte stream value.

func (Keeper) ExtractTrustedSchemaProposer added in v1.4.0

func (keeper Keeper) ExtractTrustedSchemaProposer(iterVal []byte) sdk.AccAddress

ExtractTrustedSchemaProposer returns a sdk.AccAddress slice instance given an iterator byte stream value.

func (Keeper) GetDocumentByID added in v1.3.2

func (keeper Keeper) GetDocumentByID(ctx sdk.Context, id string) (types.Document, error)

GetDocumentByID returns the document having the given id, or false if no document has been found

func (Keeper) GetReceiptByID added in v1.3.2

func (keeper Keeper) GetReceiptByID(ctx sdk.Context, id string) (types.DocumentReceipt, error)

GetReceiptByID returns the document receipt having the given id, or false if such receipt could not be found

func (Keeper) IsMetadataSchemeTypeSupported

func (keeper Keeper) IsMetadataSchemeTypeSupported(ctx sdk.Context, metadataSchemaType string) bool

IsMetadataSchemeTypeSupported returns true iff the given metadata scheme type is supported as an official one

func (Keeper) IsTrustedSchemaProposer

func (keeper Keeper) IsTrustedSchemaProposer(ctx sdk.Context, proposer sdk.AccAddress) bool

IsTrustedSchemaProposer returns true iff the given proposer is a trusted one

func (Keeper) ReceiptsIterators added in v1.4.0

func (keeper Keeper) ReceiptsIterators(ctx sdk.Context) (sdk.Iterator, sdk.Iterator)

ReceiptsIterator returns an Iterator for Sent and Received receipts.

func (Keeper) SaveDocument added in v1.3.0

func (keeper Keeper) SaveDocument(ctx sdk.Context, document types.Document) sdk.Error

SaveDocument allows the sharing of a document

func (Keeper) SaveReceipt added in v1.3.0

func (keeper Keeper) SaveReceipt(ctx sdk.Context, receipt types.DocumentReceipt) sdk.Error

SaveReceipt allows to properly store the given receipt

func (Keeper) SupportedMetadataSchemesIterator added in v1.4.0

func (keeper Keeper) SupportedMetadataSchemesIterator(ctx sdk.Context) sdk.Iterator

SupportedMetadataSchemesIterator returns an Iterators for all the Supported Metadata Schemes.

func (Keeper) TrustedSchemaProposersIterator added in v1.4.0

func (keeper Keeper) TrustedSchemaProposersIterator(ctx sdk.Context) sdk.Iterator

TrustedSchemaProposersIterator returns an Iterator for all the Trusted Schema Proposers.

func (Keeper) UserReceivedDocumentsIterator added in v1.4.0

func (keeper Keeper) UserReceivedDocumentsIterator(ctx sdk.Context, user sdk.AccAddress) sdk.Iterator

UserReceivedDocumentsIterator returns an Iterator for all the received Documents of a user.

func (Keeper) UserReceivedReceiptsIterator added in v1.4.0

func (keeper Keeper) UserReceivedReceiptsIterator(ctx sdk.Context, user sdk.AccAddress) sdk.Iterator

UserReceivedReceiptsIterator returns an Iterator for all the Document Received Receipts for a user.

func (Keeper) UserSentDocumentsIterator added in v1.4.0

func (keeper Keeper) UserSentDocumentsIterator(ctx sdk.Context, user sdk.AccAddress) sdk.Iterator

UserSentDocumentsIterator returns an Iterator for all the sent Documents of a user.

func (Keeper) UserSentReceiptsIterator added in v1.4.0

func (keeper Keeper) UserSentReceiptsIterator(ctx sdk.Context, user sdk.AccAddress) sdk.Iterator

UserSentReceiptsIterator returns an Iterator for all the Document Sent Receipts for a user.

Jump to

Keyboard shortcuts

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