README
¶
zcashjson
zcashrpcclient provides zcashjson, a package that extends btcsuite/btcd/btcjson to support the Zcash RPC.
Documentation
¶
Index ¶
- type ZExportKeyCmd
- type ZExportWalletCmd
- type ZGetBalanceCmd
- type ZGetNewAddressCmd
- type ZGetOperationResultCmd
- type ZGetOperationStatusCmd
- type ZGetOperationStatusResult
- type ZGetTotalBalanceCmd
- type ZGetTotalBalanceResult
- type ZImportKeyCmd
- type ZImportWalletCmd
- type ZListAddressesCmd
- type ZListOperationIdsCmd
- type ZListReceivedByAddressCmd
- type ZListReceivedByAddressResult
- type ZOperationStatusError
- type ZSendManyCmd
- type ZSendManyEntry
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ZExportKeyCmd ¶
type ZExportKeyCmd struct {
Address string
}
ZExportKeyCmd defines the z_exportkey JSON-RPC command.
func NewZExportKeyCmd ¶
func NewZExportKeyCmd(address string) *ZExportKeyCmd
NewZExportKeyCmd returns a new instance which can be used to issue a z_exportkey JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZExportWalletCmd ¶
type ZExportWalletCmd struct {
Filename string
}
ZExportWalletCmd defines the z_exportwallet JSON-RPC command.
func NewZExportWalletCmd ¶
func NewZExportWalletCmd(filename string) *ZExportWalletCmd
NewZExportWalletCmd returns a new instance which can be used to issue a z_exportwallet JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZGetBalanceCmd ¶
ZGetBalanceCmd defines the z_getbalance JSON-RPC command.
func NewZGetBalanceCmd ¶
func NewZGetBalanceCmd(address *string, minConf *int) *ZGetBalanceCmd
NewZGetBalanceCmd returns a new instance which can be used to issue a z_getbalance JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZGetNewAddressCmd ¶
type ZGetNewAddressCmd struct {
MinConf *int `jsonrpcdefault:"1"`
}
ZGetNewAddressCmd defines the z_getnewaddress JSON-RPC command.
func NewZGetNewAddressCmd ¶
func NewZGetNewAddressCmd() *ZGetNewAddressCmd
NewGetNewAddressCmd returns a new instance which can be used to issue a getnewaddress JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZGetOperationResultCmd ¶
type ZGetOperationResultCmd struct {
MinConf *int `jsonrpcdefault:"1"`
}
ZGetOperationResultCmd defines the z_getoperationresult JSON-RPC command.
func NewZGetOperationResultCmd ¶
func NewZGetOperationResultCmd(minConf *int) *ZGetOperationResultCmd
ZGetOperationResultCmd returns a new instance which can be used to issue a z_getoperationresult JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZGetOperationStatusCmd ¶
type ZGetOperationStatusCmd struct {
MinConf *int `jsonrpcdefault:"1"`
}
ZGetOperationStatusCmd defines the z_getoperationstatus JSON-RPC command.
func NewZGetOperationStatusCmd ¶
func NewZGetOperationStatusCmd(minConf *int) *ZGetOperationStatusCmd
ZGetOperationStatusCmd returns a new instance which can be used to issue a z_getoperationstatus JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZGetOperationStatusResult ¶
type ZGetOperationStatusResult struct {
Id string `json:"id"`
Status string `json:"status"`
CreationTime int `json:"creation_time"`
Result map[string]string `json:"result"`
Error ZOperationStatusError `json:"error"`
ExecutionSecs float64 `json:"execution_secs"`
}
ZGetOperationStatusResult models the data from the z_getoperationresult and z_getoperationstatus commands.
type ZGetTotalBalanceCmd ¶
type ZGetTotalBalanceCmd struct {
MinConf *int `jsonrpcdefault:"1"`
}
ZGetTotalBalanceCmd defines the z_gettotalbalance JSON-RPC command.
func NewZGetTotalBalanceCmd ¶
func NewZGetTotalBalanceCmd() *ZGetTotalBalanceCmd
NewZGetTotalBalanceCmd returns a new instance which can be used to issue a z_gettotalbalance JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZGetTotalBalanceResult ¶
type ZGetTotalBalanceResult struct {
Transparent string `json:"transparent"`
Private string `json:"private"`
Total string `json:"total"`
}
ZGetTotalBalanceResult models the data from the z_gettotalbalance command.
type ZImportKeyCmd ¶
ImportKeyCmd defines the z_importkey JSON-RPC command.
func NewZImportKeyCmd ¶
func NewZImportKeyCmd(zkey string, rescan *bool) *ZImportKeyCmd
NewImportKeyCmd returns a new instance which can be used to issue a z_importkey JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZImportWalletCmd ¶
type ZImportWalletCmd struct {
Filename string
}
ZImportWalletCmd defines the z_importwallet JSON-RPC command.
func NewZImportWalletCmd ¶
func NewZImportWalletCmd(filename string) *ZImportWalletCmd
NewZImportWalletCmd returns a new instance which can be used to issue a z_importwallet JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZListAddressesCmd ¶
type ZListAddressesCmd struct {
MinConf *int `jsonrpcdefault:"1"`
}
ZListAccountsCmd defines the z_listaccounts JSON-RPC command.
func NewZListAddressesCmd ¶
func NewZListAddressesCmd(minConf *int) *ZListAddressesCmd
NewZListAccountsCmd returns a new instance which can be used to issue a z_listaccounts JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZListOperationIdsCmd ¶
type ZListOperationIdsCmd struct {
MinConf *int `jsonrpcdefault:"1"`
}
ZListOperationIdsCmd defines the z_listoperationids JSON-RPC command.
func NewZListOperationIdsCmd ¶
func NewZListOperationIdsCmd(minConf *int) *ZListOperationIdsCmd
ZListOperationIdsCmd returns a new instance which can be used to issue a z_listoperationids JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZListReceivedByAddressCmd ¶
ZListReceivedByAddressCmd defines the z_listreceivedbyaddress JSON-RPC command.
func NewZListReceivedByAddressCmd ¶
func NewZListReceivedByAddressCmd(address string, minConf *int) *ZListReceivedByAddressCmd
NewZListReceivedByAddressCmd returns a new instance which can be used to issue a z_listreceivedbyaddress JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZListReceivedByAddressResult ¶
type ZListReceivedByAddressResult struct {
TxID string `json:"txid"`
Amount float64 `json:"amount"`
Memo string `json:"memo"`
}
ZListReceivedByAddressResult models the data from the z_listreceivedbyaddress command.
type ZOperationStatusError ¶
ZOperationStatusError models the error data in ZGetOperationStatusResult.
type ZSendManyCmd ¶
type ZSendManyCmd struct {
FromAccount string
Amounts []ZSendManyEntry `jsonrpcusage:"{\"address\":address,\"amount\":amount,...}"`
MinConf *int `jsonrpcdefault:"1"`
}
ZSendManyCmd defines the z_sendmany JSON-RPC command.
func NewZSendManyCmd ¶
func NewZSendManyCmd(fromAccount string, amounts []ZSendManyEntry, minConf *int) *ZSendManyCmd
NewZSendManyCmd returns a new instance which can be used to issue a z_sendmany JSON-RPC command.
The parameters which are pointers indicate they are optional. Passing nil for optional parameters will use the default value.
type ZSendManyEntry ¶
type ZSendManyEntry struct {
Address string `json:"address"`
Amount float64 `json:"amount"`
Memo *string `json:"memo"`
}
ZSendManyEntry models the inputs for the z_sendmany command.
Source Files