types

package
v0.2.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 21, 2022 License: GPL-3.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// module name
	ModuleName = "guard"

	// StoreKey to be used when creating the KVStore
	StoreKey = ModuleName
)
View Source 
const (
	// Default number of guards for guarding request
	DefaultRequestGuardCount uint64 = 3

	// Default minimal channel dispute timeout in mainchain blocks
	DefaultMinDisputeTimeout uint64 = 80000
)

guard params default values

View Source 
const (
	QuerySubscription = "subscription"
	QueryRequest      = "request"
	QueryEpoch        = "epoch"
	QueryParameters   = "parameters"
)
View Source 
const RouterKey = ModuleName // this was defined in your key.go file

Variables

View Source 
var (
	SubscriptionKeyPrefix = []byte{0x01} // Key prefix for subscription
	RequestKeyPrefix      = []byte{0x21} // Key prefix for request
)
View Source 
var (
	KeyRequestGuardCount = []byte("RequestGuardCount")
	KeyRequestCost       = []byte("RequestCost")
	KeyMinDisputeTimeout = []byte("MinDisputeTimeout")
)

nolint - Keys for parameter access

View Source 
var (
	// Default cost per request
	DefaultRequestCost = sdk.NewInt(1000000000000000000)
)
View Source 
var ModuleCdc = codec.New()

Functions

func GetRequestKey 

func GetRequestKey(channelId []byte, simplexReceiver string) []byte

get request key from channelID

func GetSubscriptionKey 

func GetSubscriptionKey(ethAddress string) []byte

get guardian key from eth address

func RegisterCodec 

func RegisterCodec(cdc *codec.Codec)

RegisterCodec registers concrete types on the Amino codec

Types

type ChanStatus 

type ChanStatus uint8
const (
	// state of simplex channel guard request
	ChanStatus_Idle        ChanStatus = 0
	ChanStatus_Withdrawing ChanStatus = 1
	ChanStatus_Settling    ChanStatus = 2
	ChanStatus_Settled     ChanStatus = 3
)

func (ChanStatus) String 

func (status ChanStatus) String() string

type GuardProof 

type GuardProof struct {
	ChannelId       []byte     `json:"channel_id"`
	SimplexReceiver string     `json:"simplex_receiver"`
	GuardTxHash     string     `json:"guard_tx_hash"`
	GuardTxBlkNum   uint64     `json:"guard_tx_blk_num"`
	GuardSender     string     `json:"guard_sender"`
	Status          ChanStatus `json:"status"`
}

func NewGuardProof 

func NewGuardProof(
	channelId mainchain.CidType,
	simplexReceiver mainchain.Addr,
	guardTxHash mainchain.HashType,
	guardTxBlkNum uint64,
	guardSender mainchain.Addr,
	status ChanStatus) *GuardProof

func (GuardProof) String 

func (gp GuardProof) String() string

type GuardTrigger 

type GuardTrigger struct {
	ChannelId       []byte     `json:"channel_id"`
	SimplexReceiver string     `json:"simplex_receiver"`
	TriggerTxHash   string     `json:"trigger_tx_hash"`
	TriggerTxBlkNum uint64     `json:"trigger_tx_blk_num"`
	TriggerSeqNum   uint64     `json:"trigger_seq_num"`
	Status          ChanStatus `json:"status"`
}

func NewGuardTrigger 

func NewGuardTrigger(
	channelId mainchain.CidType,
	simplexReceiver mainchain.Addr,
	triggerTxHash mainchain.HashType,
	triggerTxBlkNum uint64,
	triggerSeqNum uint64,
	status ChanStatus) *GuardTrigger

func (GuardTrigger) String 

func (gt GuardTrigger) String() string

type InitRequest 

type InitRequest struct {
	SignedSimplexStateBytes []byte `json:"signed_simplex_state_bytes"`
	SimplexReceiverSig      []byte `json:"simplex_receiver_sig"`
	DisputeTimeout          uint64 `json:"dispute_timeout"`
}

func NewInitRequest 

func NewInitRequest(signedSimplexStateBytes, simplexReceiverSig []byte, disputeTimeout uint64) *InitRequest

type MsgRequestGuard 

type MsgRequestGuard struct {
	SignedSimplexStateBytes []byte         `json:"signed_simplex_state_bytes"`
	SimplexReceiverSig      []byte         `json:"simplex_receiver_sig"`
	Sender                  sdk.AccAddress `json:"sender"`
}

func NewMsgRequestGuard 

