types

package
v0.24.2-rc0 Latest Latest
Warning

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

 Go to latest Published: Aug 22, 2018 License: Apache-2.0 Imports: 24 Imported by: 46,705

Documentation

Index

Constants

View Source 
const (
	// expected address length
	AddrLen = 20

	// Bech32 prefixes
	Bech32PrefixAccAddr = "cosmosaccaddr"
	Bech32PrefixAccPub  = "cosmosaccpub"
	Bech32PrefixValAddr = "cosmosvaladdr"
	Bech32PrefixValPub  = "cosmosvalpub"
)

Bech32 prefixes

View Source 
const (
	// ABCI error codes
	ABCICodeOK ABCICodeType = 0

	// Base error codes
	CodeOK                CodeType = 0
	CodeInternal          CodeType = 1
	CodeTxDecode          CodeType = 2
	CodeInvalidSequence   CodeType = 3
	CodeUnauthorized      CodeType = 4
	CodeInsufficientFunds CodeType = 5
	CodeUnknownRequest    CodeType = 6
	CodeInvalidAddress    CodeType = 7
	CodeInvalidPubKey     CodeType = 8
	CodeUnknownAddress    CodeType = 9
	CodeInsufficientCoins CodeType = 10
	CodeInvalidCoins      CodeType = 11
	CodeOutOfGas          CodeType = 12
	CodeMemoTooLarge      CodeType = 13

	// CodespaceRoot is a codespace for error codes in this file only.
	// Notice that 0 is an "unset" codespace, which can be overridden with
	// Error.WithDefaultCodespace().
	CodespaceUndefined CodespaceType = 0
	CodespaceRoot      CodespaceType = 1

	// Maximum reservable codespace (2^16 - 1)
	MaximumCodespace CodespaceType = 65535
)

SDK error codes

Variables

View Source 
var (
	TagAction       = "action"
	TagSrcValidator = "source-validator"
	TagDstValidator = "destination-validator"
	TagDelegator    = "delegator"
)

common tags

Functions

func ABCIValidator added in v0.18.0 

func ABCIValidator(v Validator) abci.Validator

validator which fulfills abci validator interface for use in Tendermint

func Bech32ifyAccPub added in v0.18.0 

func Bech32ifyAccPub(pub crypto.PubKey) (string, error)

Bech32ifyAccPub takes AccountPubKey and returns the bech32 encoded string

func Bech32ifyValPub added in v0.18.0 

func Bech32ifyValPub(pub crypto.PubKey) (string, error)

Bech32ifyValPub returns the bech32 encoded string for a validator pubkey

func BondStatusToString added in v0.18.0 

func BondStatusToString(b BondStatus) string

BondStatusToString for pretty prints of Bond Status

func CodeToDefaultMsg added in v0.2.0 

func CodeToDefaultMsg(code CodeType) string

NOTE: Don't stringer this, we'll put better messages in later. nolint: gocyclo

func GetAccPubKeyBech32 added in v0.19.0 

func GetAccPubKeyBech32(address string) (pk crypto.PubKey, err error)

create a Pubkey from a string

func GetFromBech32 

func GetFromBech32(bech32str, prefix string) ([]byte, error)

decode a bytestring from a bech32-encoded string

func GetValPubKeyBech32 added in v0.18.0 

func GetValPubKeyBech32(pubkey string) (pk crypto.PubKey, err error)

decode a validator public key into a PubKey

func MustBech32ifyAccPub added in v0.19.0 

func MustBech32ifyAccPub(pub crypto.PubKey) string

MustBech32ifyAccPub panics on bech32-encoding failure

func MustBech32ifyValPub added in v0.19.0 

func MustBech32ifyValPub(pub crypto.PubKey) string

MustBech32ifyValPub panics on bech32-encoding failure

func MustGetAccPubKeyBech32 added in v0.20.0 

func MustGetAccPubKeyBech32(address string) (pk crypto.PubKey)

create an Pubkey from a string, panics on error

func MustGetValPubKeyBech32 added in v0.20.0 

func MustGetValPubKeyBech32(address string) (pk crypto.PubKey)

create an Pubkey from a string, panics on error

func MustSortJSON 

func MustSortJSON(toSortJSON []byte) []byte

MustSortJSON is like SortJSON but panic if an error occurs, e.g., if the passed JSON isn't valid.

func NewRatFromDecimal added in v0.2.0 

func NewRatFromDecimal(decimalStr string, prec int) (f Rat, err Error)

create a rational from decimal string or integer string precision is the number of values after the decimal point which should be read

func PrefixEndBytes 

func PrefixEndBytes(prefix []byte) []byte

PrefixEndBytes returns the []byte that would end a range query for all []byte with a certain prefix Deals with last byte of prefix being FF without overflowing

func RatEq added in v0.18.0 

func RatEq(t *testing.T, exp, got Rat) (*testing.T, bool, string, Rat, Rat)

intended to be used with require/assert: require.True(RatEq(...))

func RatsEqual added in v0.18.0 

func RatsEqual(r1s, r2s []Rat) bool

test if two rat arrays are equal

func RegisterWire added in v0.16.0 

func RegisterWire(cdc *wire.Codec)

Register the sdk message type

func SortJSON 

func SortJSON(toSortJSON []byte) ([]byte, error)

SortedJSON takes any JSON and returns it sorted by keys. Also, all white-spaces are removed. This method can be used to canonicalize JSON to be returned by GetSignBytes, e.g. for the ledger integration. If the passed JSON isn't valid it will return an error.

Types

type ABCICodeType added in v0.16.0 

type ABCICodeType uint32

ABCICodeType - combined codetype / codespace

func ToABCICode added in v0.16.0 

func ToABCICode(space CodespaceType, code CodeType) ABCICodeType

get the abci code from the local code and codespace

