types

package
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: May 14, 2020 License: Apache-2.0 Imports: 18 Imported by: 6,431

Documentation

Index

Constants

View Source 
const (
	EventTypeTransfer = "transfer"

	AttributeKeyRecipient = "recipient"
	AttributeKeySender    = "sender"

	AttributeValueCategory = ModuleName
)

bank module event types

View Source 
const (
	// ModuleName defines the module name
	ModuleName = "bank"

	// StoreKey defines the primary module store key
	StoreKey = ModuleName

	// RouterKey defines the module's message routing key
	RouterKey = ModuleName

	// QuerierRoute defines the module's query routing key
	QuerierRoute = ModuleName
)
View Source 
const (
	// DefaultParamspace for params keeper
	DefaultParamspace = ModuleName
	// DefaultSendEnabled enabled
	DefaultSendEnabled = true
)
View Source 
const (
	QueryBalance     = "balance"
	QueryAllBalances = "all_balances"
	QueryTotalSupply = "total_supply"
	QuerySupplyOf    = "supply_of"
)

Querier path constants

Variables

View Source 
var (
	ErrNoInputs            = sdkerrors.Register(ModuleName, 2, "no inputs to send transaction")
	ErrNoOutputs           = sdkerrors.Register(ModuleName, 3, "no outputs to send transaction")
	ErrInputOutputMismatch = sdkerrors.Register(ModuleName, 4, "sum inputs != sum outputs")
	ErrSendDisabled        = sdkerrors.Register(ModuleName, 5, "send transactions are disabled")
)

x/bank module sentinel errors

View Source 
var (
	BalancesPrefix = []byte("balances")
	SupplyKey      = []byte{0x00}
)

KVStore keys

