legacy

package
v0.0.0-...-a838072 Latest Latest
Warning

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

 Go to latest Published: Sep 19, 2019 License: Unlicense Imports: 31 Imported by: 0

Documentation

Overview

AUTOGENERATED by internal/rpchelp/genrpcserverhelp.go; do not edit.

Index

Constants

View Source 
const MaxRequestSize = 1024 * 1024 * 4

MaxRequestSize specifies the maximum number of bytes in the request body that may be read from a client. This is currently limited to 4MB.

Variables

View Source 
var (
	ErrNeedPositiveAmount = InvalidParameterError{
		errors.New("amount must be positive"),
	}
	ErrNeedPositiveMinconf = InvalidParameterError{
		errors.New("minconf must be positive"),
	}
	ErrAddressNotInWallet = json.RPCError{
		Code:    json.ErrRPCWallet,
		Message: "address not found in wallet",
	}
	ErrAccountNameNotFound = json.RPCError{
		Code:    json.ErrRPCWalletInvalidAccountName,
		Message: "account name not found",
	}
	ErrUnloadedWallet = json.RPCError{
		Code:    json.ErrRPCWallet,
		Message: "Request requires a wallet but wallet has not loaded yet",
	}
	ErrWalletUnlockNeeded = json.RPCError{
		Code:    json.ErrRPCWalletUnlockNeeded,
		Message: "Enter the wallet passphrase with walletpassphrase first",
	}
	ErrNotImportedAccount = json.RPCError{
		Code:    json.ErrRPCWallet,
		Message: "imported addresses must belong to the imported account",
	}
	ErrNoTransactionInfo = json.RPCError{
		Code:    json.ErrRPCNoTxInfo,
		Message: "No information for transaction",
	}
	ErrReservedAccountName = json.RPCError{
		Code:    json.ErrRPCInvalidParameter,
		Message: "Account name is reserved by RPC server",
	}
)

Errors variables that are defined once here to avoid duplication below.

View Source 
var ErrNoAuth = errors.New("no auth")

ErrNoAuth represents an error where authentication could not succeed due to a missing Authorization HTTP header.

View Source 
var HelpDescs map[string]string

These generators create the following global variables in this package: 

var localeHelpDescs map[string]func() map[string]string
var requestUsages string

localeHelpDescs maps from locale strings (e.g. "en_US") to a function that builds a map of help texts for each RPC server method. This prevents help text maps for every locale map from being rooted and created during init. Instead, the appropiate function is looked up when help text is first needed using the current locale and saved to the global below for futher reuse.

requestUsages contains single line usages for every supported request, separated by newlines. It is set during init. These usages are used for all locales.