func (ABCICodeType) IsOK added in v0.16.0 

func (code ABCICodeType) IsOK() bool

IsOK - is everything okay?

type AccAddress 

type AccAddress []byte

AccAddress a wrapper around bytes meant to represent an account address When marshaled to a string or json, it uses bech32

func AccAddressFromBech32 

func AccAddressFromBech32(address string) (addr AccAddress, err error)

create an AccAddress from a bech32 string

func AccAddressFromHex 

func AccAddressFromHex(address string) (addr AccAddress, err error)

create an AccAddress from a hex string

func (AccAddress) Bytes 

func (bz AccAddress) Bytes() []byte

Allow it to fulfill various interfaces in light-client, etc...

func (AccAddress) Format 

func (bz AccAddress) Format(s fmt.State, verb rune)

For Printf / Sprintf, returns bech32 when using %s

func (AccAddress) Marshal 

func (bz AccAddress) Marshal() ([]byte, error)

Marshal needed for protobuf compatibility

func (AccAddress) MarshalJSON 

func (bz AccAddress) MarshalJSON() ([]byte, error)

Marshals to JSON using Bech32

func (AccAddress) String 

func (bz AccAddress) String() string

func (*AccAddress) Unmarshal 

func (bz *AccAddress) Unmarshal(data []byte) error

Unmarshal needed for protobuf compatibility

func (*AccAddress) UnmarshalJSON 

func (bz *AccAddress) UnmarshalJSON(data []byte) error

Unmarshals from JSON assuming Bech32 encoding

type AnteHandler 

type AnteHandler func(ctx Context, tx Tx) (newCtx Context, result Result, abort bool)

AnteHandler authenticates transactions, before their internal messages are handled. If newCtx.IsZero(), ctx is used instead.

type BeginBlocker 

type BeginBlocker func(ctx Context, req abci.RequestBeginBlock) abci.ResponseBeginBlock

run code before the transactions in a block

type BondStatus 

type BondStatus byte

status of a validator 

const (
	Unbonded  BondStatus = 0x00
	Unbonding BondStatus = 0x01
	Bonded    BondStatus = 0x02
)

nolint

func (BondStatus) Equal 

func (b BondStatus) Equal(b2 BondStatus) bool

nolint

type CacheKVStore 

type CacheKVStore interface {
	KVStore

	// Writes operations to underlying KVStore
	Write()
}

CacheKVStore cache-wraps a KVStore. After calling .Write() on the CacheKVStore, all previously created CacheKVStores on the object expire.

type CacheMultiStore 

type CacheMultiStore interface {
	MultiStore
	Write() // Writes operations to underlying KVStore
}

From MultiStore.CacheMultiStore()....

type CacheWrap 

type CacheWrap interface {
	// Write syncs with the underlying store.
	Write()

	// CacheWrap recursively wraps again.
	CacheWrap() CacheWrap

	// CacheWrapWithTrace recursively wraps again with tracing enabled.
	CacheWrapWithTrace(w io.Writer, tc TraceContext) CacheWrap
}

CacheWrap makes the most appropriate cache-wrap. For example, IAVLStore.CacheWrap() returns a CacheKVStore. CacheWrap should not return a Committer, since Commit cache-wraps make no sense. It can return KVStore, HeapStore, SpaceStore, etc.

type CacheWrapper 

type CacheWrapper interface {
	// CacheWrap cache wraps.
	CacheWrap() CacheWrap

	// CacheWrapWithTrace cache wraps with tracing enabled.
	CacheWrapWithTrace(w io.Writer, tc TraceContext) CacheWrap
}

type CodeType added in v0.2.0 

type CodeType uint16

CodeType - code identifier within codespace

type CodespaceType added in v0.16.0 

type CodespaceType uint16

CodespaceType - codespace identifier

type Codespacer added in v0.16.0 

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

Codespacer is a simple struct to track reserved codespaces

func NewCodespacer added in v0.16.0 

func NewCodespacer() *Codespacer

NewCodespacer generates a new Codespacer with the starting codespace

func (*Codespacer) RegisterNext added in v0.16.0 

func (c *Codespacer) RegisterNext(codespace CodespaceType) CodespaceType

RegisterNext reserves and returns the next available codespace, starting from a default, and panics if the maximum codespace is reached

func (*Codespacer) RegisterOrPanic added in v0.16.0 

func (c *Codespacer) RegisterOrPanic(codespace CodespaceType)

RegisterOrPanic reserved a codespace or panics if it is unavailable

type Coin 

type Coin struct {
	Denom  string `json:"denom"`
	Amount Int    `json:"amount"`
}

Coin hold some amount of one currency

func NewCoin 

func NewCoin(denom string, amount Int) Coin

func NewInt64Coin 

func NewInt64Coin(denom string, amount int64) Coin

func ParseCoin 

func ParseCoin(coinStr string) (coin Coin, err error)

ParseCoin parses a cli input for one coin type, returning errors if invalid. This returns an error on an empty string as well.

func (Coin) IsEqual 

func (coin Coin) IsEqual(other Coin) bool

IsEqual returns true if the two sets of Coins have the same value

func (Coin) IsGTE 

func (coin Coin) IsGTE(other Coin) bool

IsGTE returns true if they are the same type and the receiver is an equal or greater value

func (Coin) IsNotNegative added in v0.2.0 

func (coin Coin) IsNotNegative() bool

IsNotNegative returns true if coin amount is not negative

func (Coin) IsPositive 

func (coin Coin) IsPositive() bool

IsPositive returns true if coin amount is positive

func (Coin) IsZero 

func (coin Coin) IsZero() bool

IsZero returns if this represents no money

func (Coin) Minus added in v0.2.0 

func (coin Coin) Minus(coinB Coin) Coin

Subtracts amounts of two coins with same denom

