commands

Documentation

Index

• Variables
• func ResponseError(res interface{})
• func ResponseJSON(res interface{})
• type Error
• type RemoteNode

Variables

var Api = cli.Command{
	Name:    "api",
	Aliases: []string{"a"},
	Usage:   "Interaction with Xena API commands",
	Subcommands: []cli.Command{
		{
			Name:   "nodes",
			Usage:  "List Xena lnd nodes available to open channels with",
			Action: nodesList,
		},
	},
}

Payment commands definition

var Channel = cli.Command{
	Name:    "channel",
	Aliases: []string{"c"},
	Usage:   "Channel manipulation commands",
	Subcommands: []cli.Command{
		{
			Name:   "list",
			Usage:  "List available channels",
			Action: channelList,
		},
		{
			Name:   "open",
			Usage:  "Open a new channel with specified capacity",
			Action: channelOpen,
			Flags: []cli.Flag{
				cli.StringFlag{Name: "node-id"},
				cli.StringFlag{Name: "node-pubkey"},
				cli.StringFlag{Name: "capacity"},
			},
		},
		{
			Name:   "close",
			Usage:  "Close an existing channel identified by id or channel-point",
			Action: channelClose,
			Flags: []cli.Flag{
				cli.Uint64Flag{Name: "id"},
				cli.StringFlag{Name: "channel-point"},
			},
		},
		{
			Name:   "history",
			Usage:  "List closed channels",
			Action: channelHistory,
			Flags: []cli.Flag{
				cli.IntFlag{Name: "offset", Value: 0},
				cli.IntFlag{Name: "limit", Value: 10},
			},
		},
	},
}

Channel commands definition

var Node = cli.Command{
	Name:    "node",
	Aliases: []string{"n"},
	Usage:   "Node manipulation commands",
	Subcommands: []cli.Command{
		{
			Name:   "unlock",
			Usage:  "Unlock local LND node to bring it up and running",
			Action: nodeUnlock,
			Flags: []cli.Flag{
				cli.StringFlag{Name: "password"},
			},
		},
		{
			Name:   "status",
			Usage:  "Get local LND node status",
			Action: nodeStatus,
		},
		{
			Name:   "peers",
			Usage:  "Get local LND node peers",
			Action: nodePeers,
		},
		{
			Name:   "disconnect",
			Usage:  "Disconnect local LND node from dAccs infrastructure",
			Action: nodeDisconnect,
		},
		{
			Name:   "balance",
			Usage:  "Get local LND node balance",
			Action: nodeBalance,
		},
		{
			Name:   "deposit",
			Usage:  "Get local LND node deposit address",
			Action: nodeDeposit,
		},
		{
			Name:   "transactions",
			Usage:  "List local LND wallet transactions",
			Action: transactionList,
			Flags: []cli.Flag{
				cli.IntFlag{Name: "offset", Value: 0},
				cli.IntFlag{Name: "limit", Value: 10},
			},
		},
	},
}

Node commands definition

var Payment = cli.Command{
	Name:    "payment",
	Aliases: []string{"p"},
	Usage:   "Payment processing commands",
	Subcommands: []cli.Command{
		{
			Name:   "list",
			Usage:  "List last payments with paging support",
			Action: paymentList,
			Flags: []cli.Flag{
				cli.IntFlag{Name: "offset", Value: 0},
				cli.IntFlag{Name: "limit", Value: 10},
			},
		},
		{
			Name:   "send",
			Usage:  "Send payment to specified account with specified amount",
			Action: paymentSend,
			Flags: []cli.Flag{
				cli.Int64Flag{Name: "account"},
				cli.StringFlag{Name: "amount"},
				cli.Uint64Flag{Name: "channel-id"},
				cli.StringFlag{Name: "channel-point"},
			},
		},
	},
}

Payment commands definition

Functions

func ResponseError

func ResponseError(res interface{})

ResponseError error handler

func ResponseJSON

func ResponseJSON(res interface{})

ResponseJSON formatter

Types

type Error

type Error struct {
	Error string `json:"error"`
}

Error descriptor

type RemoteNode

type RemoteNode struct {
	ID     string `json:"id"`
	PubKey string `json:"pubKey"`
}