View Source 
var (
	ErrInvalidLengthTypes        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTypes          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupTypes = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (

	// ModuleCdc references the global x/staking module codec. Note, the codec should
	// ONLY be used in certain instances of tests and for JSON encoding as Amino is
	// still used for that purpose.
	//
	// The actual codec used for serialization should be provided to x/staking and
	// defined at the application level.
	ModuleCdc = codec.NewHybridCodec(amino, types.NewInterfaceRegistry())
)
View Source 
var ParamStoreKeySendEnabled = []byte("sendenabled")

ParamStoreKeySendEnabled is store's key for SendEnabled

Functions

func AddressFromBalancesStore 

func AddressFromBalancesStore(key []byte) sdk.AccAddress

AddressFromBalancesStore returns an account address from a balances prefix store. The key must not contain the perfix BalancesPrefix as the prefix store iterator discards the actual prefix.

func ParamKeyTable 

func ParamKeyTable() paramtypes.KeyTable

ParamKeyTable type declaration for parameters

func RegisterCodec 

func RegisterCodec(cdc *codec.Codec)

RegisterCodec registers the necessary x/bank interfaces and concrete types on the provided Amino codec. These types are used for Amino JSON serialization.

func RegisterInterfaces 

func RegisterInterfaces(registry types.InterfaceRegistry)

func ValidateInputsOutputs 

func ValidateInputsOutputs(inputs []Input, outputs []Output) error

ValidateInputsOutputs validates that each respective input and output is valid and that the sum of inputs is equal to the sum of outputs.

Types

type AccountKeeper 

type AccountKeeper interface {
	NewAccount(sdk.Context, exported.Account) exported.Account
	NewAccountWithAddress(ctx sdk.Context, addr sdk.AccAddress) exported.Account

	GetAccount(ctx sdk.Context, addr sdk.AccAddress) exported.Account
	GetAllAccounts(ctx sdk.Context) []exported.Account
	SetAccount(ctx sdk.Context, acc exported.Account)

	IterateAccounts(ctx sdk.Context, process func(exported.Account) bool)

	ValidatePermissions(macc exported.ModuleAccountI) error

	GetModuleAddress(moduleName string) sdk.AccAddress
	GetModuleAddressAndPermissions(moduleName string) (addr sdk.AccAddress, permissions []string)
	GetModuleAccountAndPermissions(ctx sdk.Context, moduleName string) (exported.ModuleAccountI, []string)
	GetModuleAccount(ctx sdk.Context, moduleName string) exported.ModuleAccountI
	SetModuleAccount(ctx sdk.Context, macc exported.ModuleAccountI)
}

AccountKeeper defines the account contract that must be fulfilled when creating a x/bank keeper.

type Balance 

type Balance struct {
	Address sdk.AccAddress `json:"address" yaml:"address"`
	Coins   sdk.Coins      `json:"coins" yaml:"coins"`
}

Balance defines an account address and balance pair used in the bank module's genesis state.

func SanitizeGenesisBalances 

func SanitizeGenesisBalances(balances []Balance) []Balance

SanitizeGenesisAccounts sorts addresses and coin sets.

func (Balance) GetAddress 

func (b Balance) GetAddress() sdk.AccAddress

GetAddress returns the account address of the Balance object.

func (Balance) GetCoins 

func (b Balance) GetCoins() sdk.Coins

GetAddress returns the account coins of the Balance object.

type GenesisBalancesIterator 

type GenesisBalancesIterator struct{}

GenesisAccountIterator implements genesis account iteration.

func (GenesisBalancesIterator) IterateGenesisBalances 

func (GenesisBalancesIterator) IterateGenesisBalances(
	cdc *codec.Codec, appState map[string]json.RawMessage, cb func(exported.GenesisBalance) (stop bool),
)

IterateGenesisAccounts iterates over all the genesis accounts found in appGenesis and invokes a callback on each genesis account. If any call returns true, iteration stops.

type GenesisState 

type GenesisState struct {
	SendEnabled bool      `json:"send_enabled" yaml:"send_enabled"`
	Balances    []Balance `json:"balances" yaml:"balances"`
	Supply      sdk.Coins `json:"supply" yaml:"supply"`
}

GenesisState defines the bank module's genesis state.

func DefaultGenesisState 

func DefaultGenesisState() GenesisState

DefaultGenesisState returns a default bank module genesis state.

func GetGenesisStateFromAppState 

func GetGenesisStateFromAppState(cdc *codec.Codec, appState map[string]json.RawMessage) GenesisState

GetGenesisStateFromAppState returns x/bank GenesisState given raw application genesis state.

func NewGenesisState 

func NewGenesisState(sendEnabled bool, balances []Balance, supply sdk.Coins) GenesisState

NewGenesisState creates a new genesis state.

type Input 

type Input struct {
	Address github_com_cosmos_cosmos_sdk_types.AccAddress `protobuf:"bytes,1,opt,name=address,proto3,casttype=github.com/cosmos/cosmos-sdk/types.AccAddress" json:"address,omitempty"`
	Coins   github_com_cosmos_cosmos_sdk_types.Coins      `protobuf:"bytes,2,rep,name=coins,proto3,castrepeated=github.com/cosmos/cosmos-sdk/types.Coins" json:"coins"`
}

Input models transaction input

func NewInput 

func NewInput(addr sdk.AccAddress, coins sdk.Coins) Input

NewInput - create a transaction input, used with MsgMultiSend

func (*Input) Descriptor 

func (*Input) Descriptor() ([]byte, []int)

func (*Input) Equal 

func (this *Input) Equal(that interface{}) bool

func (*Input) GetAddress 

func (m *Input) GetAddress() github_com_cosmos_cosmos_sdk_types.AccAddress

func (*Input) GetCoins 

func (m *Input) GetCoins() github_com_cosmos_cosmos_sdk_types.Coins

func (*Input) Marshal 

func (m *Input) Marshal() (dAtA []byte, err error)

func (*Input) MarshalTo 

func (m *Input) MarshalTo(dAtA []byte) (int, error)

func (*Input) MarshalToSizedBuffer 

func (m *Input) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Input) ProtoMessage 

func (*Input) ProtoMessage()

func (*Input) Reset 

func (m *Input) Reset()

func (*Input) Size 

func (m *Input) Size() (n int)

func (*Input) String 

func (m *Input) String() string

func (*Input) Unmarshal 

func (m *Input) Unmarshal(dAtA []byte) error

func (Input) ValidateBasic 

func (in Input) ValidateBasic() error

ValidateBasic - validate transaction input

func (*Input) XXX_DiscardUnknown 

func (m *Input) XXX_DiscardUnknown()

func (*Input) XXX_Marshal 

func (m *Input) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Input) XXX_Merge 

func (m *Input) XXX_Merge(src proto.Message)