func (Coin) Plus added in v0.2.0 

func (coin Coin) Plus(coinB Coin) Coin

Adds amounts of two coins with same denom

func (Coin) SameDenomAs added in v0.2.0 

func (coin Coin) SameDenomAs(other Coin) bool

SameDenomAs returns true if the two coins are the same denom

func (Coin) String 

func (coin Coin) String() string

String provides a human-readable representation of a coin

type Coins 

type Coins []Coin

Coins is a set of Coin, one per currency

func ParseCoins 

func ParseCoins(coinsStr string) (coins Coins, err error)

ParseCoins will parse out a list of coins separated by commas. If nothing is provided, it returns nil Coins. Returned coins are sorted.

func (Coins) AmountOf 

func (coins Coins) AmountOf(denom string) Int

Returns the amount of a denom from coins

func (Coins) IsEqual 

func (coins Coins) IsEqual(coinsB Coins) bool

IsEqual returns true if the two sets of Coins have the same value

func (Coins) IsGTE added in v0.2.0 

func (coins Coins) IsGTE(coinsB Coins) bool

IsGTE returns True iff coins is NonNegative(), and for every currency in coinsB, the currency is present at an equal or greater amount in coinsB

func (Coins) IsNotNegative added in v0.2.0 

func (coins Coins) IsNotNegative() bool

IsNotNegative returns true if there is no currency with a negative value (even no coins is true here)

func (Coins) IsPositive added in v0.2.0 

func (coins Coins) IsPositive() bool

IsPositive returns true if there is at least one coin, and all currencies have a positive value

func (Coins) IsValid 

func (coins Coins) IsValid() bool

IsValid asserts the Coins are sorted, and don't have 0 amounts

func (Coins) IsZero 

func (coins Coins) IsZero() bool

IsZero returns true if there are no coins or all coins are zero.

func (Coins) Len 

func (coins Coins) Len() int

nolint

func (Coins) Less 

func (coins Coins) Less(i, j int) bool

func (Coins) Minus added in v0.2.0 

func (coins Coins) Minus(coinsB Coins) Coins

Minus subtracts a set of coins from another (adds the inverse)

func (Coins) Negative added in v0.2.0 

func (coins Coins) Negative() Coins

Negative returns a set of coins with all amount negative

func (Coins) Plus added in v0.2.0 

func (coins Coins) Plus(coinsB Coins) Coins

Plus combines two sets of coins CONTRACT: Plus will never return Coins where one Coin has a 0 amount.

func (Coins) Sort 

func (coins Coins) Sort() Coins

Sort is a helper function to sort the set of coins inplace

func (Coins) String 

func (coins Coins) String() string

func (Coins) Swap 

func (coins Coins) Swap(i, j int)

type CommitID 

type CommitID struct {
	Version int64
	Hash    []byte
}

CommitID contains the tree version number and its merkle root.

func (CommitID) IsZero added in v0.2.0 

func (cid CommitID) IsZero() bool

func (CommitID) String added in v0.2.0 

func (cid CommitID) String() string

type CommitKVStore 

type CommitKVStore interface {
	Committer
	KVStore
}

Stores of MultiStore must implement CommitStore.

type CommitMultiStore 

type CommitMultiStore interface {
	Committer
	MultiStore

	// Mount a store of type using the given db.
	// If db == nil, the new store will use the CommitMultiStore db.
	MountStoreWithDB(key StoreKey, typ StoreType, db dbm.DB)

	// Panics on a nil key.
	GetCommitStore(key StoreKey) CommitStore

	// Panics on a nil key.
	GetCommitKVStore(key StoreKey) CommitKVStore

	// Load the latest persisted version.  Called once after all
	// calls to Mount*Store() are complete.
	LoadLatestVersion() error

	// Load a specific persisted version.  When you load an old
	// version, or when the last commit attempt didn't complete,
	// the next commit after loading must be idempotent (return the
	// same commit id).  Otherwise the behavior is undefined.
	LoadVersion(ver int64) error
}

A non-cache MultiStore.

type CommitStore 

type CommitStore interface {
	Committer
	Store
}

Stores of MultiStore must implement CommitStore.

type Committer 

type Committer interface {
	Commit() CommitID
	LastCommitID() CommitID
	SetPruning(PruningStrategy)
}

something that can persist to disk

type Context 

type Context struct {
	context.Context
	// contains filtered or unexported fields
}

The intent of Context is for it to be an immutable object that can be cloned and updated cheaply with WithValue() and passed forward to the next decorator or handler. For example, 

func MsgHandler(ctx Context, tx Tx) Result {
	...
	ctx = ctx.WithValue(key, value)
	...
}

func NewContext 

func NewContext(ms MultiStore, header abci.Header, isCheckTx bool, logger log.Logger) Context

create a new context

func (Context) BlockHeader 

func (c Context) BlockHeader() abci.Header

nolint

func (Context) BlockHeight 

func (c Context) BlockHeight() int64

func (Context) CacheContext 

func (c Context) CacheContext() (cc Context, writeCache func())

Cache the multistore and return a new cached context. The cached context is written to the context when writeCache is called.

func (Context) ChainID 

func (c Context) ChainID() string

func (Context) ConsensusParams 

func (c Context) ConsensusParams() abci.ConsensusParams

func (Context) GasMeter 

func (c Context) GasMeter() GasMeter

func (Context) GetOp added in v0.2.0 

func (c Context) GetOp(ver int64) (Op, bool)

Returns false if ver <= 0 || ver > len(c.pst.ops). The first operation is version 1.

func (Context) IsZero 

func (c Context) IsZero() bool

is context nil

func (Context) KVStore 

func (c Context) KVStore(key StoreKey) KVStore

KVStore fetches a KVStore from the MultiStore.

func (Context) Logger 

func (c Context) Logger() log.Logger