View Source 
var HelpDescsMutex sync.Mutex // Help may execute concurrently, so synchronize access.
View Source 
var LocaleHelpDescs = map[string]func() map[string]string{
	"en_US": HelpDescsEnUS,
}
View Source 
var Log = cl.NewSubSystem(pkgs.Name(_d), "info")
View Source 
var RPCHandlers = map[string]struct {
	Handler          RequestHandler
	HandlerWithChain RequestHandlerChainRequired
	// Function variables cannot be compared against anything but nil, so
	// use a boolean to record whether help generation is necessary.  This
	// is used by the tests to ensure that help can be generated for every
	// implemented method.
	//
	// A single map and this bool is here is used rather than several maps
	// for the unimplemented handlers so every method has exactly one
	// handler function.
	NoHelp bool
}{

	"addmultisigaddress":     {Handler: AddMultiSigAddress},
	"createmultisig":         {Handler: CreateMultiSig},
	"dumpprivkey":            {Handler: DumpPrivKey},
	"getaccount":             {Handler: GetAccount},
	"getaccountaddress":      {Handler: GetAccountAddress},
	"getaddressesbyaccount":  {Handler: GetAddressesByAccount},
	"getbalance":             {Handler: GetBalance},
	"getbestblockhash":       {Handler: GetBestBlockHash},
	"getblockcount":          {Handler: GetBlockCount},
	"getinfo":                {HandlerWithChain: GetInfo},
	"getnewaddress":          {Handler: GetNewAddress},
	"getrawchangeaddress":    {Handler: GetRawChangeAddress},
	"getreceivedbyaccount":   {Handler: GetReceivedByAccount},
	"getreceivedbyaddress":   {Handler: GetReceivedByAddress},
	"gettransaction":         {Handler: GetTransaction},
	"help":                   {Handler: HelpNoChainRPC, HandlerWithChain: HelpWithChainRPC},
	"importprivkey":          {Handler: ImportPrivKey},
	"keypoolrefill":          {Handler: KeypoolRefill},
	"listaccounts":           {Handler: ListAccounts},
	"listlockunspent":        {Handler: ListLockUnspent},
	"listreceivedbyaccount":  {Handler: ListReceivedByAccount},
	"listreceivedbyaddress":  {Handler: ListReceivedByAddress},
	"listsinceblock":         {HandlerWithChain: ListSinceBlock},
	"listtransactions":       {Handler: ListTransactions},
	"listunspent":            {Handler: ListUnspent},
	"lockunspent":            {Handler: LockUnspent},
	"sendfrom":               {HandlerWithChain: SendFrom},
	"sendmany":               {Handler: SendMany},
	"sendtoaddress":          {Handler: SendToAddress},
	"settxfee":               {Handler: SetTxFee},
	"signmessage":            {Handler: SignMessage},
	"signrawtransaction":     {HandlerWithChain: SignRawTransaction},
	"validateaddress":        {Handler: ValidateAddress},
	"verifymessage":          {Handler: VerifyMessage},
	"walletlock":             {Handler: WalletLock},
	"walletpassphrase":       {Handler: WalletPassphrase},
	"walletpassphrasechange": {Handler: WalletPassphraseChange},

	"backupwallet":         {Handler: Unimplemented, NoHelp: true},
	"dumpwallet":           {Handler: Unimplemented, NoHelp: true},
	"getwalletinfo":        {Handler: Unimplemented, NoHelp: true},
	"importwallet":         {Handler: Unimplemented, NoHelp: true},
	"listaddressgroupings": {Handler: Unimplemented, NoHelp: true},

	"encryptwallet": {Handler: Unsupported, NoHelp: true},
	"move":          {Handler: Unsupported, NoHelp: true},
	"setaccount":    {Handler: Unsupported, NoHelp: true},

	"createnewaccount": {Handler: CreateNewAccount},
	"getbestblock":     {Handler: GetBestBlock},

	"getunconfirmedbalance":   {Handler: GetUnconfirmedBalance},
	"listaddresstransactions": {Handler: ListAddressTransactions},
	"listalltransactions":     {Handler: ListAllTransactions},
	"renameaccount":           {Handler: RenameAccount},
	"walletislocked":          {Handler: WalletIsLocked},
}
View Source 
var RequestUsages = "" /* 1969-byte string literal not displayed */

Functions

func AddMultiSigAddress 

func AddMultiSigAddress(icmd interface{}, w *wallet.Wallet) (interface{}, error)

AddMultiSigAddress handles an addmultisigaddress request by adding a multisig address to the given wallet.

func Confirms 

func Confirms(txHeight, curHeight int32) int32

Confirms returns the number of confirmations for a transaction in a block at height txHeight (or -1 for an unconfirmed tx) given the chain height curHeight.

func CreateMultiSig 

func CreateMultiSig(icmd interface{}, w *wallet.Wallet) (interface{}, error)

CreateMultiSig handles an createmultisig request by returning a multisig address for the given inputs.

func CreateNewAccount 

func CreateNewAccount(icmd interface{}, w *wallet.Wallet) (interface{}, error)

CreateNewAccount handles a createnewaccount request by creating and returning a new account. If the last account has no transaction history as per BIP 0044 a new account cannot be created so an error will be returned.

func DecodeAddress 

func DecodeAddress(s string, params *netparams.Params) (util.Address, error)