func (*Input) XXX_Size 

func (m *Input) XXX_Size() int

func (*Input) XXX_Unmarshal 

func (m *Input) XXX_Unmarshal(b []byte) error

type MsgMultiSend 

type MsgMultiSend struct {
	Inputs  []Input  `protobuf:"bytes,1,rep,name=inputs,proto3" json:"inputs"`
	Outputs []Output `protobuf:"bytes,2,rep,name=outputs,proto3" json:"outputs"`
}

MsgMultiSend - high level transaction of the coin module

func NewMsgMultiSend 

func NewMsgMultiSend(in []Input, out []Output) MsgMultiSend

NewMsgMultiSend - construct arbitrary multi-in, multi-out send msg.

func (*MsgMultiSend) Descriptor 

func (*MsgMultiSend) Descriptor() ([]byte, []int)

func (*MsgMultiSend) Equal 

func (this *MsgMultiSend) Equal(that interface{}) bool

func (*MsgMultiSend) GetInputs 

func (m *MsgMultiSend) GetInputs() []Input

func (*MsgMultiSend) GetOutputs 

func (m *MsgMultiSend) GetOutputs() []Output

func (MsgMultiSend) GetSignBytes 

func (msg MsgMultiSend) GetSignBytes() []byte

GetSignBytes Implements Msg.

func (MsgMultiSend) GetSigners 

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

GetSigners Implements Msg.

func (*MsgMultiSend) Marshal 

func (m *MsgMultiSend) Marshal() (dAtA []byte, err error)

func (*MsgMultiSend) MarshalTo 

func (m *MsgMultiSend) MarshalTo(dAtA []byte) (int, error)

func (*MsgMultiSend) MarshalToSizedBuffer 

func (m *MsgMultiSend) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*MsgMultiSend) ProtoMessage 

func (*MsgMultiSend) ProtoMessage()

func (*MsgMultiSend) Reset 

func (m *MsgMultiSend) Reset()

func (MsgMultiSend) Route 

func (msg MsgMultiSend) Route() string

Route Implements Msg

func (*MsgMultiSend) Size 

func (m *MsgMultiSend) Size() (n int)

func (*MsgMultiSend) String 

func (m *MsgMultiSend) String() string

func (MsgMultiSend) Type 

func (msg MsgMultiSend) Type() string

Type Implements Msg

func (*MsgMultiSend) Unmarshal 

func (m *MsgMultiSend) Unmarshal(dAtA []byte) error

func (MsgMultiSend) ValidateBasic 

func (msg MsgMultiSend) ValidateBasic() error

ValidateBasic Implements Msg.

func (*MsgMultiSend) XXX_DiscardUnknown 

func (m *MsgMultiSend) XXX_DiscardUnknown()

func (*MsgMultiSend) XXX_Marshal 

func (m *MsgMultiSend) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MsgMultiSend) XXX_Merge 

func (m *MsgMultiSend) XXX_Merge(src proto.Message)

func (*MsgMultiSend) XXX_Size 

func (m *MsgMultiSend) XXX_Size() int

func (*MsgMultiSend) XXX_Unmarshal 

func (m *MsgMultiSend) XXX_Unmarshal(b []byte) error

type MsgSend 

type MsgSend struct {
	FromAddress github_com_cosmos_cosmos_sdk_types.AccAddress `` /* 169-byte string literal not displayed */
	ToAddress   github_com_cosmos_cosmos_sdk_types.AccAddress `` /* 161-byte string literal not displayed */
	Amount      github_com_cosmos_cosmos_sdk_types.Coins      `protobuf:"bytes,3,rep,name=amount,proto3,castrepeated=github.com/cosmos/cosmos-sdk/types.Coins" json:"amount"`
}

MsgSend - high level transaction of the coin module

func NewMsgSend 

func NewMsgSend(fromAddr, toAddr sdk.AccAddress, amount sdk.Coins) MsgSend

NewMsgSend - construct arbitrary multi-in, multi-out send msg.

func (*MsgSend) Descriptor 

func (*MsgSend) Descriptor() ([]byte, []int)

func (*MsgSend) Equal 

func (this *MsgSend) Equal(that interface{}) bool

func (*MsgSend) GetAmount 

