documents

Documentation

Index

• func RegisterCodec(codec *codec.Codec)
• type Asset
• type Classification
• type Document
• type Identity
• type Maintainer
• type Order

Functions

func RegisterCodec

func RegisterCodec(codec *codec.Codec)

Types

type Asset

type Asset interface {
	capabilities.Burnable
	capabilities.Lockable
	capabilities.Splittable

	Document
}

type Classification

type Classification interface {
	Document
}

type Document

type Document interface {
	GenerateHashID() ids.HashID
	GetClassificationID() ids.ClassificationID
	// GetProperty returns property from a document searching in both Mutables and Immutables
	// * Returns nil if property is not found
	GetProperty(ids.PropertyID) properties.Property
	GetImmutables() qualified.Immutables
	GetMutables() qualified.Mutables

	Mutate(...properties.Property) Document
}

type Identity

type Identity interface {

	// TODO removal for expired identity
	// GetExpiry returns the expiry property of an Identity
	// * If the property is not found, it returns a default value and not nil
	GetExpiry() types.Height

	// GetAuthentication returns the authentication property of an Identity
	// * If the property is not found, it returns a default value and not nil
	GetAuthentication() lists.DataList

	IsProvisioned(sdkTypes.AccAddress) bool
	ProvisionAddress(...sdkTypes.AccAddress) Identity
	UnprovisionAddress(...sdkTypes.AccAddress) Identity

	Document
}

type Maintainer

type Maintainer interface {
	GetIdentityID() ids.IdentityID
	GetMaintainedClassificationID() ids.ClassificationID
	GetMaintainedProperties() data.ListData
	GetPermissions() data.ListData

	CanMintAsset() bool
	CanBurnAsset() bool
	CanRenumerateAsset() bool
	CanAddMaintainer() bool
	CanRemoveMaintainer() bool
	CanMutateMaintainer() bool
	MaintainsProperty(ids.PropertyID) bool

	Document
}

type Order

type Order interface {
	GetExchangeRate() sdkTypes.Dec
	GetCreationHeight() types.Height
	GetMakerOwnableID() ids.OwnableID
	GetTakerOwnableID() ids.OwnableID
	GetMakerID() ids.IdentityID
	GetTakerID() ids.IdentityID
	GetExpiryHeight() types.Height
	GetMakerOwnableSplit() sdkTypes.Dec

	Document
}