func (Context) SigningValidators added in v0.18.0 

func (c Context) SigningValidators() []abci.SigningValidator

func (Context) TransientStore 

func (c Context) TransientStore(key StoreKey) KVStore

TransientStore fetches a TransientStore from the MultiStore.

func (Context) TxBytes 

func (c Context) TxBytes() []byte

func (Context) Value 

func (c Context) Value(key interface{}) interface{}

context value for the provided key

func (Context) WithBlockHeader 

func (c Context) WithBlockHeader(header abci.Header) Context

func (Context) WithBlockHeight 

func (c Context) WithBlockHeight(height int64) Context

func (Context) WithCacheWrapper added in v0.2.0 

func (c Context) WithCacheWrapper(key interface{}, value CacheWrapper) Context

func (Context) WithChainID 

func (c Context) WithChainID(chainID string) Context

func (Context) WithCloner added in v0.2.0 

func (c Context) WithCloner(key interface{}, value cloner) Context

func (Context) WithConsensusParams 

func (c Context) WithConsensusParams(params *abci.ConsensusParams) Context

func (Context) WithGasMeter 

func (c Context) WithGasMeter(meter GasMeter) Context

func (Context) WithInt32 added in v0.2.0 

func (c Context) WithInt32(key interface{}, value int32) Context

func (Context) WithLogger 

func (c Context) WithLogger(logger log.Logger) Context

func (Context) WithMultiStore 

func (c Context) WithMultiStore(ms MultiStore) Context

func (Context) WithProtoMsg added in v0.2.0 

func (c Context) WithProtoMsg(key interface{}, value proto.Message) Context

func (Context) WithSigningValidators added in v0.18.0 

func (c Context) WithSigningValidators(SigningValidators []abci.SigningValidator) Context

func (Context) WithString added in v0.2.0 

func (c Context) WithString(key interface{}, value string) Context

func (Context) WithTxBytes 

func (c Context) WithTxBytes(txBytes []byte) Context

func (Context) WithUint32 added in v0.2.0 

func (c Context) WithUint32(key interface{}, value uint32) Context

func (Context) WithUint64 added in v0.2.0 

func (c Context) WithUint64(key interface{}, value uint64) Context

func (Context) WithValue 

func (c Context) WithValue(key interface{}, value interface{}) Context

nolint

type Delegation added in v0.18.0 

type Delegation interface {
	GetDelegator() AccAddress // delegator AccAddress for the bond
	GetValidator() AccAddress // validator owner AccAddress for the bond
	GetBondShares() Rat       // amount of validator's shares
}

delegation bond for a delegated proof of stake system

type DelegationSet added in v0.18.0 

type DelegationSet interface {
	GetValidatorSet() ValidatorSet // validator set for which delegation set is based upon

	// iterate through all delegations from one delegator by validator-AccAddress,
	//   execute func for each validator
	IterateDelegations(ctx Context, delegator AccAddress,
		fn func(index int64, delegation Delegation) (stop bool))
}

properties for the set of all delegations for a particular

type EndBlocker 

type EndBlocker func(ctx Context, req abci.RequestEndBlock) abci.ResponseEndBlock

run code after the transactions in a block and return updates to the validator set

type Error added in v0.2.0 

type Error interface {

	// convenience
	TraceSDK(format string, args ...interface{}) Error

	// set codespace
	WithDefaultCodespace(CodespaceType) Error

	Code() CodeType
	Codespace() CodespaceType
	ABCILog() string
	ABCICode() ABCICodeType
	Result() Result
	QueryResult() abci.ResponseQuery
	// contains filtered or unexported methods
}

sdk Error type

func ErrInsufficientCoins added in v0.2.0 

func ErrInsufficientCoins(msg string) Error

func ErrInsufficientFunds added in v0.2.0 

func ErrInsufficientFunds(msg string) Error

func ErrInternal added in v0.2.0 

func ErrInternal(msg string) Error

nolint

func ErrInvalidAddress added in v0.2.0 

func ErrInvalidAddress(msg string) Error

func ErrInvalidCoins added in v0.2.0 

func ErrInvalidCoins(msg string) Error

func ErrInvalidPubKey added in v0.2.0 

func ErrInvalidPubKey(msg string) Error

func ErrInvalidSequence added in v0.2.0 

func ErrInvalidSequence(msg string) Error

func ErrMemoTooLarge added in v0.20.0 

func ErrMemoTooLarge(msg string) Error

func ErrOutOfGas added in v0.18.0 

func ErrOutOfGas(msg string) Error

func ErrTxDecode added in v0.2.0 

func ErrTxDecode(msg string) Error

func ErrUnauthorized added in v0.2.0 

func ErrUnauthorized(msg string) Error

func ErrUnknownAddress added in v0.2.0 

func ErrUnknownAddress(msg string) Error

func ErrUnknownRequest added in v0.2.0 

func ErrUnknownRequest(msg string) Error

func NewError added in v0.2.0 

func NewError(codespace CodespaceType, code CodeType, format string, args ...interface{}) Error

NewError - create an error.

type ErrorOutOfGas 

type ErrorOutOfGas struct {
	Descriptor string
}

Error thrown when out of gas

type Gas 

type Gas = int64

Gas measured by the SDK

type GasConfig 

type GasConfig struct {
	HasCost          Gas
	ReadCostFlat     Gas
	ReadCostPerByte  Gas
	WriteCostFlat    Gas
	WriteCostPerByte Gas
	KeyCostFlat      Gas
	ValueCostFlat    Gas
	ValueCostPerByte Gas
}

GasConfig defines gas cost for each operation on KVStores

func DefaultGasConfig added in v0.24.0 

func DefaultGasConfig() GasConfig

Default gas config for KVStores

func TransientGasConfig added in v0.24.0 