func (m *MsgSend) GetAmount() github_com_cosmos_cosmos_sdk_types.Coins

func (*MsgSend) GetFromAddress 

func (m *MsgSend) GetFromAddress() github_com_cosmos_cosmos_sdk_types.AccAddress

func (MsgSend) GetSignBytes 

func (msg MsgSend) GetSignBytes() []byte

GetSignBytes Implements Msg.

func (MsgSend) GetSigners 

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

GetSigners Implements Msg.

func (*MsgSend) GetToAddress 

func (m *MsgSend) GetToAddress() github_com_cosmos_cosmos_sdk_types.AccAddress

func (*MsgSend) Marshal 

func (m *MsgSend) Marshal() (dAtA []byte, err error)

func (*MsgSend) MarshalTo 

func (m *MsgSend) MarshalTo(dAtA []byte) (int, error)

func (*MsgSend) MarshalToSizedBuffer 

func (m *MsgSend) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*MsgSend) ProtoMessage 

func (*MsgSend) ProtoMessage()

func (*MsgSend) Reset 

func (m *MsgSend) Reset()

func (MsgSend) Route 

func (msg MsgSend) Route() string

Route Implements Msg.

func (*MsgSend) Size 

func (m *MsgSend) Size() (n int)

func (*MsgSend) String 

func (m *MsgSend) String() string

func (MsgSend) Type 

func (msg MsgSend) Type() string

Type Implements Msg.

func (*MsgSend) Unmarshal 

func (m *MsgSend) Unmarshal(dAtA []byte) error

func (MsgSend) ValidateBasic 

func (msg MsgSend) ValidateBasic() error

ValidateBasic Implements Msg.

func (*MsgSend) XXX_DiscardUnknown 

func (m *MsgSend) XXX_DiscardUnknown()

func (*MsgSend) XXX_Marshal 

func (m *MsgSend) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MsgSend) XXX_Merge 

func (m *MsgSend) XXX_Merge(src proto.Message)

func (*MsgSend) XXX_Size 

func (m *MsgSend) XXX_Size() int

func (*MsgSend) XXX_Unmarshal 

func (m *MsgSend) XXX_Unmarshal(b []byte) error

type Output 

type Output struct {
	Address github_com_cosmos_cosmos_sdk_types.AccAddress `protobuf:"bytes,1,opt,name=address,proto3,casttype=github.com/cosmos/cosmos-sdk/types.AccAddress" json:"address,omitempty"`
	Coins   github_com_cosmos_cosmos_sdk_types.Coins      `protobuf:"bytes,2,rep,name=coins,proto3,castrepeated=github.com/cosmos/cosmos-sdk/types.Coins" json:"coins"`
}

Output models transaction outputs

func NewOutput 

func NewOutput(addr sdk.AccAddress, coins sdk.Coins) Output

NewOutput - create a transaction output, used with MsgMultiSend

func (*Output) Descriptor 

func (*Output) Descriptor() ([]byte, []int)

func (*Output) Equal 

func (this *Output) Equal(that interface{}) bool

func (*Output) GetAddress 

func (m *Output) GetAddress() github_com_cosmos_cosmos_sdk_types.AccAddress

func (*Output) GetCoins 

func (m *Output) GetCoins() github_com_cosmos_cosmos_sdk_types.Coins

func (*Output) Marshal 

func (m *Output) Marshal() (dAtA []byte, err error)

func (*Output) MarshalTo 

func (m *Output) MarshalTo(dAtA []byte) (int, error)

func (*Output) MarshalToSizedBuffer 

func (m *Output) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Output) ProtoMessage 

func (*Output) ProtoMessage()

func (*Output) Reset 

func (m *Output) Reset()

func (*Output) Size 

func (m *Output) Size() (n int)

func (*Output) String 

func (m *Output) String() string

func (*Output) Unmarshal 

func (m *Output) Unmarshal(dAtA []byte) error

func (Output) ValidateBasic 

func (out Output) ValidateBasic() error

ValidateBasic - validate transaction output

func (*Output) XXX_DiscardUnknown 

func (m *Output) XXX_DiscardUnknown()

func (*Output) XXX_Marshal 

func (m *Output) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Output) XXX_Merge 

func (m *Output) XXX_Merge(src proto.Message)

func (*Output) XXX_Size 

