documents

Documentation

Index

• func RegisterLegacyAminoCodec(legacyAmino *codec.LegacyAmino)
• type Asset
• type Classification
• type CoinAsset
• type Document
• type Identity
• type Maintainer
• type ModuleIdentity
• type NameIdentity
• type Order
• type PutOrder

Functions

func RegisterLegacyAminoCodec

func RegisterLegacyAminoCodec(legacyAmino *codec.LegacyAmino)

Types

type Asset

type Asset interface {
	ValidateAsset() error
	GetBurnHeight() types.Height
	GetLockHeight() types.Height
	GetSupply() sdkTypes.Int
	Document
}

type Classification

type Classification interface {
	GetBondAmount() sdkTypes.Int
	Document
}

type CoinAsset

type CoinAsset interface {
	Asset
	ValidateCoinAsset() error
	GetDenom() string
	GetCoinAssetID() ids.AssetID
}

type Document

type Document interface {
	Get() Document
	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.AnyProperty
	GetImmutables() qualified.Immutables
	GetMutables() qualified.Mutables

	ValidateBasic() error
	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() data.ListData

	IsProvisioned(sdkTypes.AccAddress) bool
	GetProvisionedAddressCount() sdkTypes.Int
	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

	IsPermitted(permissionID ids.StringID) bool
	MaintainsProperty(ids.PropertyID) bool

	Document
}

type ModuleIdentity

type ModuleIdentity interface {
	Identity
	GetModuleName() string
	GetModuleIdentityID() ids.IdentityID
}

type NameIdentity

type NameIdentity interface {
	Identity
	GetName() string
	GetNameIdentityID() ids.IdentityID
}

type Order

type Order interface {
	GetMakerID() ids.IdentityID
	GetMakerAssetID() ids.AssetID
	GetTakerAssetID() ids.AssetID
	GetMakerSplit() sdkTypes.Int
	GetTakerSplit() sdkTypes.Int
	GetExpiryHeight() types.Height

	GetTakerID() ids.IdentityID
	GetExchangeRate() sdkTypes.Dec
	GetExecutionHeight() types.Height

	Document
}

type PutOrder

type PutOrder interface {
	Order
	GetPutOrderID() ids.OrderID
}