func TransientGasConfig() GasConfig

Default gas config for TransientStores

type GasMeter 

type GasMeter interface {
	GasConsumed() Gas
	ConsumeGas(amount Gas, descriptor string)
}

GasMeter interface to track gas consumption

func NewGasMeter 

func NewGasMeter(limit Gas) GasMeter

func NewInfiniteGasMeter 

func NewInfiniteGasMeter() GasMeter

type Handler 

type Handler func(ctx Context, msg Msg) Result

Handler defines the core of the state transition function of an application.

type InitChainer 

type InitChainer func(ctx Context, req abci.RequestInitChain) abci.ResponseInitChain

initialize application state at genesis

type Int 

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

Int wraps integer with 256 bit range bound Checks overflow, underflow and division by zero Exists in range from -(2^255-1) to 2^255-1

func MinInt 

func MinInt(i1, i2 Int) Int

Return the minimum of the ints

func NewInt 

func NewInt(n int64) Int

NewInt constructs Int from int64

func NewIntFromBigInt 

func NewIntFromBigInt(i *big.Int) Int

NewIntFromBigInt constructs Int from big.Int

func NewIntFromString 

func NewIntFromString(s string) (res Int, ok bool)

NewIntFromString constructs Int from string

func NewIntWithDecimal 

func NewIntWithDecimal(n int64, dec int) Int

NewIntWithDecimal constructs Int with decimal Result value is n*10^dec

func OneInt 

func OneInt() Int

OneInt returns Int value with one

func ZeroInt 

func ZeroInt() Int

ZeroInt returns Int value with zero

func (Int) Add 

func (i Int) Add(i2 Int) (res Int)

Add adds Int from another

func (Int) AddRaw 

func (i Int) AddRaw(i2 int64) Int

AddRaw adds int64 to Int

func (Int) BigInt 

func (i Int) BigInt() *big.Int

BigInt converts Int to big.Int

func (Int) Div added in v0.20.0 

func (i Int) Div(i2 Int) (res Int)

Div divides Int with Int

func (Int) DivRaw added in v0.20.0 

func (i Int) DivRaw(i2 int64) Int

DivRaw divides Int with int64

func (Int) Equal 

func (i Int) Equal(i2 Int) bool

Equal compares two Ints

func (Int) GT 

func (i Int) GT(i2 Int) bool

GT returns true if first Int is greater than second

func (Int) Int64 

func (i Int) Int64() int64

Int64 converts Int to int64 Panics if the value is out of range

func (Int) IsInt64 

func (i Int) IsInt64() bool

IsInt64 returns true if Int64() not panics

func (Int) IsZero 

func (i Int) IsZero() bool

IsZero returns true if Int is zero

func (Int) LT 

func (i Int) LT(i2 Int) bool

LT returns true if first Int is lesser than second

func (Int) MarshalAmino 

func (i Int) MarshalAmino() (string, error)

MarshalAmino defines custom encoding scheme

func (Int) MarshalJSON 

func (i Int) MarshalJSON() ([]byte, error)

MarshalJSON defines custom encoding scheme

func (Int) Mod 

func (i Int) Mod(i2 Int) Int

Mod returns remainder after dividing with Int

func (Int) ModRaw 

func (i Int) ModRaw(i2 int64) Int

ModRaw returns remainder after dividing with int64

func (Int) Mul 

func (i Int) Mul(i2 Int) (res Int)

Mul multiples two Ints

func (Int) MulRaw 

func (i Int) MulRaw(i2 int64) Int

MulRaw multipies Int and int64

func (Int) Neg 

func (i Int) Neg() (res Int)

Neg negates Int

func (Int) Sign 

func (i Int) Sign() int

Sign returns sign of Int

func (Int) String 

func (i Int) String() string

Human readable string

func (Int) Sub 

func (i Int) Sub(i2 Int) (res Int)

Sub subtracts Int from another

func (Int) SubRaw 

func (i Int) SubRaw(i2 int64) Int

SubRaw subtracts int64 from Int

func (*Int) UnmarshalAmino 

func (i *Int) UnmarshalAmino(text string) error

UnmarshalAmino defines custom decoding scheme

func (*Int) UnmarshalJSON 

func (i *Int) UnmarshalJSON(bz []byte) error

UnmarshalJSON defines custom decoding scheme

type Iterator 

type Iterator = dbm.Iterator

Alias iterator to db's Iterator for convenience.

func KVStorePrefixIterator 

func KVStorePrefixIterator(kvs KVStore, prefix []byte) Iterator

Iterator over all the keys with a certain prefix in ascending order

func KVStoreReversePrefixIterator 

func KVStoreReversePrefixIterator(kvs KVStore, prefix []byte) Iterator

Iterator over all the keys with a certain prefix in descending order.

type KVPair 

type KVPair cmn.KVPair

key-value result for iterator queries

type KVStore 

type KVStore interface {
	Store

	// Get returns nil iff key doesn't exist. Panics on nil key.
	Get(key []byte) []byte

	// Has checks if a key exists. Panics on nil key.
	Has(key []byte) bool

	// Set sets the key. Panics on nil key.
	Set(key, value []byte)

	// Delete deletes the key. Panics on nil key.
	Delete(key []byte)

	// Iterator over a domain of keys in ascending order. End is exclusive.
	// Start must be less than end, or the Iterator is invalid.
	// Iterator must be closed by caller.
	// To iterate over entire domain, use store.Iterator(nil, nil)
	// CONTRACT: No writes may happen within a domain while an iterator exists over it.
	Iterator(start, end []byte) Iterator

	// Iterator over a domain of keys in descending order. End is exclusive.
	// Start must be greater than end, or the Iterator is invalid.
	// Iterator must be closed by caller.
	// CONTRACT: No writes may happen within a domain while an iterator exists over it.
	ReverseIterator(start, end []byte) Iterator

	// Prefix applied keys with the argument
	// CONTRACT: when Prefix is called on a KVStore more than once,
	// the concatanation of the prefixes is applied
	Prefix(prefix []byte) KVStore

	// Gas consuming store
	// CONTRACT: when Gas is called on a KVStore more than once,
	// the concatanation of the meters/configs is applied
	Gas(GasMeter, GasConfig) KVStore
}