func (m *Output) XXX_Size() int

func (*Output) XXX_Unmarshal 

func (m *Output) XXX_Unmarshal(b []byte) error

type QueryAllBalancesParams 

type QueryAllBalancesParams struct {
	Address sdk.AccAddress
}

QueryAllBalancesParams defines the params for querying all account balances

func NewQueryAllBalancesParams 

func NewQueryAllBalancesParams(addr sdk.AccAddress) QueryAllBalancesParams

NewQueryAllBalancesParams creates a new instance of QueryAllBalancesParams.

type QueryBalanceParams 

type QueryBalanceParams struct {
	Address sdk.AccAddress
	Denom   string
}

QueryBalanceParams defines the params for querying an account balance.

func NewQueryBalanceParams 

func NewQueryBalanceParams(addr sdk.AccAddress, denom string) QueryBalanceParams

NewQueryBalanceParams creates a new instance of QueryBalanceParams.

type QuerySupplyOfParams 

type QuerySupplyOfParams struct {
	Denom string
}

QuerySupplyOfParams defines the params for the following queries:

- 'custom/bank/totalSupplyOf'

func NewQuerySupplyOfParams 

func NewQuerySupplyOfParams(denom string) QuerySupplyOfParams

NewQuerySupplyOfParams creates a new instance to query the total supply of a given denomination

type QueryTotalSupplyParams 

type QueryTotalSupplyParams struct {
	Page, Limit int
}

QueryTotalSupply defines the params for the following queries:

- 'custom/bank/totalSupply'

func NewQueryTotalSupplyParams 

func NewQueryTotalSupplyParams(page, limit int) QueryTotalSupplyParams

NewQueryTotalSupplyParams creates a new instance to query the total supply

type Supply 

type Supply struct {
	Total github_com_cosmos_cosmos_sdk_types.Coins `protobuf:"bytes,1,rep,name=total,proto3,castrepeated=github.com/cosmos/cosmos-sdk/types.Coins" json:"total"`
}

Supply represents a struct that passively keeps track of the total supply amounts in the network.

func DefaultSupply 

func DefaultSupply() *Supply

DefaultSupply creates an empty Supply

func NewSupply 

func NewSupply(total sdk.Coins) *Supply

NewSupply creates a new Supply instance

func (*Supply) Deflate 

func (supply *Supply) Deflate(amount sdk.Coins)

Deflate subtracts coins from the total supply.

func (*Supply) Descriptor 

func (*Supply) Descriptor() ([]byte, []int)

func (*Supply) Equal 

func (this *Supply) Equal(that interface{}) bool

func (Supply) GetTotal 

func (supply Supply) GetTotal() sdk.Coins

GetTotal returns the supply total.

func (*Supply) Inflate 

func (supply *Supply) Inflate(amount sdk.Coins)

Inflate adds coins to the total supply

func (*Supply) Marshal 

func (m *Supply) Marshal() (dAtA []byte, err error)

func (*Supply) MarshalTo 

func (m *Supply) MarshalTo(dAtA []byte) (int, error)

func (*Supply) MarshalToSizedBuffer 

func (m *Supply) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Supply) ProtoMessage 

func (*Supply) ProtoMessage()

func (*Supply) Reset 

func (m *Supply) Reset()

func (*Supply) SetTotal 

func (supply *Supply) SetTotal(total sdk.Coins)

SetTotal sets the total supply.

func (*Supply) Size 

func (m *Supply) Size() (n int)

func (Supply) String 

func (supply Supply) String() string

String returns a human readable string representation of a supplier.

func (*Supply) Unmarshal 

func (m *Supply) Unmarshal(dAtA []byte) error

func (Supply) ValidateBasic 

func (supply Supply) ValidateBasic() error

ValidateBasic validates the Supply coins and returns error if invalid

func (*Supply) XXX_DiscardUnknown 

func (m *Supply) XXX_DiscardUnknown()

func (*Supply) XXX_Marshal 

func (m *Supply) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Supply) XXX_Merge 

func (m *Supply) XXX_Merge(src proto.Message)

func (*Supply) XXX_Size 

func (m *Supply) XXX_Size() int

func (*Supply) XXX_Unmarshal 

func (m *Supply) XXX_Unmarshal(b []byte) error

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.