methods.go raw

   1  // +build !generate
   2  
   3  package rpchelp
   4  
   5  import (
   6  	"github.com/p9c/p9/pkg/btcjson"
   7  )
   8  
   9  // HelpDescs contains the locale-specific help strings along with the locale.
  10  var HelpDescs = []struct {
  11  	Locale   string // Actual locale, e.g. en_US
  12  	GoLocale string // Locale used in Go names, e.g. EnUS
  13  	Descs    map[string]string
  14  }{
  15  	{"en_US", "EnUS", helpDescsEnUS}, // helpdescs_en_US.go
  16  }
  17  
  18  // Methods contains all methods and result types that help is generated for, for every locale.
  19  var Methods = []struct {
  20  	Method      string
  21  	ResultTypes []interface{}
  22  }{
  23  	{"addmultisigaddress", returnsString},
  24  	{"createmultisig", []interface{}{(*btcjson.CreateMultiSigResult)(nil)}},
  25  	{"dumpprivkey", returnsString},
  26  	{"getaccount", returnsString},
  27  	{"getaccountaddress", returnsString},
  28  	{"getaddressesbyaccount", returnsStringArray},
  29  	{"getbalance", append(returnsNumber, returnsNumber[0])},
  30  	{"getbestblockhash", returnsString},
  31  	{"getblockcount", returnsNumber},
  32  	{"getinfo", []interface{}{(*btcjson.InfoWalletResult)(nil)}},
  33  	{"getnewaddress", returnsString},
  34  	{"getrawchangeaddress", returnsString},
  35  	{"getreceivedbyaccount", returnsNumber},
  36  	{"getreceivedbyaddress", returnsNumber},
  37  	{"gettransaction", []interface{}{(*btcjson.GetTransactionResult)(nil)}},
  38  	{"help", append(returnsString, returnsString[0])},
  39  	{"importprivkey", nil},
  40  	{"keypoolrefill", nil},
  41  	{"listaccounts", []interface{}{(*map[string]float64)(nil)}},
  42  	{"listlockunspent", []interface{}{(*[]btcjson.TransactionInput)(nil)}},
  43  	{"listreceivedbyaccount", []interface{}{(*[]btcjson.ListReceivedByAccountResult)(nil)}},
  44  	{"listreceivedbyaddress", []interface{}{(*[]btcjson.ListReceivedByAddressResult)(nil)}},
  45  	{"listsinceblock", []interface{}{(*btcjson.ListSinceBlockResult)(nil)}},
  46  	{"listtransactions", returnsLTRArray},
  47  	{"listunspent", []interface{}{(*btcjson.ListUnspentResult)(nil)}},
  48  	{"lockunspent", returnsBool},
  49  	{"sendfrom", returnsString},
  50  	{"sendmany", returnsString},
  51  	{"sendtoaddress", returnsString},
  52  	{"settxfee", returnsBool},
  53  	{"signmessage", returnsString},
  54  	{"signrawtransaction", []interface{}{(*btcjson.SignRawTransactionResult)(nil)}},
  55  	{"validateaddress", []interface{}{(*btcjson.ValidateAddressWalletResult)(nil)}},
  56  	{"verifymessage", returnsBool},
  57  	{"walletlock", nil},
  58  	{"walletpassphrase", nil},
  59  	{"walletpassphrasechange", nil},
  60  	{"createnewaccount", nil},
  61  	{"exportwatchingwallet", returnsString},
  62  	{"getbestblock", []interface{}{(*btcjson.GetBestBlockResult)(nil)}},
  63  	{"getunconfirmedbalance", returnsNumber},
  64  	{"listaddresstransactions", returnsLTRArray},
  65  	{"listalltransactions", returnsLTRArray},
  66  	{"renameaccount", nil},
  67  	{"walletislocked", returnsBool},
  68  }
  69  
  70  // Common return types.
  71  var returnsBool = []interface{}{(*bool)(nil)}
  72  
  73  // Common return types.
  74  var returnsLTRArray = []interface{}{(*[]btcjson.ListTransactionsResult)(nil)}
  75  
  76  // Common return types.
  77  var returnsNumber = []interface{}{(*float64)(nil)}
  78  
  79  // Common return types.
  80  var returnsString = []interface{}{(*string)(nil)}
  81  
  82  // Common return types.
  83  var returnsStringArray = []interface{}{(*[]string)(nil)}
  84