KVStore is a simple interface to get/set data

type KVStoreKey 

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

KVStoreKey is used for accessing substores. Only the pointer value should ever be used - it functions as a capabilities key.

func NewKVStoreKey 

func NewKVStoreKey(name string) *KVStoreKey

NewKVStoreKey returns a new pointer to a KVStoreKey. Use a pointer so keys don't collide.

func (*KVStoreKey) Name added in v0.2.0 

func (key *KVStoreKey) Name() string

func (*KVStoreKey) String added in v0.2.0 

func (key *KVStoreKey) String() string

type Msg 

type Msg interface {

	// Return the message type.
	// Must be alphanumeric or empty.
	Type() string

	// ValidateBasic does a simple validation check that
	// doesn't require access to any other information.
	ValidateBasic() Error

	// Get the canonical byte representation of the Msg.
	GetSignBytes() []byte

	// Signers returns the addrs of signers that must sign.
	// CONTRACT: All signatures must be present to be valid.
	// CONTRACT: Returns addrs in some deterministic order.
	GetSigners() []AccAddress
}

Transactions messages must fulfill the Msg

type MultiStore 

type MultiStore interface {
	Store

	// Cache wrap MultiStore.
	// NOTE: Caller should probably not call .Write() on each, but
	// call CacheMultiStore.Write().
	CacheMultiStore() CacheMultiStore

	// Convenience for fetching substores.
	GetStore(StoreKey) Store
	GetKVStore(StoreKey) KVStore

	// TracingEnabled returns if tracing is enabled for the MultiStore.
	TracingEnabled() bool

	// WithTracer sets the tracer for the MultiStore that the underlying
	// stores will utilize to trace operations. A MultiStore is returned.
	WithTracer(w io.Writer) MultiStore

	// WithTracingContext sets the tracing context for a MultiStore. It is
	// implied that the caller should update the context when necessary between
	// tracing operations. A MultiStore is returned.
	WithTracingContext(TraceContext) MultiStore

	// ResetTraceContext resets the current tracing context.
	ResetTraceContext() MultiStore
}

type Op added in v0.2.0 

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

XXX add description

type PeerFilter 

type PeerFilter func(info string) abci.ResponseQuery

respond to p2p filtering queries from Tendermint

type PruningStrategy added in v0.21.0 

type PruningStrategy uint8

PruningStrategy specfies how old states will be deleted over time 

const (
	// PruneSyncable means only those states not needed for state syncing will be deleted (keeps last 100 + every 10000th)
	PruneSyncable PruningStrategy = iota

	// PruneEverything means all saved states will be deleted, storing only the current state
	PruneEverything PruningStrategy = iota

	// PruneNothing means all historic states will be saved, nothing will be deleted
	PruneNothing PruningStrategy = iota
)

type Queryable 

type Queryable interface {
	Query(abci.RequestQuery) abci.ResponseQuery
}

Queryable allows a Store to expose internal state to the abci.Query interface. Multistore can route requests to the proper Store.

This is an optional, but useful extension to any CommitStore

type Rat added in v0.2.0 

type Rat struct {
	*big.Rat `json:"rat"`
}

NOTE: never use new(Rat) or else we will panic unmarshalling into the nil embedded big.Rat

func MinRat added in v0.21.0 

func MinRat(r1, r2 Rat) Rat

minimum rational between two

func NewRat added in v0.2.0 

func NewRat(Numerator int64, Denominator ...int64) Rat

New - create a new Rat from integers

func NewRatFromBigInt added in v0.20.0 

func NewRatFromBigInt(num *big.Int, denom ...*big.Int) Rat

NewRatFromBigInt constructs Rat from big.Int

func NewRatFromInt added in v0.20.0 

func NewRatFromInt(num Int, denom ...Int) Rat

NewRatFromInt constructs Rat from Int

func OneRat added in v0.2.0 

func OneRat() Rat

func ZeroRat added in v0.2.0 

func ZeroRat() Rat

nolint - common values

func (Rat) Add added in v0.2.0 

func (r Rat) Add(r2 Rat) Rat

func (Rat) Denom added in v0.2.0 

func (r Rat) Denom() Int

func (Rat) Equal added in v0.2.0 

func (r Rat) Equal(r2 Rat) bool

func (Rat) EvaluateBig added in v0.2.0 

func (r Rat) EvaluateBig() *big.Int

evaluate the rational using bankers rounding

func (Rat) FloatString added in v0.20.0 

func (r Rat) FloatString() string

func (Rat) GT added in v0.2.0 

func (r Rat) GT(r2 Rat) bool

func (Rat) GTE added in v0.20.0 

func (r Rat) GTE(r2 Rat) bool

func (Rat) IsZero added in v0.2.0 

func (r Rat) IsZero() bool

func (Rat) LT added in v0.2.0 

func (r Rat) LT(r2 Rat) bool

func (Rat) LTE added in v0.20.0 

func (r Rat) LTE(r2 Rat) bool

func (Rat) MarshalAmino added in v0.17.0 

func (r Rat) MarshalAmino() (string, error)

Wraps r.MarshalText().

func (Rat) Mul added in v0.2.0 

func (r Rat) Mul(r2 Rat) Rat

func (Rat) Num added in v0.2.0 

func (r Rat) Num() Int

nolint

func (Rat) Quo added in v0.2.0 

func (r Rat) Quo(r2 Rat) Rat

