Documentation
¶
Index ¶
- Constants
- Variables
- func KeyPrefix(p string) []byte
- func NewCreateTransferEvent(sender satypes.SubaccountId, recipient satypes.SubaccountId, assetId uint32, ...) sdk.Event
- func NewDepositToSubaccountEvent(sender sdk.Address, recipient satypes.SubaccountId, assetId uint32, ...) sdk.Event
- func NewWithdrawFromSubaccountEvent(sender satypes.SubaccountId, recipient sdk.Address, assetId uint32, ...) sdk.Event
- func RegisterCodec(cdc *codec.LegacyAmino)
- func RegisterInterfaces(registry cdctypes.InterfaceRegistry)
- func RegisterMsgServer(s grpc1.Server, srv MsgServer)
- func RegisterQueryServer(s grpc1.Server, srv QueryServer)
- type AccountKeeper
- type BankKeeper
- type GenesisState
- func (*GenesisState) Descriptor() ([]byte, []int)
- func (m *GenesisState) Marshal() (dAtA []byte, err error)
- func (m *GenesisState) MarshalTo(dAtA []byte) (int, error)
- func (m *GenesisState) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*GenesisState) ProtoMessage()
- func (m *GenesisState) Reset()
- func (m *GenesisState) Size() (n int)
- func (m *GenesisState) String() string
- func (m *GenesisState) Unmarshal(dAtA []byte) error
- func (gs GenesisState) Validate() error
- func (m *GenesisState) XXX_DiscardUnknown()
- func (m *GenesisState) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *GenesisState) XXX_Merge(src proto.Message)
- func (m *GenesisState) XXX_Size() int
- func (m *GenesisState) XXX_Unmarshal(b []byte) error
- type MsgClient
- type MsgCreateTransfer
- func (*MsgCreateTransfer) Descriptor() ([]byte, []int)
- func (msg *MsgCreateTransfer) GetSigners() []sdk.AccAddress
- func (m *MsgCreateTransfer) GetTransfer() *Transfer
- func (m *MsgCreateTransfer) Marshal() (dAtA []byte, err error)
- func (m *MsgCreateTransfer) MarshalTo(dAtA []byte) (int, error)
- func (m *MsgCreateTransfer) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*MsgCreateTransfer) ProtoMessage()
- func (m *MsgCreateTransfer) Reset()
- func (m *MsgCreateTransfer) Size() (n int)
- func (m *MsgCreateTransfer) String() string
- func (m *MsgCreateTransfer) Unmarshal(dAtA []byte) error
- func (msg *MsgCreateTransfer) ValidateBasic() error
- func (m *MsgCreateTransfer) XXX_DiscardUnknown()
- func (m *MsgCreateTransfer) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *MsgCreateTransfer) XXX_Merge(src proto.Message)
- func (m *MsgCreateTransfer) XXX_Size() int
- func (m *MsgCreateTransfer) XXX_Unmarshal(b []byte) error
- type MsgCreateTransferResponse
- func (*MsgCreateTransferResponse) Descriptor() ([]byte, []int)
- func (m *MsgCreateTransferResponse) Marshal() (dAtA []byte, err error)
- func (m *MsgCreateTransferResponse) MarshalTo(dAtA []byte) (int, error)
- func (m *MsgCreateTransferResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*MsgCreateTransferResponse) ProtoMessage()
- func (m *MsgCreateTransferResponse) Reset()
- func (m *MsgCreateTransferResponse) Size() (n int)
- func (m *MsgCreateTransferResponse) String() string
- func (m *MsgCreateTransferResponse) Unmarshal(dAtA []byte) error
- func (m *MsgCreateTransferResponse) XXX_DiscardUnknown()
- func (m *MsgCreateTransferResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *MsgCreateTransferResponse) XXX_Merge(src proto.Message)
- func (m *MsgCreateTransferResponse) XXX_Size() int
- func (m *MsgCreateTransferResponse) XXX_Unmarshal(b []byte) error
- type MsgDepositToSubaccount
- func (*MsgDepositToSubaccount) Descriptor() ([]byte, []int)
- func (m *MsgDepositToSubaccount) GetAssetId() uint32
- func (m *MsgDepositToSubaccount) GetQuantums() uint64
- func (m *MsgDepositToSubaccount) GetRecipient() types.SubaccountId
- func (m *MsgDepositToSubaccount) GetSender() string
- func (msg *MsgDepositToSubaccount) GetSigners() []sdk.AccAddress
- func (m *MsgDepositToSubaccount) Marshal() (dAtA []byte, err error)
- func (m *MsgDepositToSubaccount) MarshalTo(dAtA []byte) (int, error)
- func (m *MsgDepositToSubaccount) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*MsgDepositToSubaccount) ProtoMessage()
- func (m *MsgDepositToSubaccount) Reset()
- func (m *MsgDepositToSubaccount) Size() (n int)
- func (m *MsgDepositToSubaccount) String() string
- func (m *MsgDepositToSubaccount) Unmarshal(dAtA []byte) error
- func (msg *MsgDepositToSubaccount) ValidateBasic() error
- func (m *MsgDepositToSubaccount) XXX_DiscardUnknown()
- func (m *MsgDepositToSubaccount) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *MsgDepositToSubaccount) XXX_Merge(src proto.Message)
- func (m *MsgDepositToSubaccount) XXX_Size() int
- func (m *MsgDepositToSubaccount) XXX_Unmarshal(b []byte) error
- type MsgDepositToSubaccountResponse
- func (*MsgDepositToSubaccountResponse) Descriptor() ([]byte, []int)
- func (m *MsgDepositToSubaccountResponse) Marshal() (dAtA []byte, err error)
- func (m *MsgDepositToSubaccountResponse) MarshalTo(dAtA []byte) (int, error)
- func (m *MsgDepositToSubaccountResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*MsgDepositToSubaccountResponse) ProtoMessage()
- func (m *MsgDepositToSubaccountResponse) Reset()
- func (m *MsgDepositToSubaccountResponse) Size() (n int)
- func (m *MsgDepositToSubaccountResponse) String() string
- func (m *MsgDepositToSubaccountResponse) Unmarshal(dAtA []byte) error
- func (m *MsgDepositToSubaccountResponse) XXX_DiscardUnknown()
- func (m *MsgDepositToSubaccountResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *MsgDepositToSubaccountResponse) XXX_Merge(src proto.Message)
- func (m *MsgDepositToSubaccountResponse) XXX_Size() int
- func (m *MsgDepositToSubaccountResponse) XXX_Unmarshal(b []byte) error
- type MsgServer
- type MsgWithdrawFromSubaccount
- func (*MsgWithdrawFromSubaccount) Descriptor() ([]byte, []int)
- func (m *MsgWithdrawFromSubaccount) GetAssetId() uint32
- func (m *MsgWithdrawFromSubaccount) GetQuantums() uint64
- func (m *MsgWithdrawFromSubaccount) GetRecipient() string
- func (m *MsgWithdrawFromSubaccount) GetSender() types.SubaccountId
- func (msg *MsgWithdrawFromSubaccount) GetSigners() []sdk.AccAddress
- func (m *MsgWithdrawFromSubaccount) Marshal() (dAtA []byte, err error)
- func (m *MsgWithdrawFromSubaccount) MarshalTo(dAtA []byte) (int, error)
- func (m *MsgWithdrawFromSubaccount) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*MsgWithdrawFromSubaccount) ProtoMessage()
- func (m *MsgWithdrawFromSubaccount) Reset()
- func (m *MsgWithdrawFromSubaccount) Size() (n int)
- func (m *MsgWithdrawFromSubaccount) String() string
- func (m *MsgWithdrawFromSubaccount) Unmarshal(dAtA []byte) error
- func (msg *MsgWithdrawFromSubaccount) ValidateBasic() error
- func (m *MsgWithdrawFromSubaccount) XXX_DiscardUnknown()
- func (m *MsgWithdrawFromSubaccount) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *MsgWithdrawFromSubaccount) XXX_Merge(src proto.Message)
- func (m *MsgWithdrawFromSubaccount) XXX_Size() int
- func (m *MsgWithdrawFromSubaccount) XXX_Unmarshal(b []byte) error
- type MsgWithdrawFromSubaccountResponse
- func (*MsgWithdrawFromSubaccountResponse) Descriptor() ([]byte, []int)
- func (m *MsgWithdrawFromSubaccountResponse) Marshal() (dAtA []byte, err error)
- func (m *MsgWithdrawFromSubaccountResponse) MarshalTo(dAtA []byte) (int, error)
- func (m *MsgWithdrawFromSubaccountResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*MsgWithdrawFromSubaccountResponse) ProtoMessage()
- func (m *MsgWithdrawFromSubaccountResponse) Reset()
- func (m *MsgWithdrawFromSubaccountResponse) Size() (n int)
- func (m *MsgWithdrawFromSubaccountResponse) String() string
- func (m *MsgWithdrawFromSubaccountResponse) Unmarshal(dAtA []byte) error
- func (m *MsgWithdrawFromSubaccountResponse) XXX_DiscardUnknown()
- func (m *MsgWithdrawFromSubaccountResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *MsgWithdrawFromSubaccountResponse) XXX_Merge(src proto.Message)
- func (m *MsgWithdrawFromSubaccountResponse) XXX_Size() int
- func (m *MsgWithdrawFromSubaccountResponse) XXX_Unmarshal(b []byte) error
- type QueryClient
- type QueryServer
- type SendingKeeper
- type SubaccountsKeeper
- type Transfer
- func (*Transfer) Descriptor() ([]byte, []int)
- func (m *Transfer) GetAmount() uint64
- func (m *Transfer) GetAssetId() uint32
- func (t *Transfer) GetBigQuantums() (bigNotional *big.Int)
- func (m *Transfer) GetRecipient() types.SubaccountId
- func (t *Transfer) GetRecipientSubaccountUpdate() (update types.Update)
- func (m *Transfer) GetSender() types.SubaccountId
- func (t *Transfer) GetSenderSubaccountUpdate() (update types.Update)
- func (m *Transfer) Marshal() (dAtA []byte, err error)
- func (m *Transfer) MarshalTo(dAtA []byte) (int, error)
- func (m *Transfer) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*Transfer) ProtoMessage()
- func (m *Transfer) Reset()
- func (m *Transfer) Size() (n int)
- func (m *Transfer) String() string
- func (m *Transfer) Unmarshal(dAtA []byte) error
- func (m *Transfer) XXX_DiscardUnknown()
- func (m *Transfer) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Transfer) XXX_Merge(src proto.Message)
- func (m *Transfer) XXX_Size() int
- func (m *Transfer) XXX_Unmarshal(b []byte) error
- type UnimplementedMsgServer
- func (*UnimplementedMsgServer) CreateTransfer(ctx context.Context, req *MsgCreateTransfer) (*MsgCreateTransferResponse, error)
- func (*UnimplementedMsgServer) DepositToSubaccount(ctx context.Context, req *MsgDepositToSubaccount) (*MsgDepositToSubaccountResponse, error)
- func (*UnimplementedMsgServer) WithdrawFromSubaccount(ctx context.Context, req *MsgWithdrawFromSubaccount) (*MsgWithdrawFromSubaccountResponse, error)
- type UnimplementedQueryServer
Constants ¶
const ( EventTypeCreateTransfer = "create_transfer" EventTypeDepositToSubaccount = "deposit_to_subaccount" EventTypeWithdrawFromSubaccount = "withdraw_from_subaccount" AttributeKeySender = "sender" AttributeKeySenderNumber = "sender_number" AttributeKeyRecipient = "recipient" AttributeKeyRecipientNumber = "recipient_number" AttributeKeyQuantums = "quantums" AttributeKeyAssetId = "asset_id" )
sending module event types
const ( // TransferToGoodTilBlockKeyPrefix is the prefix to retrieve all transfer hash to `GoodTilBlock` mappings. TransferToGoodTilBlockKeyPrefix = "TransferToGoodTilBlock/value/" // BlockExpirationForTransfersKeyPrefix is the prefix to retrieve all expiring transfers given a block height. BlockExpirationForTransfersKeyPrefix = "BlockExpirationForTransfers/value/" )
const ( // ModuleName defines the module name ModuleName = "sending" // StoreKey defines the primary module store key StoreKey = ModuleName )
Variables ¶
var ( Amino = codec.NewLegacyAmino() ModuleCdc = codec.NewProtoCodec(cdctypes.NewInterfaceRegistry()) )
var ( ErrSenderSameAsRecipient = sdkerrors.Register(ModuleName, 1, "Sender is the same as recipient") ErrInvalidTransferAmount = sdkerrors.Register(ModuleName, 2, "Invalid transfer amount") ErrDuplicatedTransfer = sdkerrors.Register(ModuleName, 3, "Duplicated transfer") ErrTransferNotFound = sdkerrors.Register(ModuleName, 4, "Transfer not found") ErrMissingFields = sdkerrors.Register(ModuleName, 5, "Transfer does not contain all required fields") ErrInvalidAccountAddress = sdkerrors.Register(ModuleName, 6, "Account address is invalid") ErrKeeperMethodsNotImplemented = sdkerrors.Register( ModuleName, 1100, "Sending module keeper method not implemented", ) ErrNonUsdcAssetTransferNotImplemented = sdkerrors.Register( ModuleName, 1101, "Non-USDC asset transfer not implemented", ) )
x/sending module sentinel errors
var ( ErrInvalidLengthGenesis = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowGenesis = fmt.Errorf("proto: integer overflow") ErrUnexpectedEndOfGroupGenesis = fmt.Errorf("proto: unexpected end of group") )
Functions ¶
func NewCreateTransferEvent ¶
func NewCreateTransferEvent( sender satypes.SubaccountId, recipient satypes.SubaccountId, assetId uint32, quantums uint64, ) sdk.Event
NewCreateTransferEvent constructs a new create_transfer sdk.Event
func NewDepositToSubaccountEvent ¶
func NewDepositToSubaccountEvent( sender sdk.Address, recipient satypes.SubaccountId, assetId uint32, quantums uint64, ) sdk.Event
NewDepositToSubaccountEvent a new deposit_to_subaccount sdk.Event
func NewWithdrawFromSubaccountEvent ¶
func NewWithdrawFromSubaccountEvent( sender satypes.SubaccountId, recipient sdk.Address, assetId uint32, quantums uint64, ) sdk.Event
NewWithdrawFromSubaccount constructs a new withdraw_from_subaccount sdk.Event
func RegisterCodec ¶
func RegisterCodec(cdc *codec.LegacyAmino)
func RegisterInterfaces ¶
func RegisterInterfaces(registry cdctypes.InterfaceRegistry)
func RegisterMsgServer ¶
func RegisterQueryServer ¶
func RegisterQueryServer(s grpc1.Server, srv QueryServer)
Types ¶
type AccountKeeper ¶
type AccountKeeper interface {
GetAccount(ctx sdk.Context, addr sdk.AccAddress) types.AccountI
HasAccount(ctx sdk.Context, addr sdk.AccAddress) bool
SetAccount(ctx sdk.Context, acc types.AccountI)
NewAccountWithAddress(ctx sdk.Context, addr sdk.AccAddress) types.AccountI
}
AccountKeeper defines the expected account keeper used for simulations.
type BankKeeper ¶
BankKeeper defines the expected bank keeper used for simulations.
type GenesisState ¶
type GenesisState struct {
}
GenesisState defines the sending module's genesis state.
func DefaultGenesis ¶
func DefaultGenesis() *GenesisState
DefaultGenesis returns the default Sending genesis state
func (*GenesisState) Descriptor ¶
func (*GenesisState) Descriptor() ([]byte, []int)
func (*GenesisState) Marshal ¶
func (m *GenesisState) Marshal() (dAtA []byte, err error)
func (*GenesisState) MarshalToSizedBuffer ¶
func (m *GenesisState) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*GenesisState) ProtoMessage ¶
func (*GenesisState) ProtoMessage()
func (*GenesisState) Reset ¶
func (m *GenesisState) Reset()
func (*GenesisState) Size ¶
func (m *GenesisState) Size() (n int)
func (*GenesisState) String ¶
func (m *GenesisState) String() string
func (*GenesisState) Unmarshal ¶
func (m *GenesisState) Unmarshal(dAtA []byte) error
func (GenesisState) Validate ¶
func (gs GenesisState) Validate() error
Validate performs basic genesis state validation returning an error upon any failure.
func (*GenesisState) XXX_DiscardUnknown ¶
func (m *GenesisState) XXX_DiscardUnknown()
func (*GenesisState) XXX_Marshal ¶
func (m *GenesisState) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*GenesisState) XXX_Merge ¶
func (m *GenesisState) XXX_Merge(src proto.Message)
func (*GenesisState) XXX_Size ¶
func (m *GenesisState) XXX_Size() int
func (*GenesisState) XXX_Unmarshal ¶
func (m *GenesisState) XXX_Unmarshal(b []byte) error
type MsgClient ¶
type MsgClient interface {
// CreateTransfer initiates a new transfer between subaccounts.
CreateTransfer(ctx context.Context, in *MsgCreateTransfer, opts ...grpc.CallOption) (*MsgCreateTransferResponse, error)
// DepositToSubaccount initiates a new transfer from an `x/bank` account
// to an `x/subaccounts` subaccount.
DepositToSubaccount(ctx context.Context, in *MsgDepositToSubaccount, opts ...grpc.CallOption) (*MsgDepositToSubaccountResponse, error)
// WithdrawFromSubaccount initiates a new transfer from an `x/subaccounts`
// subaccount to an `x/bank` account.
WithdrawFromSubaccount(ctx context.Context, in *MsgWithdrawFromSubaccount, opts ...grpc.CallOption) (*MsgWithdrawFromSubaccountResponse, error)
}
MsgClient is the client API for Msg service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewMsgClient ¶
func NewMsgClient(cc grpc1.ClientConn) MsgClient
type MsgCreateTransfer ¶
type MsgCreateTransfer struct {
Transfer *Transfer `protobuf:"bytes,1,opt,name=transfer,proto3" json:"transfer,omitempty"`
}
MsgCreateTransfer is a request type used for initiating new transfers.
func NewMsgCreateTransfer ¶
func NewMsgCreateTransfer(transfer *Transfer) *MsgCreateTransfer
func (*MsgCreateTransfer) Descriptor ¶
func (*MsgCreateTransfer) Descriptor() ([]byte, []int)
func (*MsgCreateTransfer) GetSigners ¶
func (msg *MsgCreateTransfer) GetSigners() []sdk.AccAddress
func (*MsgCreateTransfer) GetTransfer ¶
func (m *MsgCreateTransfer) GetTransfer() *Transfer
func (*MsgCreateTransfer) Marshal ¶
func (m *MsgCreateTransfer) Marshal() (dAtA []byte, err error)
func (*MsgCreateTransfer) MarshalTo ¶
func (m *MsgCreateTransfer) MarshalTo(dAtA []byte) (int, error)
func (*MsgCreateTransfer) MarshalToSizedBuffer ¶
func (m *MsgCreateTransfer) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*MsgCreateTransfer) ProtoMessage ¶
func (*MsgCreateTransfer) ProtoMessage()
func (*MsgCreateTransfer) Reset ¶
func (m *MsgCreateTransfer) Reset()
func (*MsgCreateTransfer) Size ¶
func (m *MsgCreateTransfer) Size() (n int)
func (*MsgCreateTransfer) String ¶
func (m *MsgCreateTransfer) String() string
func (*MsgCreateTransfer) Unmarshal ¶
func (m *MsgCreateTransfer) Unmarshal(dAtA []byte) error
func (*MsgCreateTransfer) ValidateBasic ¶
func (msg *MsgCreateTransfer) ValidateBasic() error
func (*MsgCreateTransfer) XXX_DiscardUnknown ¶
func (m *MsgCreateTransfer) XXX_DiscardUnknown()
func (*MsgCreateTransfer) XXX_Marshal ¶
func (m *MsgCreateTransfer) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*MsgCreateTransfer) XXX_Merge ¶
func (m *MsgCreateTransfer) XXX_Merge(src proto.Message)
func (*MsgCreateTransfer) XXX_Size ¶
func (m *MsgCreateTransfer) XXX_Size() int
func (*MsgCreateTransfer) XXX_Unmarshal ¶
func (m *MsgCreateTransfer) XXX_Unmarshal(b []byte) error
type MsgCreateTransferResponse ¶
type MsgCreateTransferResponse struct {
}
MsgCreateTransferResponse is a response type used for new transfers.
func (*MsgCreateTransferResponse) Descriptor ¶
func (*MsgCreateTransferResponse) Descriptor() ([]byte, []int)
func (*MsgCreateTransferResponse) Marshal ¶
func (m *MsgCreateTransferResponse) Marshal() (dAtA []byte, err error)
func (*MsgCreateTransferResponse) MarshalTo ¶
func (m *MsgCreateTransferResponse) MarshalTo(dAtA []byte) (int, error)
func (*MsgCreateTransferResponse) MarshalToSizedBuffer ¶
func (m *MsgCreateTransferResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*MsgCreateTransferResponse) ProtoMessage ¶
func (*MsgCreateTransferResponse) ProtoMessage()
func (*MsgCreateTransferResponse) Reset ¶
func (m *MsgCreateTransferResponse) Reset()
func (*MsgCreateTransferResponse) Size ¶
func (m *MsgCreateTransferResponse) Size() (n int)
func (*MsgCreateTransferResponse) String ¶
func (m *MsgCreateTransferResponse) String() string
func (*MsgCreateTransferResponse) Unmarshal ¶
func (m *MsgCreateTransferResponse) Unmarshal(dAtA []byte) error
func (*MsgCreateTransferResponse) XXX_DiscardUnknown ¶
func (m *MsgCreateTransferResponse) XXX_DiscardUnknown()
func (*MsgCreateTransferResponse) XXX_Marshal ¶
func (m *MsgCreateTransferResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*MsgCreateTransferResponse) XXX_Merge ¶
func (m *MsgCreateTransferResponse) XXX_Merge(src proto.Message)
func (*MsgCreateTransferResponse) XXX_Size ¶
func (m *MsgCreateTransferResponse) XXX_Size() int
func (*MsgCreateTransferResponse) XXX_Unmarshal ¶
func (m *MsgCreateTransferResponse) XXX_Unmarshal(b []byte) error
type MsgDepositToSubaccount ¶
type MsgDepositToSubaccount struct {
// The sender wallet address.
Sender string `protobuf:"bytes,1,opt,name=sender,proto3" json:"sender,omitempty"`
// The recipient subaccount ID.
Recipient types.SubaccountId `protobuf:"bytes,2,opt,name=recipient,proto3" json:"recipient"`
// Id of the asset to transfer.
AssetId uint32 `protobuf:"varint,3,opt,name=asset_id,json=assetId,proto3" json:"asset_id,omitempty"`
// The number of quantums of asset to transfer.
Quantums uint64 `protobuf:"varint,4,opt,name=quantums,proto3" json:"quantums,omitempty"`
}
MsgDepositToSubaccount represents a single transfer from an `x/bank` account to an `x/subaccounts` subaccount.
func NewMsgDepositToSubaccount ¶
func NewMsgDepositToSubaccount( sender string, recipient satypes.SubaccountId, assetId uint32, quantums uint64, ) *MsgDepositToSubaccount
NewMsgDepositToSubaccount constructs a `MsgDepositToSubaccount` from an `x/bank` account sender, an `x/subaccounts` subaccount sender, an asset ID, and a number of quantums.
func (*MsgDepositToSubaccount) Descriptor ¶
func (*MsgDepositToSubaccount) Descriptor() ([]byte, []int)
func (*MsgDepositToSubaccount) GetAssetId ¶
func (m *MsgDepositToSubaccount) GetAssetId() uint32
func (*MsgDepositToSubaccount) GetQuantums ¶
func (m *MsgDepositToSubaccount) GetQuantums() uint64
func (*MsgDepositToSubaccount) GetRecipient ¶
func (m *MsgDepositToSubaccount) GetRecipient() types.SubaccountId
func (*MsgDepositToSubaccount) GetSender ¶
func (m *MsgDepositToSubaccount) GetSender() string
func (*MsgDepositToSubaccount) GetSigners ¶
func (msg *MsgDepositToSubaccount) GetSigners() []sdk.AccAddress
GetSigners specifies that the sender of the message must sign.
func (*MsgDepositToSubaccount) Marshal ¶
func (m *MsgDepositToSubaccount) Marshal() (dAtA []byte, err error)
func (*MsgDepositToSubaccount) MarshalTo ¶
func (m *MsgDepositToSubaccount) MarshalTo(dAtA []byte) (int, error)
func (*MsgDepositToSubaccount) MarshalToSizedBuffer ¶
func (m *MsgDepositToSubaccount) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*MsgDepositToSubaccount) ProtoMessage ¶
func (*MsgDepositToSubaccount) ProtoMessage()
func (*MsgDepositToSubaccount) Reset ¶
func (m *MsgDepositToSubaccount) Reset()
func (*MsgDepositToSubaccount) Size ¶
func (m *MsgDepositToSubaccount) Size() (n int)
func (*MsgDepositToSubaccount) String ¶
func (m *MsgDepositToSubaccount) String() string
func (*MsgDepositToSubaccount) Unmarshal ¶
func (m *MsgDepositToSubaccount) Unmarshal(dAtA []byte) error
func (*MsgDepositToSubaccount) ValidateBasic ¶
func (msg *MsgDepositToSubaccount) ValidateBasic() error
ValidateBasic runs validation on the fields of a MsgDepositToSubaccount.
func (*MsgDepositToSubaccount) XXX_DiscardUnknown ¶
func (m *MsgDepositToSubaccount) XXX_DiscardUnknown()
func (*MsgDepositToSubaccount) XXX_Marshal ¶
func (m *MsgDepositToSubaccount) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*MsgDepositToSubaccount) XXX_Merge ¶
func (m *MsgDepositToSubaccount) XXX_Merge(src proto.Message)
func (*MsgDepositToSubaccount) XXX_Size ¶
func (m *MsgDepositToSubaccount) XXX_Size() int
func (*MsgDepositToSubaccount) XXX_Unmarshal ¶
func (m *MsgDepositToSubaccount) XXX_Unmarshal(b []byte) error
type MsgDepositToSubaccountResponse ¶
type MsgDepositToSubaccountResponse struct {
}
MsgDepositToSubaccountResponse is a response type used for new account-to-subaccount transfers.
func (*MsgDepositToSubaccountResponse) Descriptor ¶
func (*MsgDepositToSubaccountResponse) Descriptor() ([]byte, []int)
func (*MsgDepositToSubaccountResponse) Marshal ¶
func (m *MsgDepositToSubaccountResponse) Marshal() (dAtA []byte, err error)
func (*MsgDepositToSubaccountResponse) MarshalTo ¶
func (m *MsgDepositToSubaccountResponse) MarshalTo(dAtA []byte) (int, error)
func (*MsgDepositToSubaccountResponse) MarshalToSizedBuffer ¶
func (m *MsgDepositToSubaccountResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*MsgDepositToSubaccountResponse) ProtoMessage ¶
func (*MsgDepositToSubaccountResponse) ProtoMessage()
func (*MsgDepositToSubaccountResponse) Reset ¶
func (m *MsgDepositToSubaccountResponse) Reset()
func (*MsgDepositToSubaccountResponse) Size ¶
func (m *MsgDepositToSubaccountResponse) Size() (n int)
func (*MsgDepositToSubaccountResponse) String ¶
func (m *MsgDepositToSubaccountResponse) String() string
func (*MsgDepositToSubaccountResponse) Unmarshal ¶
func (m *MsgDepositToSubaccountResponse) Unmarshal(dAtA []byte) error
func (*MsgDepositToSubaccountResponse) XXX_DiscardUnknown ¶
func (m *MsgDepositToSubaccountResponse) XXX_DiscardUnknown()
func (*MsgDepositToSubaccountResponse) XXX_Marshal ¶
func (m *MsgDepositToSubaccountResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*MsgDepositToSubaccountResponse) XXX_Merge ¶
func (m *MsgDepositToSubaccountResponse) XXX_Merge(src proto.Message)
func (*MsgDepositToSubaccountResponse) XXX_Size ¶
func (m *MsgDepositToSubaccountResponse) XXX_Size() int
func (*MsgDepositToSubaccountResponse) XXX_Unmarshal ¶
func (m *MsgDepositToSubaccountResponse) XXX_Unmarshal(b []byte) error
type MsgServer ¶
type MsgServer interface {
// CreateTransfer initiates a new transfer between subaccounts.
CreateTransfer(context.Context, *MsgCreateTransfer) (*MsgCreateTransferResponse, error)
// DepositToSubaccount initiates a new transfer from an `x/bank` account
// to an `x/subaccounts` subaccount.
DepositToSubaccount(context.Context, *MsgDepositToSubaccount) (*MsgDepositToSubaccountResponse, error)
// WithdrawFromSubaccount initiates a new transfer from an `x/subaccounts`
// subaccount to an `x/bank` account.
WithdrawFromSubaccount(context.Context, *MsgWithdrawFromSubaccount) (*MsgWithdrawFromSubaccountResponse, error)
}
MsgServer is the server API for Msg service.
type MsgWithdrawFromSubaccount ¶
type MsgWithdrawFromSubaccount struct {
// The sender subaccount ID.
Sender types.SubaccountId `protobuf:"bytes,2,opt,name=sender,proto3" json:"sender"`
// The recipient wallet address.
Recipient string `protobuf:"bytes,1,opt,name=recipient,proto3" json:"recipient,omitempty"`
// Id of the asset to transfer.
AssetId uint32 `protobuf:"varint,3,opt,name=asset_id,json=assetId,proto3" json:"asset_id,omitempty"`
// The number of quantums of asset to transfer.
Quantums uint64 `protobuf:"varint,4,opt,name=quantums,proto3" json:"quantums,omitempty"`
}
MsgWithdrawFromSubaccount represents a single transfer from an `x/subaccounts` subaccount to an `x/bank` account.
func NewMsgWithdrawFromSubaccount ¶
func NewMsgWithdrawFromSubaccount( sender satypes.SubaccountId, recipient string, assetId uint32, quantums uint64, ) *MsgWithdrawFromSubaccount
NewMsgWithdrawFromSubaccount constructs a `MsgWithdrawFromSubaccount` from an `x/subaccounts` subaccount sender, an `x/bank` account recipient, an asset ID, and a number of quantums.
func (*MsgWithdrawFromSubaccount) Descriptor ¶
func (*MsgWithdrawFromSubaccount) Descriptor() ([]byte, []int)
func (*MsgWithdrawFromSubaccount) GetAssetId ¶
func (m *MsgWithdrawFromSubaccount) GetAssetId() uint32
func (*MsgWithdrawFromSubaccount) GetQuantums ¶
func (m *MsgWithdrawFromSubaccount) GetQuantums() uint64
func (*MsgWithdrawFromSubaccount) GetRecipient ¶
func (m *MsgWithdrawFromSubaccount) GetRecipient() string
func (*MsgWithdrawFromSubaccount) GetSender ¶
func (m *MsgWithdrawFromSubaccount) GetSender() types.SubaccountId
func (*MsgWithdrawFromSubaccount) GetSigners ¶
func (msg *MsgWithdrawFromSubaccount) GetSigners() []sdk.AccAddress
GetSigners specifies that the sender of the message must sign.
func (*MsgWithdrawFromSubaccount) Marshal ¶
func (m *MsgWithdrawFromSubaccount) Marshal() (dAtA []byte, err error)
func (*MsgWithdrawFromSubaccount) MarshalTo ¶
func (m *MsgWithdrawFromSubaccount) MarshalTo(dAtA []byte) (int, error)
func (*MsgWithdrawFromSubaccount) MarshalToSizedBuffer ¶
func (m *MsgWithdrawFromSubaccount) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*MsgWithdrawFromSubaccount) ProtoMessage ¶
func (*MsgWithdrawFromSubaccount) ProtoMessage()
func (*MsgWithdrawFromSubaccount) Reset ¶
func (m *MsgWithdrawFromSubaccount) Reset()
func (*MsgWithdrawFromSubaccount) Size ¶
func (m *MsgWithdrawFromSubaccount) Size() (n int)
func (*MsgWithdrawFromSubaccount) String ¶
func (m *MsgWithdrawFromSubaccount) String() string
func (*MsgWithdrawFromSubaccount) Unmarshal ¶
func (m *MsgWithdrawFromSubaccount) Unmarshal(dAtA []byte) error
func (*MsgWithdrawFromSubaccount) ValidateBasic ¶
func (msg *MsgWithdrawFromSubaccount) ValidateBasic() error
ValidateBasic runs validation on the fields of a MsgWithdrawFromSubaccount.
func (*MsgWithdrawFromSubaccount) XXX_DiscardUnknown ¶
func (m *MsgWithdrawFromSubaccount) XXX_DiscardUnknown()
func (*MsgWithdrawFromSubaccount) XXX_Marshal ¶
func (m *MsgWithdrawFromSubaccount) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*MsgWithdrawFromSubaccount) XXX_Merge ¶
func (m *MsgWithdrawFromSubaccount) XXX_Merge(src proto.Message)
func (*MsgWithdrawFromSubaccount) XXX_Size ¶
func (m *MsgWithdrawFromSubaccount) XXX_Size() int
func (*MsgWithdrawFromSubaccount) XXX_Unmarshal ¶
func (m *MsgWithdrawFromSubaccount) XXX_Unmarshal(b []byte) error
type MsgWithdrawFromSubaccountResponse ¶
type MsgWithdrawFromSubaccountResponse struct {
}
MsgWithdrawFromSubaccountResponse is a response type used for new subaccount-to-account transfers.
func (*MsgWithdrawFromSubaccountResponse) Descriptor ¶
func (*MsgWithdrawFromSubaccountResponse) Descriptor() ([]byte, []int)
func (*MsgWithdrawFromSubaccountResponse) Marshal ¶
func (m *MsgWithdrawFromSubaccountResponse) Marshal() (dAtA []byte, err error)
func (*MsgWithdrawFromSubaccountResponse) MarshalTo ¶
func (m *MsgWithdrawFromSubaccountResponse) MarshalTo(dAtA []byte) (int, error)
func (*MsgWithdrawFromSubaccountResponse) MarshalToSizedBuffer ¶
func (m *MsgWithdrawFromSubaccountResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*MsgWithdrawFromSubaccountResponse) ProtoMessage ¶
func (*MsgWithdrawFromSubaccountResponse) ProtoMessage()
func (*MsgWithdrawFromSubaccountResponse) Reset ¶
func (m *MsgWithdrawFromSubaccountResponse) Reset()
func (*MsgWithdrawFromSubaccountResponse) Size ¶
func (m *MsgWithdrawFromSubaccountResponse) Size() (n int)
func (*MsgWithdrawFromSubaccountResponse) String ¶
func (m *MsgWithdrawFromSubaccountResponse) String() string
func (*MsgWithdrawFromSubaccountResponse) Unmarshal ¶
func (m *MsgWithdrawFromSubaccountResponse) Unmarshal(dAtA []byte) error
func (*MsgWithdrawFromSubaccountResponse) XXX_DiscardUnknown ¶
func (m *MsgWithdrawFromSubaccountResponse) XXX_DiscardUnknown()
func (*MsgWithdrawFromSubaccountResponse) XXX_Marshal ¶
func (m *MsgWithdrawFromSubaccountResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*MsgWithdrawFromSubaccountResponse) XXX_Merge ¶
func (m *MsgWithdrawFromSubaccountResponse) XXX_Merge(src proto.Message)
func (*MsgWithdrawFromSubaccountResponse) XXX_Size ¶
func (m *MsgWithdrawFromSubaccountResponse) XXX_Size() int
func (*MsgWithdrawFromSubaccountResponse) XXX_Unmarshal ¶
func (m *MsgWithdrawFromSubaccountResponse) XXX_Unmarshal(b []byte) error
type QueryClient ¶
type QueryClient interface {
}
QueryClient is the client API for Query service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewQueryClient ¶
func NewQueryClient(cc grpc1.ClientConn) QueryClient
type SendingKeeper ¶
type SendingKeeper interface {
ProcessTransfer(ctx sdk.Context, transfer *Transfer) error
ProcessDepositToSubaccount(
ctx sdk.Context,
msgDepositToSubaccount *MsgDepositToSubaccount,
) error
ProcessWithdrawFromSubaccount(
ctx sdk.Context,
msgWithdrawFromSubaccount *MsgWithdrawFromSubaccount,
) error
}
type SubaccountsKeeper ¶
type SubaccountsKeeper interface {
GetAllSubaccount(ctx sdk.Context) (list []satypes.Subaccount)
GetRandomSubaccount(ctx sdk.Context, rand *rand.Rand) (satypes.Subaccount, error)
GetNetCollateralAndMarginRequirements(
ctx sdk.Context,
update satypes.Update,
) (
bigNetCollateral *big.Int,
bigInitialMargin *big.Int,
bigMaintenanceMargin *big.Int,
err error,
)
CanUpdateSubaccounts(
ctx sdk.Context,
updates []satypes.Update,
) (
success bool,
successPerUpdate []satypes.UpdateResult,
err error,
)
UpdateSubaccounts(
ctx sdk.Context,
updates []satypes.Update,
) (
success bool,
successPerUpdate []satypes.UpdateResult,
err error,
)
DepositFundsFromAccountToSubaccount(
ctx sdk.Context,
fromAccount sdk.AccAddress,
toSubaccountId satypes.SubaccountId,
assetId uint32,
amount *big.Int,
) (err error)
WithdrawFundsFromSubaccountToAccount(
ctx sdk.Context,
fromSubaccountId satypes.SubaccountId,
toAccount sdk.AccAddress,
assetId uint32,
amount *big.Int,
) (err error)
SetSubaccount(ctx sdk.Context, subaccount satypes.Subaccount)
GetSubaccount(
ctx sdk.Context,
id satypes.SubaccountId,
) (val satypes.Subaccount)
}
type Transfer ¶
type Transfer struct {
// The sender subaccount ID.
Sender types.SubaccountId `protobuf:"bytes,1,opt,name=sender,proto3" json:"sender"`
// The recipient subaccount ID.
Recipient types.SubaccountId `protobuf:"bytes,2,opt,name=recipient,proto3" json:"recipient"`
// Id of the asset to transfer.
AssetId uint32 `protobuf:"varint,3,opt,name=asset_id,json=assetId,proto3" json:"asset_id,omitempty"`
// The amount of asset to transfer
Amount uint64 `protobuf:"varint,4,opt,name=amount,proto3" json:"amount,omitempty"`
}
Transfer represents a single transfer between two subaccounts.
func (*Transfer) Descriptor ¶
func (*Transfer) GetAssetId ¶
func (*Transfer) GetBigQuantums ¶
GetBigQuantums returns the amount of the transfer in big notional. Currently only supports quote balance update.
func (*Transfer) GetRecipient ¶
func (m *Transfer) GetRecipient() types.SubaccountId
func (*Transfer) GetRecipientSubaccountUpdate ¶
GetRecipientSubaccountUpdate returns the recipient subaccount update for this transfer. Currently only supports quote balance update.
func (*Transfer) GetSender ¶
func (m *Transfer) GetSender() types.SubaccountId
func (*Transfer) GetSenderSubaccountUpdate ¶
GetSenderSubaccountUpdate returns the sender subaccount update for this transfer. Currently only supports quote balance update.
func (*Transfer) MarshalToSizedBuffer ¶
func (*Transfer) ProtoMessage ¶
func (*Transfer) ProtoMessage()
func (*Transfer) XXX_DiscardUnknown ¶
func (m *Transfer) XXX_DiscardUnknown()
func (*Transfer) XXX_Marshal ¶
func (*Transfer) XXX_Unmarshal ¶
type UnimplementedMsgServer ¶
type UnimplementedMsgServer struct {
}
UnimplementedMsgServer can be embedded to have forward compatible implementations.
func (*UnimplementedMsgServer) CreateTransfer ¶
func (*UnimplementedMsgServer) CreateTransfer(ctx context.Context, req *MsgCreateTransfer) (*MsgCreateTransferResponse, error)
func (*UnimplementedMsgServer) DepositToSubaccount ¶
func (*UnimplementedMsgServer) DepositToSubaccount(ctx context.Context, req *MsgDepositToSubaccount) (*MsgDepositToSubaccountResponse, error)
func (*UnimplementedMsgServer) WithdrawFromSubaccount ¶
func (*UnimplementedMsgServer) WithdrawFromSubaccount(ctx context.Context, req *MsgWithdrawFromSubaccount) (*MsgWithdrawFromSubaccountResponse, error)
type UnimplementedQueryServer ¶
type UnimplementedQueryServer struct {
}
UnimplementedQueryServer can be embedded to have forward compatible implementations.