Documentation ¶
Index ¶
- Constants
- Variables
- func RegisterCodec(cdc *codec.Codec)
- func ValidateDomainType(typ DomainType) error
- type Account
- type BlockchainAddress
- type Certificate
- type Domain
- type DomainType
- type MsgAddAccountCertificates
- type MsgDeleteAccount
- type MsgDeleteAccountCertificate
- type MsgDeleteDomain
- type MsgRegisterAccount
- type MsgRegisterDomain
- type MsgRenewAccount
- type MsgRenewDomain
- type MsgReplaceAccountMetadata
- type MsgReplaceAccountTargets
- type MsgTransferAccount
- type MsgTransferDomain
- type TransferFlag
Constants ¶
const ( // TransferFlush clears all domain account data, except empty account) TransferFlush = iota // TransferOwned transfers only accounts owned by the current owner TransferOwned // ResetNone leaves things as they are except for empty account ResetNone // TransferAll is not available is here only for tests backwards compatibility and will be removed. TODO deprecate TransferAll )
const ( // ModuleName is the name of the module ModuleName = "domain" // DomainStore key defines the store key used to store domains information DomainStoreKey = "domain" // AccountStoreKey defines the store key used to store account information AccountStoreKey = "account" // IndexStoreKey defines the store key used to store indexing information IndexStoreKey = ModuleName + "index" // RouterKey defines the path used to interact with the domain module RouterKey = ModuleName // QuerierRoute defines the query path used to interact with the domain module QuerierRoute = ModuleName // DefaultParamSpace defines the key for the default param space DefaultParamSpace = ModuleName )
Module names
const EmptyAccountName = ""
EmptyAccountName defines the empty account identifier in an IOV domain
const MaxValidUntil int64 = 4746278435
MaxValidUntil defines the unix timestamp defined in seconds of the default ValidUntil of empty accounts in open domains. refers to date -> Monday 27 May 2120 18:40:35
Variables ¶
var ErrAccountDoesNotExist = sdkerrors.Register(ModuleName, 6, "account does not exist")
ErrAccountDoesNotExist is returned when an action is performed on a domain that does not contain the specified account
var ErrAccountExists = sdkerrors.Register(ModuleName, 13, "account already exists")
ErrAccountExists is returned when a create action is done on an account that already exists
var ErrAccountExpired = sdkerrors.Register(ModuleName, 7, "account has expired")
ErrAccountExpired is returned when actions are performed on expired accounts
var ErrAccountGracePeriodNotFinished = sdkerrors.Register(ModuleName, 21, "account grace period has not finished")
ErrAccountGracePeriodNotFinished is returned when actions are performed on not expired domains
var ErrBlockchainTargetLimitExceeded = sdkerrors.Register(ModuleName, 22, "blockchain target limit exceeded")
ErrBlockchainTargetLimit exceeded is returned when blockchain target limit is exceeded
var ErrCertificateDoesNotExist = sdkerrors.Register(ModuleName, 16, "certificate does not exist")
ErrCertificateDoesNotExist is returned when an action is performed on a domain that already exists
var ErrCertificateExists = sdkerrors.Register(ModuleName, 15, "certificate already exists")
ErrCertificateExists is returned when a creation action is done on a certificate that already exists
var ErrCertificateLimitReached = sdkerrors.Register(ModuleName, 24, "certificate limit reached")
ErrCertificateLimitReached is returned when certificate limit is exceeded
var ErrCertificateSizeExceeded = sdkerrors.Register(ModuleName, 23, "certificate size exceeded")
ErrCertificateSizeExceeded is returned when certificate size exceeded
var ErrClosedDomainAccExpire = sdkerrors.Register(ModuleName, 26, "accounts in closed domains do not expire")
ErrClosedDomainAccExpire is returned when expiration related operation trying to be run on closed domain
var ErrDomainAlreadyExists = sdkerrors.Register(ModuleName, 2, "domain already exists")
ErrDomainAlreadyExists is returned when a create action is done on a domain that already exists
var ErrDomainDoesNotExist = sdkerrors.Register(ModuleName, 5, "domain does not exist")
ErrDomainDoesNotExist is returned when an action is performed on a domain that does not exist
var ErrDomainExpired = sdkerrors.Register(ModuleName, 11, "domain has expired")
ErrDomainExpired is returned when actions are performed on expired domains
var ErrDomainGracePeriodNotFinished = sdkerrors.Register(ModuleName, 17, "domain grace period has not finished")
ErrDomainGracePeriodNotFinished is returned when actions are performed on expired domains
var ErrDomainNotExpired = sdkerrors.Register(ModuleName, 12, "domain has not expired")
ErrDomainExpired is returned when actions are performed on not expired domains
var ErrInvalidAccountName = sdkerrors.Register(ModuleName, 9, "invalid account name")
ErrInvalidAccountName is returned when the account name does not match the required standards
var ErrInvalidBlockchainTarget = sdkerrors.Register(ModuleName, 10, "blockchain target provided is not valid")
ErrInvalidBlockchainTarget is returned when provided blockchain target is not valid
var ErrInvalidDomainName = sdkerrors.Register(ModuleName, 1, "domain name provided is invalid")
ErrInvalidDomainName is returned when the domain name does not match the required standards
var ErrInvalidDomainType = sdkerrors.Register(ModuleName, 18, "invalid domain type")
ErrInvalidDomainType is returned when domain type is invalid
var ErrInvalidOwner = sdkerrors.Register(ModuleName, 8, "invalid owner")
ErrInvalidOwner is returned when the owner address provided is not valid (empty, malformed, etc)
var ErrInvalidRegisterer = sdkerrors.Register(ModuleName, 19, "invalid registerer")
ErrInvalidRegisterer is returned when the registerer address provided is not valid (empty, malformed, etc)
var ErrInvalidRequest = sdkerrors.Register(ModuleName, 14, "malformed request")
ErrInvalidRequest is a general error that covers the uncommon cases of invalid request
var ErrMaxRenewExceeded = sdkerrors.Register(ModuleName, 27, "max renew exceeded")
ErrMaxRenewExceeded is returned when max renew time exceeded
var ErrMetadataSizeExceeded = sdkerrors.Register(ModuleName, 25, "metadata size exceeded")
ErrMetadataSizeExceeded is returned when metadata size exceeded
var ErrOpEmptyAcc = sdkerrors.Register(ModuleName, 20, "account name provided cannot be empty")
ErrOpEmptyAcc is returned when an operation tried to be run on empty account
ErrUnauthorized is returned when authentication process for an action fails
var ModuleCdc = codec.New()
ModuleCdc instantiates a new codec for the domain module
Functions ¶
func RegisterCodec ¶
RegisterCodec registers the sdk.Msg for the module
func ValidateDomainType ¶ added in v0.3.0
func ValidateDomainType(typ DomainType) error
Types ¶
type Account ¶
type Account struct { // Domain references the domain this account belongs to Domain string `json:"domain"` // Name is the name of the account Name string `json:"name"` // Owner is the address that owns the account Owner sdk.AccAddress `json:"owner"` // ValidUntil defines a unix timestamp of the expiration of the account ValidUntil int64 `json:"valid_until"` // Targets is the list of blockchain addresses this account belongs to Targets []BlockchainAddress `json:"targets"` // Certificates contains the list of certificates to identify the account owner Certificates []Certificate `json:"certificates"` // Broker can be empty // it identifies an entity that facilitated the transaction of the account Broker sdk.AccAddress `json:"broker"` // MetadataURI contains a link to extra information regarding the account MetadataURI string `json:"metadata_uri"` }
Account defines an account that belongs to a domain
type BlockchainAddress ¶ added in v0.2.3
type BlockchainAddress struct { // ID defines a blockchain ID ID string `json:"id"` // Address is the blockchain address Address string `json:"address"` }
BlockchainAddress defines an address coming from different DLTs
func (BlockchainAddress) Index ¶ added in v0.2.3
func (b BlockchainAddress) Index() ([]byte, error)
Index implements Indexer and packs the blockchain address into an index key using its blockchain ID and address
type Domain ¶
type Domain struct { // Name is the name of the domain Name string `json:"name"` // Owner is the owner of the domain Admin sdk.AccAddress `json:"admin"` // ValidUntil is a unix timestamp defines the time when the domain will become invalid ValidUntil int64 `json:"valid_until"` // Type defines the type of the domain Type DomainType `json:"type"` // AccountRenew defines the duration of each created or renewed account // under the domain AccountRenew time.Duration `json:"account_renew"` // Broker TODO needs comment Broker sdk.AccAddress `json:"broker"` }
Domain defines a domain
func (Domain) Index ¶ added in v0.2.3
Index implements Indexer and packs the domain into an index key using its name
type DomainType ¶ added in v0.3.0
type DomainType string
const ( OpenDomain DomainType = "open" ClosedDomain = "closed" )
type MsgAddAccountCertificates ¶
type MsgAddAccountCertificates struct { // Domain is the domain of the account Domain string // Name is the name of the account Name string // Owner is the owner of the account Owner sdk.AccAddress // NewCertificate is the new certificate to add NewCertificate []byte }
MsgAddAccountCertificates is the message used when a user wants to add new certificates to his account
func (*MsgAddAccountCertificates) GetSignBytes ¶
func (m *MsgAddAccountCertificates) GetSignBytes() []byte
GetSignBytes implements sdk.Msg
func (*MsgAddAccountCertificates) GetSigners ¶
func (m *MsgAddAccountCertificates) GetSigners() []sdk.AccAddress
GetSigners implements sdk.Msg
func (*MsgAddAccountCertificates) Route ¶
func (m *MsgAddAccountCertificates) Route() string
Route implements sdk.Msg
func (*MsgAddAccountCertificates) Type ¶
func (m *MsgAddAccountCertificates) Type() string
Type implements sdk.Msg
func (*MsgAddAccountCertificates) ValidateBasic ¶
func (m *MsgAddAccountCertificates) ValidateBasic() error
ValidateBasic implements sdk.Msg
type MsgDeleteAccount ¶
type MsgDeleteAccount struct { // Domain is the name of the domain of the account Domain string // Name is the name of the account Name string // Owner is the owner of the account Owner sdk.AccAddress }
MsgDeleteAccount is the request model used to delete an account
func (*MsgDeleteAccount) GetSignBytes ¶
func (m *MsgDeleteAccount) GetSignBytes() []byte
GetSignBytes implements sdk.Msg
func (*MsgDeleteAccount) GetSigners ¶
func (m *MsgDeleteAccount) GetSigners() []sdk.AccAddress
GetSigners implements sdk.Msg
func (*MsgDeleteAccount) ValidateBasic ¶
func (m *MsgDeleteAccount) ValidateBasic() error
ValidateBasic implements sdk.Msg
type MsgDeleteAccountCertificate ¶
type MsgDeleteAccountCertificate struct { // Domain is the name of the domain of the account Domain string // Name is the name of the account Name string // DeleteCertificate is the certificate to delete DeleteCertificate []byte // Owner is the owner of the account Owner sdk.AccAddress }
MsgDeleteAccountCertificate is the request model used to remove certificates from an account
func (*MsgDeleteAccountCertificate) GetSignBytes ¶
func (m *MsgDeleteAccountCertificate) GetSignBytes() []byte
GetSignBytes implements sdk.Msg
func (*MsgDeleteAccountCertificate) GetSigners ¶
func (m *MsgDeleteAccountCertificate) GetSigners() []sdk.AccAddress
GetSigners implements sdk.Msg
func (*MsgDeleteAccountCertificate) Route ¶
func (m *MsgDeleteAccountCertificate) Route() string
Route implements sdk.Msg
func (*MsgDeleteAccountCertificate) Type ¶
func (m *MsgDeleteAccountCertificate) Type() string
Type implements sdk.Msg
func (*MsgDeleteAccountCertificate) ValidateBasic ¶
func (m *MsgDeleteAccountCertificate) ValidateBasic() error
ValidateBasic implements sdk.Msg
type MsgDeleteDomain ¶
type MsgDeleteDomain struct { Domain string Owner sdk.AccAddress }
MsgDeleteDomain is the request model to delete a domain
func (*MsgDeleteDomain) GetSignBytes ¶
func (m *MsgDeleteDomain) GetSignBytes() []byte
GetSignBytes implements sdk.Msg
func (*MsgDeleteDomain) GetSigners ¶
func (m *MsgDeleteDomain) GetSigners() []sdk.AccAddress
GetSigners implements sdk.Msg
func (*MsgDeleteDomain) ValidateBasic ¶
func (m *MsgDeleteDomain) ValidateBasic() error
ValidateBasic implements sdk.Msg
type MsgRegisterAccount ¶
type MsgRegisterAccount struct { // Domain is the domain of the account Domain string // Name is the name of the account Name string // Owner is the owner of the account Owner sdk.AccAddress // Registerer is the user who registers this account Registerer sdk.AccAddress // Targets are the blockchain addresses of the account Targets []BlockchainAddress // Broker is the account that facilitated the transaction Broker sdk.AccAddress }
MsgRegisterAccount is the request model used to register new accounts
func (*MsgRegisterAccount) GetSignBytes ¶
func (m *MsgRegisterAccount) GetSignBytes() []byte
GetSignBytes implements sdk.Msg
func (*MsgRegisterAccount) GetSigners ¶
func (m *MsgRegisterAccount) GetSigners() []sdk.AccAddress
GetSigners implements sdk.Msg
func (*MsgRegisterAccount) Route ¶
func (m *MsgRegisterAccount) Route() string
Route implements sdk.Msg
func (*MsgRegisterAccount) Type ¶
func (m *MsgRegisterAccount) Type() string
Type implements sdk.Msg
func (*MsgRegisterAccount) ValidateBasic ¶
func (m *MsgRegisterAccount) ValidateBasic() error
ValidateBasic implements sdk.Msg
type MsgRegisterDomain ¶
type MsgRegisterDomain struct { // Name is the name of the domain we want to register Name string `json:"domain" arg:"--domain" helper:"name of the domain"` // Admin is the address of the newly registered domain Admin sdk.AccAddress `json:"admin"` FeePayer sdk.AccAddress // DomainType defines the type of the domain DomainType DomainType `json:"type"` // Broker TODO document Broker sdk.AccAddress `json:"broker" arg:"--broker" helper:"the broker"` // AccountRenew defines the expiration time in seconds of each newly registered account. AccountRenew time.Duration `json:"account_renew" arg:"--account-renew" helper:"account's renewal time in seconds"` }
MsgRegisterDomain is the request used to register new domains
func (*MsgRegisterDomain) GetSignBytes ¶
func (m *MsgRegisterDomain) GetSignBytes() []byte
GetSignBytes implements sdk.Msg
func (*MsgRegisterDomain) GetSigners ¶
func (m *MsgRegisterDomain) GetSigners() []sdk.AccAddress
GetSigners implements sdk.Msg
func (*MsgRegisterDomain) Route ¶
func (m *MsgRegisterDomain) Route() string
Route implements sdk.Msg
func (*MsgRegisterDomain) ValidateBasic ¶
func (m *MsgRegisterDomain) ValidateBasic() error
ValidateBasic implements sdk.Msg
type MsgRenewAccount ¶
type MsgRenewAccount struct { // Domain is the domain of the account Domain string // Name is the name of the account Name string // Signer is the signer of the request Signer sdk.AccAddress }
MsgRenewAccount is the request model used to renew accounts
func (*MsgRenewAccount) GetSignBytes ¶
func (m *MsgRenewAccount) GetSignBytes() []byte
GetSignBytes implements sdk.Msg
func (*MsgRenewAccount) GetSigners ¶
func (m *MsgRenewAccount) GetSigners() []sdk.AccAddress
GetSigners implements sdk.Msg
func (*MsgRenewAccount) ValidateBasic ¶
func (m *MsgRenewAccount) ValidateBasic() error
ValidateBasic implements sdk.Msg
type MsgRenewDomain ¶
type MsgRenewDomain struct { // Domain is the domain name to renew Domain string // Signer is the request signer Signer sdk.AccAddress }
MsgRenewDomain is the request model used to renew a domain
func (*MsgRenewDomain) GetSignBytes ¶
func (m *MsgRenewDomain) GetSignBytes() []byte
GetSignBytes implements sdk.Msg
func (*MsgRenewDomain) GetSigners ¶
func (m *MsgRenewDomain) GetSigners() []sdk.AccAddress
GetSigners implements sdk.Msg
func (*MsgRenewDomain) ValidateBasic ¶
func (m *MsgRenewDomain) ValidateBasic() error
ValidateBasic implements sdk.Msg
type MsgReplaceAccountMetadata ¶ added in v0.3.0
type MsgReplaceAccountMetadata struct { // Domain is the domain name of the account Domain string // Name is the name of the account Name string // NewMetadataURI is the metadata URI of the account // we want to update or insert NewMetadataURI string // Owner is the owner of the account Owner sdk.AccAddress FeePayer sdk.AccAddress }
MsgReplaceAccountMetadata is the function used to set accounts metadata
func (*MsgReplaceAccountMetadata) GetSignBytes ¶ added in v0.3.0
func (m *MsgReplaceAccountMetadata) GetSignBytes() []byte
GetSignBytes implements sdk.Msg
func (*MsgReplaceAccountMetadata) GetSigners ¶ added in v0.3.0
func (m *MsgReplaceAccountMetadata) GetSigners() []sdk.AccAddress
GetSigners implements sdk.Msg
func (*MsgReplaceAccountMetadata) Route ¶ added in v0.3.0
func (m *MsgReplaceAccountMetadata) Route() string
Route implements sdk.Msg
func (*MsgReplaceAccountMetadata) Type ¶ added in v0.3.0
func (m *MsgReplaceAccountMetadata) Type() string
Type implements sdk.Msg
func (*MsgReplaceAccountMetadata) ValidateBasic ¶ added in v0.3.0
func (m *MsgReplaceAccountMetadata) ValidateBasic() error
ValidateBasic implements sdk.Msg
type MsgReplaceAccountTargets ¶
type MsgReplaceAccountTargets struct { // Domain is the domain name of the account Domain string // Name is the name of the account Name string // NewTargets are the new blockchain addresses NewTargets []BlockchainAddress // Owner is the owner of the account Owner sdk.AccAddress }
MsgReplaceAccountTargets is the request model used to renew blockchain addresses associated with an account
func (*MsgReplaceAccountTargets) GetSignBytes ¶
func (m *MsgReplaceAccountTargets) GetSignBytes() []byte
GetSignBytes implements sdk.Msg
func (*MsgReplaceAccountTargets) GetSigners ¶
func (m *MsgReplaceAccountTargets) GetSigners() []sdk.AccAddress
GetSigners implements sdk.Msg
func (*MsgReplaceAccountTargets) Route ¶
func (m *MsgReplaceAccountTargets) Route() string
Route implements sdk.Msg
func (*MsgReplaceAccountTargets) Type ¶
func (m *MsgReplaceAccountTargets) Type() string
Type implements sdk.Msg
func (*MsgReplaceAccountTargets) ValidateBasic ¶
func (m *MsgReplaceAccountTargets) ValidateBasic() error
ValidateBasic implements sdk.Msg
type MsgTransferAccount ¶
type MsgTransferAccount struct { // Domain is the domain name of the account Domain string // Account is the account name Name string // Owner is the actual owner of the account Owner sdk.AccAddress // NewOwner is the new owner of the account NewOwner sdk.AccAddress // Reset indicates if the accounts content will be resetted Reset bool }
MsgTransferAccount is the request model used to transfer accounts
func (*MsgTransferAccount) GetSignBytes ¶
func (m *MsgTransferAccount) GetSignBytes() []byte
GetSignBytes implements sdk.Msg
func (*MsgTransferAccount) GetSigners ¶
func (m *MsgTransferAccount) GetSigners() []sdk.AccAddress
GetSigners implements sdk.Msg
func (*MsgTransferAccount) Route ¶
func (m *MsgTransferAccount) Route() string
Route implements sdk.Msg
func (*MsgTransferAccount) Type ¶
func (m *MsgTransferAccount) Type() string
Type implements sdk.Msg
func (*MsgTransferAccount) ValidateBasic ¶
func (m *MsgTransferAccount) ValidateBasic() error
ValidateBasic implements sdk.Msg
type MsgTransferDomain ¶
type MsgTransferDomain struct { Domain string Owner sdk.AccAddress NewAdmin sdk.AccAddress TransferFlag TransferFlag }
MsgTransferDomain is the request model used to transfer a domain
func (*MsgTransferDomain) GetSignBytes ¶
func (m *MsgTransferDomain) GetSignBytes() []byte
GetSignBytes implements sdk.Msg
func (*MsgTransferDomain) GetSigners ¶
func (m *MsgTransferDomain) GetSigners() []sdk.AccAddress
GetSigners implements sdk.Msg
func (*MsgTransferDomain) Route ¶
func (m *MsgTransferDomain) Route() string
Route implements sdk.Msg
func (*MsgTransferDomain) ValidateBasic ¶
func (m *MsgTransferDomain) ValidateBasic() error
ValidateBasic implements sdk.Msg
type TransferFlag ¶ added in v0.3.0
type TransferFlag int
TransferFlag defines the type of domain transfer