func (Rat) Round added in v0.2.0 

func (r Rat) Round(precisionFactor int64) Rat

round Rat with the provided precisionFactor

func (Rat) RoundInt added in v0.20.0 

func (r Rat) RoundInt() Int

RoundInt round the rational using bankers rounding

func (Rat) RoundInt64 added in v0.20.0 

func (r Rat) RoundInt64() int64

RoundInt64 rounds the rational using bankers rounding

func (Rat) String added in v0.16.0 

func (r Rat) String() string

func (Rat) Sub added in v0.2.0 

func (r Rat) Sub(r2 Rat) Rat

func (Rat) ToLeftPadded added in v0.2.0 

func (r Rat) ToLeftPadded(totalDigits int8) string

TODO panic if negative or if totalDigits < len(initStr)??? evaluate as an integer and return left padded string

func (*Rat) UnmarshalAmino added in v0.17.0 

func (r *Rat) UnmarshalAmino(text string) (err error)

Requires a valid JSON string - strings quotes and calls UnmarshalText

type Result 

type Result struct {

	// Code is the response code, is stored back on the chain.
	Code ABCICodeType

	// Data is any data returned from the app.
	Data []byte

	// Log is just debug information. NOTE: nondeterministic.
	Log string

	// GasWanted is the maximum units of work we allow this tx to perform.
	GasWanted int64

	// GasUsed is the amount of gas actually consumed. NOTE: unimplemented
	GasUsed int64

	// Tx fee amount and denom.
	FeeAmount int64
	FeeDenom  string

	// Tags are used for transaction indexing and pubsub.
	Tags Tags
}

Result is the union of ResponseDeliverTx and ResponseCheckTx.

func (Result) IsOK added in v0.2.0 

func (res Result) IsOK() bool

TODO: In the future, more codes may be OK.

type Store 

type Store interface {
	GetStoreType() StoreType
	CacheWrapper
}

type StoreKey 

type StoreKey interface {
	Name() string
	String() string
}

StoreKey is a key used to index stores in a MultiStore.

type StoreType 

type StoreType int

kind of store 

const (
	//nolint
	StoreTypeMulti StoreType = iota
	StoreTypeDB
	StoreTypeIAVL
	StoreTypeTransient
)

type Tag added in v0.17.0 

type Tag = cmn.KVPair

Type synonym for convenience

func MakeTag added in v0.17.0 

func MakeTag(k string, v []byte) Tag

Make a tag from a key and a value

type Tags added in v0.17.0 

type Tags cmn.KVPairs

Type synonym for convenience

func EmptyTags added in v0.17.0 

func EmptyTags() Tags

New empty tags

func NewTags added in v0.17.0 

func NewTags(tags ...interface{}) Tags

New variadic tags, must be k string, v []byte repeating

func (Tags) AppendTag added in v0.17.0 

func (t Tags) AppendTag(k string, v []byte) Tags

Append a single tag

func (Tags) AppendTags added in v0.17.0 

func (t Tags) AppendTags(tags Tags) Tags

Append two lists of tags

func (Tags) ToKVPairs added in v0.18.0 

func (t Tags) ToKVPairs() []cmn.KVPair

Turn tags into KVPair list

type TestMsg 

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

msg type for testing

func NewTestMsg 

func NewTestMsg(addrs ...AccAddress) *TestMsg

func (*TestMsg) GetSignBytes 

func (msg *TestMsg) GetSignBytes() []byte

func (*TestMsg) GetSigners 

func (msg *TestMsg) GetSigners() []AccAddress

func (*TestMsg) Type 

func (msg *TestMsg) Type() string

nolint

func (*TestMsg) ValidateBasic 

func (msg *TestMsg) ValidateBasic() Error

type TraceContext 

type TraceContext map[string]interface{}

TraceContext contains TraceKVStore context data. It will be written with every trace operation.

type TransientStoreKey 

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

TransientStoreKey is used for indexing transient stores in a MultiStore

func NewTransientStoreKey 

func NewTransientStoreKey(name string) *TransientStoreKey

Constructs new TransientStoreKey Must return a pointer according to the ocap principle

func (*TransientStoreKey) Name added in v0.24.0 

func (key *TransientStoreKey) Name() string

Implements StoreKey

func (*TransientStoreKey) String added in v0.24.0 

func (key *TransientStoreKey) String() string

Implements StoreKey

type Tx 

type Tx interface {

	// Gets the Msg.
	GetMsgs() []Msg
}

Transactions objects must fulfill the Tx

type TxDecoder 

type TxDecoder func(txBytes []byte) (Tx, Error)

TxDecoder unmarshals transaction bytes

type Uint 

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

Int wraps integer with 256 bit range bound Checks overflow, underflow and division by zero Exists in range from 0 to 2^256-1

func MinUint 

func MinUint(i1, i2 Uint) Uint

Return the minimum of the Uints

func NewUint 

func NewUint(n uint64) Uint

NewUint constructs Uint from int64

func NewUintFromBigInt 

func NewUintFromBigInt(i *big.Int) Uint

NewUintFromBigUint constructs Uint from big.Uint

func NewUintFromString 

func NewUintFromString(s string) (res Uint, ok bool)

NewUintFromString constructs Uint from string

func NewUintWithDecimal added in v0.20.0 

func NewUintWithDecimal(n uint64, dec int) Uint

NewUintWithDecimal constructs Uint with decimal Result value is n*10^dec

func OneUint 

func OneUint() Uint

OneUint returns Uint value with one

func ZeroUint 

func ZeroUint() Uint

ZeroUint returns Uint value with zero

func (Uint) Add 

func (i Uint) Add(i2 Uint) (res Uint)

Add adds Uint from another

func (Uint) AddRaw added in v0.20.0 

func (i Uint) AddRaw(i2 uint64) Uint