func NewMsgRequestGuard(signedSimplexStateBytes, simplexReceiverSig []byte, sender sdk.AccAddress) MsgRequestGuard

NewMsgRequestGuard is a constructor function for MsgRequestGuard

func (MsgRequestGuard) GetSignBytes 

func (msg MsgRequestGuard) GetSignBytes() []byte

GetSignBytes encodes the message for signing

func (MsgRequestGuard) GetSigners 

func (msg MsgRequestGuard) GetSigners() []sdk.AccAddress

GetSigners defines whose signature is required

func (MsgRequestGuard) Route 

func (msg MsgRequestGuard) Route() string

Route should return the name of the module

func (MsgRequestGuard) Type 

func (msg MsgRequestGuard) Type() string

Type should return the action

func (MsgRequestGuard) ValidateBasic 

func (msg MsgRequestGuard) ValidateBasic() error

ValidateBasic runs stateless checks on the message

type Params 

type Params struct {
	RequestGuardCount uint64  `json:"request_guard_count" yaml:"request_guard_count"` // request guard count
	RequestCost       sdk.Int `json:"request_cost" yaml:"request_cost"`               // request cost
	MinDisputeTimeout uint64  `json:"min_dispute_timeout" yaml:"min_dispute_timeout"` // minimal channel dispute timeout in mainchain blocks

}

Params defines the high level settings for guard

func DefaultParams 

func DefaultParams() Params

DefaultParams returns a default set of parameters.

func MustUnmarshalParams 

func MustUnmarshalParams(cdc *codec.Codec, value []byte) Params

unmarshal the current guard params value from store key or panic

func NewParams 

func NewParams(requestGuardCount uint64, requestCost sdk.Int, minDisputeTimeout uint64) Params

NewParams creates a new Params instance

func UnmarshalParams 

func UnmarshalParams(cdc *codec.Codec, value []byte) (params Params, err error)

unmarshal the current guard params value from store key

func (Params) Equal 

func (p Params) Equal(p2 Params) bool

Equal returns a boolean determining if two Param types are identical.

func (*Params) ParamSetPairs 

func (p *Params) ParamSetPairs() params.ParamSetPairs

Implements params.ParamSet

func (Params) String 

func (p Params) String() string

String returns a human readable string representation of the parameters.

func (Params) Validate 

func (p Params) Validate() error

validate a set of params

type QueryEpochParams 

type QueryEpochParams struct {
	EpochId int64
}

func NewQueryEpochParams 

func NewQueryEpochParams(epochId int64) QueryEpochParams

type QueryRequestParams 

type QueryRequestParams struct {
	ChannelId       []byte
	SimplexReceiver string
}

func NewQueryRequestParams 

func NewQueryRequestParams(channelId []byte, simplexReceiver string) QueryRequestParams

type QuerySubscriptionParams 

type QuerySubscriptionParams struct {
	EthAddress string
}

func NewQuerySubscriptionParams 

func NewQuerySubscriptionParams(addr string) QuerySubscriptionParams

type Request 

type Request struct {
	ChannelId               []byte           `json:"channel_id"`
	SeqNum                  uint64           `json:"seq_num"`
	SimplexSender           string           `json:"simplex_sender"`
	SimplexReceiver         string           `json:"simplex_receiver"`
	SignedSimplexStateBytes []byte           `json:"signed_simplex_state_bytes"`
	DisputeTimeout          uint64           `json:"dispute_timeout"`
	Status                  ChanStatus       `json:"status"`
	AssignedGuards          []sdk.AccAddress `json:"assigned_guards"`
	TriggerTxHash           string           `json:"trigger_tx_hash"`
	TriggerTxBlkNum         uint64           `json:"trigger_tx_blk_num"`
	GuardTxHash             string           `json:"guard_tx_hash"`
	GuardTxBlkNum           uint64           `json:"guard_tx_blk_num"`
	GuardSender             string           `json:"guard_sender"`
}

func NewRequest 

func NewRequest(
	channelId []byte, seqNum uint64,
	senderAddr, receiverAddr mainchain.Addr,
	signedSimplexStateBytes []byte,
	disputeTimeout uint64) Request

func (Request) String 

func (r Request) String() string

type Subscription 

type Subscription struct {
	EthAddress string  `json:"eth_address"`
	Deposit    sdk.Int `json:"deposit"`
	Spend      sdk.Int `json:"spend"`
}

func NewSubscription 

func NewSubscription(ethAddress string) Subscription

func (Subscription) String 

func (s Subscription) String() string

implement fmt.Stringer

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.