electrum

Documentation

Index

• Constants
• Variables
• type GetClaimsInTxResp
• type Node
  • func NewNode() *Node
  • func (n *Node) Connect(addrs []string, config *tls.Config) error
  • func (n *Node) GetClaimInTx(txid string, nout int) (*types.Claim, error)
  • func (n *Node) GetClaimsInTx(txid string) (*GetClaimsInTxResp, error)
  • func (n *Node) GetTx(txid string) (string, error)
  • func (n *Node) Raw(method string, params []string, v interface{}) error
  • func (n *Node) Resolve(url string) (*types.Output, error)
  • func (n *Node) ServerVersion() (string, error)
  • func (n *Node) Shutdown()
• type TCPTransport
  • func NewTransport(addr string, config *tls.Config) (*TCPTransport, error)
  • func (t *TCPTransport) Errors() <-chan error
  • func (t *TCPTransport) Responses() <-chan []byte
  • func (t *TCPTransport) Send(body []byte) error
  • func (t *TCPTransport) Shutdown()

Constants

const (
	ClientVersion   = "0.0.1"
	ProtocolVersion = "1.0"
)

Variables

var (
	ErrNotImplemented = errors.New("not implemented")
	ErrNodeConnected  = errors.New("node already connected")
	ErrConnectFailed  = errors.New("failed to connect")
	ErrTimeout        = errors.New("timeout")
)

Types

type GetClaimsInTxResp

type GetClaimsInTxResp struct {
	Jsonrpc string `json:"jsonrpc"`
	ID      int    `json:"id"`
	Result  []struct {
		Name            string        `json:"name"`
		ClaimID         string        `json:"claim_id"`
		Txid            string        `json:"txid"`
		Nout            int           `json:"nout"`
		Amount          int           `json:"amount"`
		Depth           int           `json:"depth"`
		Height          int           `json:"height"`
		Value           string        `json:"value"`
		ClaimSequence   int           `json:"claim_sequence"`
		Address         string        `json:"address"`
		Supports        []interface{} `json:"supports"` // TODO: finish me
		EffectiveAmount int           `json:"effective_amount"`
		ValidAtHeight   int           `json:"valid_at_height"`
	} `json:"result"`
}

type Node

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

func NewNode

func NewNode() *Node

NewNode creates a new node.

func (*Node) Connect

func (n *Node) Connect(addrs []string, config *tls.Config) error

Connect creates a new connection to the specified address.

func (*Node) GetClaimInTx

func (n *Node) GetClaimInTx(txid string, nout int) (*types.Claim, error)

func (*Node) GetClaimsInTx

func (n *Node) GetClaimsInTx(txid string) (*GetClaimsInTxResp, error)

func (*Node) GetTx

func (n *Node) GetTx(txid string) (string, error)

func (*Node) Raw

func (n *Node) Raw(method string, params []string, v interface{}) error

Raw makes a raw wallet server request

func (*Node) Resolve

func (n *Node) Resolve(url string) (*types.Output, error)

func (*Node) ServerVersion

func (n *Node) ServerVersion() (string, error)

ServerVersion returns the server's version. https://electrumx.readthedocs.io/en/latest/protocol-methods.html#server-version

func (*Node) Shutdown

func (n *Node) Shutdown()

type TCPTransport

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

func NewTransport

func NewTransport(addr string, config *tls.Config) (*TCPTransport, error)

func (*TCPTransport) Errors

func (t *TCPTransport) Errors() <-chan error

func (*TCPTransport) Responses

func (t *TCPTransport) Responses() <-chan []byte

func (*TCPTransport) Send

func (t *TCPTransport) Send(body []byte) error

func (*TCPTransport) Shutdown

func (t *TCPTransport) Shutdown()