AddRaw adds uint64 to Uint

func (Uint) BigInt 

func (i Uint) BigInt() *big.Int

BigInt converts Uint to big.Unt

func (Uint) Div added in v0.20.0 

func (i Uint) Div(i2 Uint) (res Uint)

Div divides Uint with Uint

func (Uint) DivRaw added in v0.20.0 

func (i Uint) DivRaw(i2 uint64) Uint

Div divides Uint with uint64

func (Uint) Equal 

func (i Uint) Equal(i2 Uint) bool

Equal compares two Uints

func (Uint) GT 

func (i Uint) GT(i2 Uint) bool

GT returns true if first Uint is greater than second

func (Uint) IsUint64 added in v0.24.0 

func (i Uint) IsUint64() bool

IsUint64 returns true if Uint64() not panics

func (Uint) IsZero 

func (i Uint) IsZero() bool

IsZero returns true if Uint is zero

func (Uint) LT 

func (i Uint) LT(i2 Uint) bool

LT returns true if first Uint is lesser than second

func (Uint) MarshalAmino 

func (i Uint) MarshalAmino() (string, error)

MarshalAmino defines custom encoding scheme

func (Uint) MarshalJSON 

func (i Uint) MarshalJSON() ([]byte, error)

MarshalJSON defines custom encoding scheme

func (Uint) Mod 

func (i Uint) Mod(i2 Uint) Uint

Mod returns remainder after dividing with Uint

func (Uint) ModRaw added in v0.24.0 

func (i Uint) ModRaw(i2 uint64) Uint

ModRaw returns remainder after dividing with uint64

func (Uint) Mul 

func (i Uint) Mul(i2 Uint) (res Uint)

Mul multiples two Uints

func (Uint) MulRaw added in v0.20.0 

func (i Uint) MulRaw(i2 uint64) Uint

MulRaw multipies Uint and uint64

func (Uint) Sign added in v0.20.0 

func (i Uint) Sign() int

Sign returns sign of Uint

func (Uint) String 

func (i Uint) String() string

Human readable string

func (Uint) Sub 

func (i Uint) Sub(i2 Uint) (res Uint)

Sub subtracts Uint from another

func (Uint) SubRaw added in v0.20.0 

func (i Uint) SubRaw(i2 uint64) Uint

SubRaw subtracts uint64 from Uint

func (Uint) Uint64 

func (i Uint) Uint64() uint64

Uint64 converts Uint to uint64 Panics if the value is out of range

func (*Uint) UnmarshalAmino 

func (i *Uint) UnmarshalAmino(text string) error

UnmarshalAmino defines custom decoding scheme

func (*Uint) UnmarshalJSON 

func (i *Uint) UnmarshalJSON(bz []byte) error

UnmarshalJSON defines custom decoding scheme

type ValAddress 

type ValAddress []byte

AccAddress a wrapper around bytes meant to represent a validator address (from over ABCI). When marshaled to a string or json, it uses bech32

func ValAddressFromBech32 

func ValAddressFromBech32(address string) (addr ValAddress, err error)

create a ValAddress from a bech32 string

func ValAddressFromHex 

func ValAddressFromHex(address string) (addr ValAddress, err error)

create a ValAddress from a hex string

func (ValAddress) Bytes 

func (bz ValAddress) Bytes() []byte

Allow it to fulfill various interfaces in light-client, etc...

func (ValAddress) Format 

func (bz ValAddress) Format(s fmt.State, verb rune)

For Printf / Sprintf, returns bech32 when using %s

func (ValAddress) Marshal 

func (bz ValAddress) Marshal() ([]byte, error)

Marshal needed for protobuf compatibility

func (ValAddress) MarshalJSON 

func (bz ValAddress) MarshalJSON() ([]byte, error)

Marshals to JSON using Bech32

func (ValAddress) String 

func (bz ValAddress) String() string

func (*ValAddress) Unmarshal 

func (bz *ValAddress) Unmarshal(data []byte) error

Unmarshal needed for protobuf compatibility

func (*ValAddress) UnmarshalJSON 

func (bz *ValAddress) UnmarshalJSON(data []byte) error

Unmarshals from JSON assuming Bech32 encoding

type Validator added in v0.18.0 

type Validator interface {
	GetRevoked() bool         // whether the validator is revoked
	GetMoniker() string       // moniker of the validator
	GetStatus() BondStatus    // status of the validator
	GetOwner() AccAddress     // owner AccAddress to receive/return validators coins
	GetPubKey() crypto.PubKey // validation pubkey
	GetPower() Rat            // validation power
	GetTokens() Rat           // validation tokens
	GetDelegatorShares() Rat  // Total out standing delegator shares
	GetBondHeight() int64     // height in which the validator became active
}

validator for a delegated proof of stake system

type ValidatorSet added in v0.18.0 

type ValidatorSet interface {
	// iterate through validator by owner-AccAddress, execute func for each validator
	IterateValidators(Context,
		func(index int64, validator Validator) (stop bool))

	// iterate through bonded validator by pubkey-AccAddress, execute func for each validator
	IterateValidatorsBonded(Context,
		func(index int64, validator Validator) (stop bool))

	Validator(Context, AccAddress) Validator            // get a particular validator by owner AccAddress
	ValidatorByPubKey(Context, crypto.PubKey) Validator // get a particular validator by signing PubKey
	TotalPower(Context) Rat                             // total power of the validator set

	// slash the validator and delegators of the validator, specifying offence height, offence power, and slash fraction
	Slash(Context, crypto.PubKey, int64, int64, Rat)
	Revoke(Context, crypto.PubKey)   // revoke a validator
	Unrevoke(Context, crypto.PubKey) // unrevoke a validator
}

properties for the set of all validators

Source Files

View all Source files

Directories

Path Synopsis

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.