ibc

Documentation

Index

• Constants
• func NewOracle(replacer placeholder.Replacer, opts *OracleOptions) (*genny.Generator, error)
• func NewPacket(replacer placeholder.Replacer, opts *PacketOptions) (*genny.Generator, error)
• type OracleOptions
• type PacketOptions

Constants

const (
	Placeholder  = "// this line is used by starport scaffolding # 1"
	Placeholder2 = "// this line is used by starport scaffolding # 2"
	Placeholder3 = "// this line is used by starport scaffolding # 3"

	// Placeholders IBC packets
	PlaceholderIBCPacketProtoField       = "// this line is used by starport scaffolding # ibc/packet/proto/field"
	PlaceholderIBCPacketProtoFieldNumber = "// this line is used by starport scaffolding # ibc/packet/proto/field/number"
	PlaceholderIBCPacketProtoMessage     = "// this line is used by starport scaffolding # ibc/packet/proto/message"
	PlaceholderIBCPacketEvent            = "// this line is used by starport scaffolding # ibc/packet/event"
	PlaceholderIBCPacketModuleRecv       = "// this line is used by starport scaffolding # ibc/packet/module/recv"
	PlaceholderIBCPacketModuleAck        = "// this line is used by starport scaffolding # ibc/packet/module/ack"
	PlaceholderIBCPacketModuleTimeout    = "// this line is used by starport scaffolding # ibc/packet/module/timeout"

	// Placeholders for messages
	PlaceholderProtoTxRPC       = "// this line is used by starport scaffolding # proto/tx/rpc"
	PlaceholderProtoTxMessage   = "// this line is used by starport scaffolding # proto/tx/message"
	PlaceholderHandlerMsgServer = "// this line is used by starport scaffolding # handler/msgServer"

	// Placeholders for Oracle
	PlaceholderProtoPacketImport      = "// this line is used by starport scaffolding # proto/packet/import"
	PlaceholderProtoTxImport          = "// this line is used by starport scaffolding # proto/tx/import"
	PlaceholderOraclePacketModuleRecv = "// this line is used by starport scaffolding # oracle/packet/module/recv"
	PlaceholderOraclePacketModuleAck  = "// this line is used by starport scaffolding # oracle/packet/module/ack"
	PlaceholderOracleModuleRecv       = "// this line is used by starport scaffolding # oracle/module/recv"
	PlaceholderOracleModuleAck        = "// this line is used by starport scaffolding # oracle/module/ack"
)

Functions

func NewOracle

func NewOracle(replacer placeholder.Replacer, opts *OracleOptions) (*genny.Generator, error)

NewOracle returns the generator to scaffold the implementation of the Oracle interface inside a module

func NewPacket

func NewPacket(replacer placeholder.Replacer, opts *PacketOptions) (*genny.Generator, error)

NewPacket returns the generator to scaffold a packet in an IBC module

Types

type OracleOptions

type OracleOptions struct {
	AppName    string
	AppPath    string
	ModuleName string
	ModulePath string
	QueryName  multiformatname.Name
	MsgSigner  multiformatname.Name
}

OracleOptions are options to scaffold an oracle query in a IBC module

type PacketOptions

type PacketOptions struct {
	AppName    string
	AppPath    string
	ModuleName string
	ModulePath string
	PacketName multiformatname.Name
	MsgSigner  multiformatname.Name
	Fields     field.Fields
	AckFields  field.Fields
	NoMessage  bool
}

PacketOptions are options to scaffold a packet in a IBC module