account

Documentation

Overview

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

Index

• type Account
  • func NewController(ctx sdk.Context, k keeper.Keeper, domain, name string) *Account
  • func (a *Account) Account() types.Account
  • func (a *Account) CertificateExists(cert []byte, certIndex *int) *Account
  • func (a *Account) CertificateLimitNotExceeded() *Account
  • func (a *Account) CertificateNotExist(cert []byte) *Account
  • func (a *Account) CertificateSizeNotExceeded(cert []byte) *Account
  • func (a *Account) DeletableBy(addr sdk.AccAddress) *Account
  • func (a *Account) MetadataSizeNotExceeded(metadata string) *Account
  • func (a *Account) MustExist() *Account
  • func (a *Account) MustNotExist() *Account
  • func (a *Account) NotExpired() *Account
  • func (a *Account) OwnedBy(addr sdk.AccAddress) *Account
  • func (a *Account) RegistrableBy(addr sdk.AccAddress) *Account
  • func (a *Account) Renewable() *Account
  • func (a *Account) ResettableBy(addr sdk.AccAddress, reset bool) *Account
  • func (a *Account) ResourceLimitNotExceeded(resources []types.Resource) *Account
  • func (a *Account) TransferableBy(addr sdk.AccAddress) *Account
  • func (a *Account) ValidName() *Account
  • func (a *Account) ValidResources(resources []types.Resource) *Account
  • func (a *Account) Validate() error
  • func (a *Account) WithAccount(acc types.Account) *Account
  • func (a *Account) WithConfiguration(cfg configuration.Config) *Account
  • func (a *Account) WithDomainController(dom *domain.Domain) *Account

Types

type Account

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

Account is an account controller, it caches information in order to avoid useless query to state to get the same information. Order of execution of controllers matters if the correct order is not followed the controller will panic because of bad operation flow. Errors returned are wrapped sdk.Error types.

func NewController

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

NewController is Account constructor

func (*Account) Account

func (a *Account) Account() types.Account

Account returns the cached account, if the account existence was not asserted before, it panics.

func (*Account) CertificateExists

func (a *Account) CertificateExists(cert []byte, certIndex *int) *Account

CertificateExists asserts that the provided certificate exists and if it does the index is saved in the provided pointer if certIndex pointer is nil the certificate index will not be saved

func (*Account) CertificateLimitNotExceeded

func (a *Account) CertificateLimitNotExceeded() *Account

CertificateLimitNotExceeded asserts that the numbers of certificates in an account was not exceeded

func (*Account) CertificateNotExist

func (a *Account) CertificateNotExist(cert []byte) *Account

CertificateNotExist asserts the provided certificate does not exist in the account already

func (*Account) CertificateSizeNotExceeded

func (a *Account) CertificateSizeNotExceeded(cert []byte) *Account

CertificateSizeNotExceeded asserts that the size of a cert is not beyond the limits

func (*Account) DeletableBy

func (a *Account) DeletableBy(addr sdk.AccAddress) *Account

DeletableBy checks if the account can be deleted by the provided address

func (*Account) MetadataSizeNotExceeded

func (a *Account) MetadataSizeNotExceeded(metadata string) *Account

MetadataSizeNotExceeded asserts that the metadata size of an account was not exceeded

func (*Account) MustExist

func (a *Account) MustExist() *Account

MustExist asserts that the given account exists

func (*Account) MustNotExist

func (a *Account) MustNotExist() *Account

MustNotExist asserts that the given account does not exist

func (*Account) NotExpired

func (a *Account) NotExpired() *Account

NotExpired asserts the account is not expired

func (*Account) OwnedBy

func (a *Account) OwnedBy(addr sdk.AccAddress) *Account

OwnedBy asserts that the account is owned by the provided address

func (*Account) RegistrableBy

func (a *Account) RegistrableBy(addr sdk.AccAddress) *Account

RegistrableBy asserts that an account can be registered by the provided address

func (*Account) Renewable

func (a *Account) Renewable() *Account

Renewable asserts that the account is renewable

func (*Account) ResettableBy

func (a *Account) ResettableBy(addr sdk.AccAddress, reset bool) *Account

ResettableBy checks if the account attributes resettable by the provided address

func (*Account) ResourceLimitNotExceeded

func (a *Account) ResourceLimitNotExceeded(resources []types.Resource) *Account

ResettableBy checks if the account attributes resettable by the provided address

func (*Account) TransferableBy

func (a *Account) TransferableBy(addr sdk.AccAddress) *Account

TransferableBy checks if the account can be transferred by the provided address

func (*Account) ValidName

func (a *Account) ValidName() *Account

ValidName asserts the account name is valid

func (*Account) ValidResources

func (a *Account) ValidResources(resources []types.Resource) *Account

ValidResources verifies that the provided resources are valid for the account

func (*Account) Validate

func (a *Account) Validate() error

Validate verifies the account against the order of provided controllers

func (*Account) WithAccount

func (a *Account) WithAccount(acc types.Account) *Account

WithAccount allows to specify a cached account

func (*Account) WithConfiguration

func (a *Account) WithConfiguration(cfg configuration.Config) *Account

WithConfiguration allows to specify a cached config

func (*Account) WithDomainController

func (a *Account) WithDomainController(dom *domain.Domain) *Account

WithDomainController allows to specify a cached domain controller