89 lines
3.6 KiB
Go
89 lines
3.6 KiB
Go
// Copyright (c) 2015 The btcsuite developers
|
|
//
|
|
// Permission to use, copy, modify, and distribute this software for any
|
|
// purpose with or without fee is hereby granted, provided that the above
|
|
// copyright notice and this permission notice appear in all copies.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
//+build !generate
|
|
|
|
package rpchelp
|
|
|
|
import "github.com/btcsuite/btcd/btcjson"
|
|
|
|
// Common return types.
|
|
var (
|
|
returnsBool = []interface{}{(*bool)(nil)}
|
|
returnsNumber = []interface{}{(*float64)(nil)}
|
|
returnsString = []interface{}{(*string)(nil)}
|
|
returnsStringArray = []interface{}{(*[]string)(nil)}
|
|
returnsLTRArray = []interface{}{(*[]btcjson.ListTransactionsResult)(nil)}
|
|
)
|
|
|
|
// Contains all methods and result types that help is generated for, for every
|
|
// locale.
|
|
var Methods = []struct {
|
|
Method string
|
|
ResultTypes []interface{}
|
|
}{
|
|
{"addmultisigaddress", returnsString},
|
|
{"createmultisig", []interface{}{(*btcjson.CreateMultiSigResult)(nil)}},
|
|
{"dumpprivkey", returnsString},
|
|
{"getaccount", returnsString},
|
|
{"getaccountaddress", returnsString},
|
|
{"getaddressesbyaccount", returnsStringArray},
|
|
{"getbalance", append(returnsNumber, returnsNumber[0])},
|
|
{"getbestblockhash", returnsString},
|
|
{"getblockcount", returnsNumber},
|
|
{"getinfo", []interface{}{(*btcjson.InfoWalletResult)(nil)}},
|
|
{"getnewaddress", returnsString},
|
|
{"getrawchangeaddress", returnsString},
|
|
{"getreceivedbyaccount", returnsNumber},
|
|
{"getreceivedbyaddress", returnsNumber},
|
|
{"gettransaction", []interface{}{(*btcjson.GetTransactionResult)(nil)}},
|
|
{"help", append(returnsString, returnsString[0])},
|
|
{"importprivkey", nil},
|
|
{"keypoolrefill", nil},
|
|
{"listaccounts", []interface{}{(*map[string]float64)(nil)}},
|
|
{"listlockunspent", []interface{}{(*[]btcjson.TransactionInput)(nil)}},
|
|
{"listreceivedbyaccount", []interface{}{(*[]btcjson.ListReceivedByAccountResult)(nil)}},
|
|
{"listreceivedbyaddress", []interface{}{(*[]btcjson.ListReceivedByAddressResult)(nil)}},
|
|
{"listsinceblock", []interface{}{(*btcjson.ListSinceBlockResult)(nil)}},
|
|
{"listtransactions", returnsLTRArray},
|
|
{"listunspent", []interface{}{(*btcjson.ListUnspentResult)(nil)}},
|
|
{"lockunspent", returnsBool},
|
|
{"sendfrom", returnsString},
|
|
{"sendmany", returnsString},
|
|
{"sendtoaddress", returnsString},
|
|
{"settxfee", returnsBool},
|
|
{"signmessage", returnsString},
|
|
{"signrawtransaction", []interface{}{(*btcjson.SignRawTransactionResult)(nil)}},
|
|
{"validateaddress", []interface{}{(*btcjson.ValidateAddressWalletResult)(nil)}},
|
|
{"verifymessage", returnsBool},
|
|
{"walletlock", nil},
|
|
{"walletpassphrase", nil},
|
|
{"walletpassphrasechange", nil},
|
|
{"createnewaccount", nil},
|
|
{"exportwatchingwallet", returnsString},
|
|
{"getbestblock", []interface{}{(*btcjson.GetBestBlockResult)(nil)}},
|
|
{"getunconfirmedbalance", returnsNumber},
|
|
{"listaddresstransactions", returnsLTRArray},
|
|
{"listalltransactions", returnsLTRArray},
|
|
{"renameaccount", nil},
|
|
{"walletislocked", returnsBool},
|
|
}
|
|
|
|
var HelpDescs = []struct {
|
|
Locale string // Actual locale, e.g. en_US
|
|
GoLocale string // Locale used in Go names, e.g. EnUS
|
|
Descs map[string]string
|
|
}{
|
|
{"en_US", "EnUS", helpDescsEnUS}, // helpdescs_en_US.go
|
|
}
|