func DecodeHexStr 

func DecodeHexStr(hexStr string) ([]byte, error)

DecodeHexStr decodes the hex encoding of a string, possibly prepending a leading '0' character if there is an odd number of bytes in the hex string. This is to prevent an error for an invalid hex string when using an odd number of bytes when calling hex.Decode.

func DumpPrivKey 

func DumpPrivKey(icmd interface{}, w *wallet.Wallet) (interface{}, error)

DumpPrivKey handles a dumpprivkey request with the private key for a single address, or an appropiate error if the wallet is locked.

func GetAccount 

func GetAccount(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetAccount handles a getaccount request by returning the account name associated with a single address.

func GetAccountAddress 

func GetAccountAddress(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetAccountAddress handles a getaccountaddress by returning the most recently-created chained address that has not yet been used (does not yet appear in the blockchain, or any tx that has arrived in the pod mempool). If the most recently-requested address has been used, a new address (the next chained address in the keypool) is used. This can fail if the keypool runs out (and will return json.ErrRPCWalletKeypoolRanOut if that happens).

func GetAddressesByAccount 

func GetAddressesByAccount(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetAddressesByAccount handles a getaddressesbyaccount request by returning all addresses for an account, or an error if the requested account does not exist.

func GetBalance 

func GetBalance(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetBalance handles a getbalance request by returning the balance for an account (wallet), or an error if the requested account does not exist.

func GetBestBlock 

func GetBestBlock(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetBestBlock handles a getbestblock request by returning a JSON object with the height and hash of the most recently processed block.

func GetBestBlockHash 

func GetBestBlockHash(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetBestBlockHash handles a getbestblockhash request by returning the hash of the most recently processed block.

func GetBlockCount 

func GetBlockCount(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetBlockCount handles a getblockcount request by returning the chain height of the most recently processed block.

func GetInfo 

func GetInfo(icmd interface{}, w *wallet.Wallet, chainClient *chain.RPCClient) (interface{}, error)

GetInfo handles a getinfo request by returning the a structure containing information about the current state of btcwallet. exist.

func GetNewAddress 

func GetNewAddress(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetNewAddress handles a getnewaddress request by returning a new address for an account. If the account does not exist an appropiate error is returned. TODO: Follow BIP 0044 and warn if number of unused addresses exceeds the gap limit.

func GetRawChangeAddress 

func GetRawChangeAddress(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetRawChangeAddress handles a getrawchangeaddress request by creating and returning a new change address for an account.

Note: bitcoind allows specifying the account as an optional parameter, but ignores the parameter.

func GetReceivedByAccount 

func GetReceivedByAccount(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetReceivedByAccount handles a getreceivedbyaccount request by returning the total amount received by addresses of an account.

func GetReceivedByAddress 

func GetReceivedByAddress(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetReceivedByAddress handles a getreceivedbyaddress request by returning the total amount received by a single address.

func GetTransaction 

func GetTransaction(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetTransaction handles a gettransaction request by returning details about a single transaction saved by wallet.

func GetUnconfirmedBalance 

func GetUnconfirmedBalance(icmd interface{}, w *wallet.Wallet) (interface{}, error)

GetUnconfirmedBalance handles a getunconfirmedbalance extension request by returning the current unconfirmed balance of an account.

func HTTPBasicAuth 

func HTTPBasicAuth(username, password string) []byte

HTTPBasicAuth returns the UTF-8 bytes of the HTTP Basic authentication string: 

"Basic " + base64(username + ":" + password)

func Help 

func Help(icmd interface{}, w *wallet.Wallet, chainClient *chain.RPCClient) (interface{}, error)

Help handles the Help request by returning one line usage of all available methods, or full Help for a specific method. The chainClient is optional, and this is simply a helper function for the HelpNoChainRPC and HelpWithChainRPC handlers.

func HelpDescsEnUS 

func HelpDescsEnUS() map[string]string

func HelpNoChainRPC 

func HelpNoChainRPC(icmd interface{}, w *wallet.Wallet) (interface{}, error)

HelpNoChainRPC handles the help request when the RPC server has not been associated with a consensus RPC client. No help messages are included for passthrough requests.

func HelpWithChainRPC 

func HelpWithChainRPC(icmd interface{}, w *wallet.Wallet, chainClient *chain.RPCClient) (interface{}, error)

HelpWithChainRPC handles the help request when the RPC server has been associated with a consensus RPC client. The additional RPC client is used to include help messages for methods implemented by the consensus server via RPC passthrough.

func IDPointer 

func IDPointer(id interface{}) (p *interface{})

IDPointer returns a pointer to the passed ID, or nil if the interface is nil. Interface pointers are usually a red flag of doing something incorrectly, but this is only implemented here to work around an oddity with json, which uses empty interface pointers for response IDs.

func ImportPrivKey 

func ImportPrivKey(icmd interface{}, w *wallet.Wallet) (interface{}, error)

ImportPrivKey handles an importprivkey request by parsing a WIF-encoded private key and adding it to an account.

func IsNilOrEmpty 

func IsNilOrEmpty(s *string) bool

func JSONAuthFail 

func JSONAuthFail(w http.ResponseWriter)

JSONAuthFail sends a message back to the client if the http auth is rejected.

func JSONError 

func JSONError(err error) *json.RPCError

JSONError creates a JSON-RPC error from the Go error.

func KeypoolRefill 

func KeypoolRefill(icmd interface{}, w *wallet.Wallet) (interface{}, error)

KeypoolRefill handles the keypoolrefill command. Since we handle the keypool automatically this does nothing since refilling is never manually required.

func ListAccounts 

func ListAccounts(icmd interface{}, w *wallet.Wallet) (interface{}, error)

ListAccounts handles a listaccounts request by returning a map of account names to their balances.

func ListAddressTransactions 

func ListAddressTransactions(icmd interface{}, w *wallet.Wallet) (interface{}, error)

ListAddressTransactions handles a listaddresstransactions request by returning an array of maps with details of spent and received wallet transactions. The form of the reply is identical to listtransactions, but the array elements are limited to transaction details which are about the addresess included in the request.

func ListAllTransactions 

func ListAllTransactions(icmd interface{}, w *wallet.Wallet) (interface{}, error)

ListAllTransactions handles a listalltransactions request by returning a map with details of sent and recevied wallet transactions. This is similar to ListTransactions, except it takes only a single optional argument for the account name and replies with all transactions.

func ListLockUnspent 

func ListLockUnspent(icmd interface{}, w *wallet.Wallet) (interface{}, error)

ListLockUnspent handles a listlockunspent request by returning an slice of all locked outpoints.

func ListReceivedByAccount 

func ListReceivedByAccount(icmd interface{}, w *wallet.Wallet) (interface{}, error)

ListReceivedByAccount handles a listreceivedbyaccount request by returning a slice of objects, each one containing: 

"account": the receiving account;
"amount": total amount received by the account;
"confirmations": number of confirmations of the most recent transaction.

It takes two parameters: 

"minconf": minimum number of confirmations to consider a transaction -
           default: one;
"includeempty": whether or not to include addresses that have no transactions -
                default: false.

func ListReceivedByAddress 

func ListReceivedByAddress(icmd interface{}, w *wallet.Wallet) (interface{}, error)

ListReceivedByAddress handles a listreceivedbyaddress request by returning a slice of objects, each one containing: 

"account": the account of the receiving address;
"address": the receiving address;
"amount": total amount received by the address;
"confirmations": number of confirmations of the most recent transaction.

It takes two parameters: 

"minconf": minimum number of confirmations to consider a transaction -
           default: one;
"includeempty": whether or not to include addresses that have no transactions -
                default: false.

func ListSinceBlock 

func ListSinceBlock(icmd interface{}, w *wallet.Wallet, chainClient *chain.RPCClient) (interface{}, error)

ListSinceBlock handles a listsinceblock request by returning an array of maps with details of sent and received wallet transactions since the given block.

func ListTransactions 

func ListTransactions(icmd interface{}, w *wallet.Wallet) (interface{}, error)

ListTransactions handles a listtransactions request by returning an array of maps with details of sent and recevied wallet transactions.

func ListUnspent 

func ListUnspent(icmd interface{}, w *wallet.Wallet) (interface{}, error)

ListUnspent handles the listunspent command.

func LockUnspent 

func LockUnspent(icmd interface{}, w *wallet.Wallet) (interface{}, error)

LockUnspent handles the lockunspent command.

func MakeMultiSigScript 

func MakeMultiSigScript(w *wallet.Wallet, keys []string, nRequired int) ([]byte, error)

MakeMultiSigScript is a helper function to combine common logic for AddMultiSig and CreateMultiSig.

func MakeOutputs 

func MakeOutputs(pairs map[string]util.Amount, chainParams *netparams.Params) ([]*wire.TxOut, error)

MakeOutputs creates a slice of transaction outputs from a pair of address strings to amounts. This is used to create the outputs to include in newly created transactions from a JSON object describing the output destinations and amounts.

func MakeResponse 

func MakeResponse(id, result interface{}, err error) json.Response

MakeResponse makes the JSON-RPC response struct for the result and error returned by a requestHandler. The returned response is not ready for marshaling and sending off to a client, but must be

func RenameAccount 

func RenameAccount(icmd interface{}, w *wallet.Wallet) (interface{}, error)

RenameAccount handles a renameaccount request by renaming an account. If the account does not exist an appropiate error will be returned.

func SendFrom 

func SendFrom(icmd interface{}, w *wallet.Wallet, chainClient *chain.RPCClient) (interface{}, error)

SendFrom handles a sendfrom RPC request by creating a new transaction spending unspent transaction outputs for a wallet to another payment address. Leftover inputs not sent to the payment address or a fee for the miner are sent back to a new address in the wallet. Upon success, the TxID for the created transaction is returned.

func SendMany 

func SendMany(icmd interface{}, w *wallet.Wallet) (interface{}, error)

SendMany handles a sendmany RPC request by creating a new transaction spending unspent transaction outputs for a wallet to any number of payment addresses. Leftover inputs not sent to the payment address or a fee for the miner are sent back to a new address in the wallet. Upon success, the TxID for the created transaction is returned.

func SendPairs 

func SendPairs(w *wallet.Wallet, amounts map[string]util.Amount,
	account uint32, minconf int32, feeSatPerKb util.Amount) (string, error)

SendPairs creates and sends payment transactions. It returns the transaction hash in string format upon success All errors are returned in json.RPCError format

func SendToAddress 

func SendToAddress(icmd interface{}, w *wallet.Wallet) (interface{}, error)

SendToAddress handles a sendtoaddress RPC request by creating a new transaction spending unspent transaction outputs for a wallet to another payment address. Leftover inputs not sent to the payment address or a fee for the miner are sent back to a new address in the wallet. Upon success, the TxID for the created transaction is returned.

func SetTxFee 

func SetTxFee(icmd interface{}, w *wallet.Wallet) (interface{}, error)

SetTxFee sets the transaction fee per kilobyte added to transactions.

func SignMessage 

func SignMessage(icmd interface{}, w *wallet.Wallet) (interface{}, error)

SignMessage signs the given message with the private key for the given address

func SignRawTransaction 

func SignRawTransaction(icmd interface{}, w *wallet.Wallet, chainClient *chain.RPCClient) (interface{}, error)

SignRawTransaction handles the signrawtransaction command.

func Throttled 

func Throttled(threshold int64, h http.Handler) http.Handler

Throttled wraps an http.Handler with throttling of concurrent active clients by responding with an HTTP 429 when the threshold is crossed.

func ThrottledFn 

func ThrottledFn(threshold int64, f http.HandlerFunc) http.Handler

ThrottledFn wraps an http.HandlerFunc with throttling of concurrent active clients by responding with an HTTP 429 when the threshold is crossed.

func Unimplemented 

func Unimplemented(interface{}, *wallet.Wallet) (interface{}, error)

Unimplemented handles an Unimplemented RPC request with the appropiate error.

func Unsupported 

func Unsupported(interface{}, *wallet.Wallet) (interface{}, error)

Unsupported handles a standard bitcoind RPC request which is Unsupported by btcwallet due to design differences.

func UseLogger 

func UseLogger(logger *cl.SubSystem)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using log.

func ValidateAddress 

func ValidateAddress(icmd interface{}, w *wallet.Wallet) (interface{}, error)

ValidateAddress handles the validateaddress command.

func VerifyMessage 

func VerifyMessage(icmd interface{}, w *wallet.Wallet) (interface{}, error)

VerifyMessage handles the verifymessage command by verifying the provided compact signature for the given address and message.

func WalletIsLocked 

func WalletIsLocked(icmd interface{}, w *wallet.Wallet) (interface{}, error)

WalletIsLocked handles the walletislocked extension request by returning the current lock state (false for unlocked, true for locked) of an account.

func WalletLock 

func WalletLock(icmd interface{}, w *wallet.Wallet) (interface{}, error)

WalletLock handles a walletlock request by locking the all account wallets, returning an error if any wallet is not encrypted (for example, a watching-only wallet).

func WalletPassphrase 

func WalletPassphrase(icmd interface{}, w *wallet.Wallet) (interface{}, error)

WalletPassphrase responds to the walletpassphrase request by unlocking the wallet. The decryption key is saved in the wallet until timeout seconds expires, after which the wallet is locked.

func WalletPassphraseChange 

func WalletPassphraseChange(icmd interface{}, w *wallet.Wallet) (interface{}, error)

WalletPassphraseChange responds to the walletpassphrasechange request by unlocking all accounts with the provided old passphrase, and re-encrypting each private key with an AES key derived from the new passphrase.

If the old passphrase is correct and the passphrase is changed, all wallets will be immediately locked.

Types

type DeserializationError 

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

DeserializationError describes a failed deserializaion due to bad user input. It corresponds to json.ErrRPCDeserialization.

type InvalidParameterError 

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

InvalidParameterError describes an invalid parameter passed by the user. It corresponds to json.ErrRPCInvalidParameter.

type LazyHandler 

type LazyHandler func() (interface{}, *json.RPCError)

LazyHandler is a closure over a requestHandler or passthrough request with the RPC server's wallet and chain server variables as part of the closure context.

func LazyApplyHandler 

func LazyApplyHandler(request *json.Request, w *wallet.Wallet, chainClient chain.Interface) LazyHandler

LazyApplyHandler looks up the best request handler func for the method, returning a closure that will execute it with the (required) wallet and (optional) consensus RPC server. If no handlers are found and the chainClient is not nil, the returned handler performs RPC passthrough.

type Options 

type Options struct {
	Username            string
	Password            string
	MaxPOSTClients      int64
	MaxWebsocketClients int64
}

Options contains the required options for running the legacy RPC server.

type ParseError 

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

ParseError describes a failed parse due to bad user input. It corresponds to json.ErrRPCParse.

type RequestHandler 

type RequestHandler func(interface{}, *wallet.Wallet) (interface{}, error)

RequestHandler is a handler function to handle an unmarshaled and parsed request into a marshalable response. If the error is a *json.RPCError or any of the above special error classes, the server will respond with the JSON-RPC appropiate error code. All other errors use the wallet catch-all error code, json.ErrRPCWallet.

type RequestHandlerChainRequired 

type RequestHandlerChainRequired func(interface{}, *wallet.Wallet, *chain.RPCClient) (interface{}, error)

requestHandlerChain is a requestHandler that also takes a parameter for

type Server 

type Server struct {
	HTTPServer   http.Server
	Wallet       *wallet.Wallet
	WalletLoader *wallet.Loader
	ChainClient  chain.Interface
	// handlerLookup       func(string) (requestHandler, bool)
	HandlerMutex        sync.Mutex
	Listeners           []net.Listener
	AuthSHA             [sha256.Size]byte
	Upgrader            websocket.Upgrader
	MaxPostClients      int64 // Max concurrent HTTP POST clients.
	MaxWebsocketClients int64 // Max concurrent websocket clients.
	WG                  sync.WaitGroup
	Quit                chan struct{}
	QuitMutex           sync.Mutex
	RequestShutdownChan chan struct{}
}

Server holds the items the RPC server may need to access (auth, config, shutdown, etc.)

func NewServer 

func NewServer(opts *Options, walletLoader *wallet.Loader, listeners []net.Listener) *Server

NewServer creates a new server for serving legacy RPC client connections, both HTTP POST and websocket.

func (*Server) CheckAuthHeader 

func (s *Server) CheckAuthHeader(r *http.Request) error

CheckAuthHeader checks the HTTP Basic authentication supplied by a client in the HTTP request r. It errors with ErrNoAuth if the request does not contain the Authorization header, or another non-nil error if the authentication was provided but incorrect.

This check is time-constant.

func (*Server) HandlerClosure 

func (s *Server) HandlerClosure(request *json.Request) LazyHandler

HandlerClosure creates a closure function for handling requests of the given method. This may be a request that is handled directly by btcwallet, or a chain server request that is handled by passing the request down to pod.

NOTE: These handlers do not handle special cases, such as the authenticate method. Each of these must be checked beforehand (the method is already known) and handled accordingly.

func (*Server) InvalidAuth 

func (s *Server) InvalidAuth(req *json.Request) bool

InvalidAuth checks whether a websocket request is a valid (parsable) authenticate request and checks the supplied username and passphrase against the server auth.

func (*Server) POSTClientRPC 

func (s *Server) POSTClientRPC(w http.ResponseWriter, r *http.Request)

POSTClientRPC processes and replies to a JSON-RPC client request.

func (*Server) RegisterWallet 

func (s *Server) RegisterWallet(w *wallet.Wallet)

RegisterWallet associates the legacy RPC server with the wallet. This function must be called before any wallet RPCs can be called by clients.

func (*Server) RequestProcessShutdown 

func (s *Server) RequestProcessShutdown()

func (*Server) RequestProcessShutdownChan 

func (s *Server) RequestProcessShutdownChan() <-chan struct{}

RequestProcessShutdownChan returns a channel that is sent to when an authorized client requests remote shutdown.

func (*Server) Serve 

func (s *Server) Serve(lis net.Listener)

Serve serves HTTP POST and websocket RPC for the legacy JSON-RPC RPC server. This function does not block on lis.Accept.

func (*Server) SetChainServer 

func (s *Server) SetChainServer(chainClient chain.Interface)

SetChainServer sets the chain server client component needed to run a fully functional bitcoin wallet RPC server. This can be called to enable RPC passthrough even before a loaded wallet is set, but the wallet's RPC client is preferred.

func (*Server) Stop 

func (s *Server) Stop()

Stop gracefully shuts down the rpc server by stopping and disconnecting all clients, disconnecting the chain server connection, and closing the wallet's account files. This blocks until shutdown completes.

func (*Server) WebsocketClientRPC 

func (s *Server) WebsocketClientRPC(wsc *WebsocketClient)

WebsocketClientRPC starts the goroutines to serve JSON-RPC requests over a websocket connection for a single client.

func (*Server) WebsocketClientRead 

func (s *Server) WebsocketClientRead(wsc *WebsocketClient)

func (*Server) WebsocketClientRespond 

func (s *Server) WebsocketClientRespond(wsc *WebsocketClient)

func (*Server) WebsocketClientSend 

func (s *Server) WebsocketClientSend(wsc *WebsocketClient)

type WebsocketClient 

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

func NewWebsocketClient 

func NewWebsocketClient(c *websocket.Conn, authenticated bool, remoteAddr string) *WebsocketClient

func (*WebsocketClient) Send 

func (c *WebsocketClient) Send(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.