domain

Documentation

Overview

Package domain contains request verifiers used to interact with domain in the starname module

Index

• type ControllerFunc
• type Domain
  • func NewController(ctx sdk.Context, k keeper.Keeper, domain string) *Domain
  • func (c *Domain) Admin(addr sdk.AccAddress) *Domain
  • func (c *Domain) DeletableBy(addr sdk.AccAddress) *Domain
  • func (c *Domain) Domain() types.Domain
  • func (c *Domain) MustExist() *Domain
  • func (c *Domain) MustNotExist() *Domain
  • func (c *Domain) NotExpired() *Domain
  • func (c *Domain) Renewable() *Domain
  • func (c *Domain) Transferable(flag types.TransferFlag) *Domain
  • func (c *Domain) Type(Type types.DomainType) *Domain
  • func (c *Domain) ValidName() *Domain
  • func (c *Domain) Validate() error
  • func (c *Domain) WithConfiguration(cfg configuration.Config) *Domain
  • func (c *Domain) WithDomain(dom types.Domain) *Domain

Types

type ControllerFunc

type ControllerFunc func(controller *Domain) error

ControllerFunc is the function signature for domain validation functions

type Domain

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

Domain is the domain controller

func NewController

func NewController(ctx sdk.Context, k keeper.Keeper, domain string) *Domain

NewController is the constructor for Domain everything is processed sequentially, a wrong order of the sequence is forbidden, example: asserting domain expiration on a non existing domain causes a panic as it violates the condition scope of action.

func (*Domain) Admin

func (c *Domain) Admin(addr sdk.AccAddress) *Domain

Admin asserts that the domain owner is the provided address

func (*Domain) DeletableBy

func (c *Domain) DeletableBy(addr sdk.AccAddress) *Domain

Deletable checks if the domain can be deleted by the provided address

func (*Domain) Domain

func (c *Domain) Domain() types.Domain

Domain returns a copy the domain, panics if the operation is done without doing validity checks on domain existence as it is not an allowed op

func (*Domain) MustExist

func (c *Domain) MustExist() *Domain

MustExist checks if the provided domain exists

func (*Domain) MustNotExist

func (c *Domain) MustNotExist() *Domain

MustNotExist checks if the provided domain does not exist

func (*Domain) NotExpired

func (c *Domain) NotExpired() *Domain

NotExpired asserts that the domain has not expired

func (*Domain) Renewable

func (c *Domain) Renewable() *Domain

Renewable checks if the domain is allowed to be renewed

func (*Domain) Transferable

func (c *Domain) Transferable(flag types.TransferFlag) *Domain

Transferable asserts the domain is transferable with the given flag

func (*Domain) Type

func (c *Domain) Type(Type types.DomainType) *Domain

Superuser makes sure the domain superuser is set to the provided condition

func (*Domain) ValidName

func (c *Domain) ValidName() *Domain

ValidAccountName checks if the name of the domain is valid

func (*Domain) Validate

func (c *Domain) Validate() error

Validate validates a domain based on the provided checks

func (*Domain) WithConfiguration

func (c *Domain) WithConfiguration(cfg configuration.Config) *Domain

WithConfiguration allows to specify a cached config

func (*Domain) WithDomain

func (c *Domain) WithDomain(dom types.Domain) *Domain

WithDomain creates a domain controller with a cached domain