models

Documentation

Index

• Constants
• Variables
• func RegisterModelsCodec(cdc *codec.Codec)
• func RelationshipsStoreKey(user sdk.AccAddress) []byte
• func UsersBlocksStoreKey(user sdk.AccAddress) []byte
• type Relationship
  • func NewRelationship(recipient sdk.AccAddress, subspace string) Relationship
  • func (r Relationship) Equals(other Relationship) bool
  • func (r Relationship) String() string
  • func (r Relationship) Validate() error
• type Relationships
  • func (rs Relationships) String() string
• type UserBlock
  • func NewUserBlock(blocker, blocked sdk.AccAddress, reason, subspace string) UserBlock
  • func (ub UserBlock) Equals(other UserBlock) bool
  • func (ub UserBlock) String() string
  • func (ub UserBlock) Validate() error

Constants

const (
	ModuleName = "relationships"
	RouterKey  = ModuleName
	StoreKey   = ModuleName

	ActionCreateRelationship = "create_relationship"
	ActionDeleteRelationship = "delete_relationship"
	ActionBlockUser          = "block_user"
	ActionUnblockUser        = "unblock_user"

	// Queries
	QuerierRoute           = ModuleName
	QueryUserRelationships = "user_relationships"
	QueryRelationships     = "relationships"
	QueryUserBlocks        = "user_blocks"
)

Variables

var (
	RelationshipsStorePrefix = []byte("relationships")
	UsersBlocksStorePrefix   = []byte("users_blocks")
)

var ModelsCdc = codec.New()

ModelsCdc is the codec

Functions

func RegisterModelsCodec

func RegisterModelsCodec(cdc *codec.Codec)

RegisterModelsCodec registers concrete types on the Amino codec

func RelationshipsStoreKey

func RelationshipsStoreKey(user sdk.AccAddress) []byte

RelationshipsStoreKey turns a user address to a key used to store a Address -> []Address couple

func UsersBlocksStoreKey

func UsersBlocksStoreKey(user sdk.AccAddress) []byte

UsersBlocksStoreKey turns a user address to a key used to store a Address -> []Address couple

Types

type Relationship

type Relationship struct {
	Recipient sdk.AccAddress `json:"recipient" yaml:"recipient"`
	Subspace  string         `json:"subspace" yaml:"subspace"`
}

Relationship is the struct of a relationship. It represent the concept of "follow" of traditional social networks.

func NewRelationship

func NewRelationship(recipient sdk.AccAddress, subspace string) Relationship

func (Relationship) Equals

func (r Relationship) Equals(other Relationship) bool

Equals allows to check whether the contents of r are the same of other

func (Relationship) String

func (r Relationship) String() string

String implement fmt.Stringer

func (Relationship) Validate

func (r Relationship) Validate() error

Validate implement Validator

type Relationships

type Relationships []Relationship

func (Relationships) String

func (rs Relationships) String() string

String implement fmt.Stringer

type UserBlock

type UserBlock struct {
	Blocker  sdk.AccAddress `json:"blocker" yaml:"blocker"`
	Blocked  sdk.AccAddress `json:"blocked" yaml:"blocked"`
	Reason   string         `json:"reason,omitempty" yaml:"reason,omitempty"`
	Subspace string         `json:"subspace" yaml:"subspace"`
}

UserBlock represents the fact that the Blocker has blocked the given Blocked user. The Reason field represents the reason the user has been blocked for, and is optional.

func NewUserBlock

func NewUserBlock(blocker, blocked sdk.AccAddress, reason, subspace string) UserBlock

func (UserBlock) Equals

func (ub UserBlock) Equals(other UserBlock) bool

Equals checks if the two user blocks have the same content

func (UserBlock) String

func (ub UserBlock) String() string

String implements fmt.Stringer

func (UserBlock) Validate

func (ub UserBlock) Validate() error

Validate implements validator