{ "openrpc": "1.0.0-rc1", "info": { "version": "0.1.0", "title": "Zenith RPC", "description": "The RPC methods to interact with the Zenith Zcash wallet", "license": { "name": "MIT" } }, "servers": [ { "name": "Zenith RPC", "summary": "The Zenith wallet RPC server", "description": "This is the server that allows programmatic interaction with the Zenith Zcash wallet via RPC", "url": "http://localhost:8234" } ], "methods": [ { "name": "getinfo", "tags": [ { "$ref": "#/components/tags/information" }], "result" : { "name": "Zenith information", "schema": { "$ref": "#/components/schemas/ZenithInfo" } }, "params" : [], "examples": [ { "name": "GetInfo example", "summary": "Get information from Zenith", "description": "Gets the status of the Zenith wallet server", "params": [], "result": { "name": "GetInfo result", "value": { "version": "0.7.0.0-beta", "network": "TestNet", "zebraVersion": "v1.8.0" } } } ], "errors": [ { "$ref": "#/components/errors/ZebraNotAvailable" } ] }, { "name": "listwallets", "tags": [ { "$ref": "#/components/tags/wallet" }], "result": { "name": "Wallets", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ZcashWallet" } } }, "params": [], "examples": [ { "name": "ListWallets example", "summary": "Get list of wallets", "description": "Get the list of wallets available in Zenith for the current network (Mainnet/Testnet)", "params": [], "result": { "name": "ListWallets result", "value": [ { "birthday": 2762066, "index": 1, "lastSync": 2919374, "name": "Main", "network": "TestNet" }, { "birthday": 2798877, "index": 2, "lastSync": 2894652, "name": "zcashd", "network": "TestNet" } ] } } ], "errors": [ { "$ref": "#/components/errors/ZebraNotAvailable" }, { "$ref": "#/components/errors/NoWallets" } ] } ], "components": { "contentDescriptors": {}, "schemas": { "ZenithInfo": { "type": "object", "properties": { "version": { "type": "string", "description": "Zenith's version"}, "network": { "type": "string", "description": "The network the wallet is connected to"}, "zebraVersion": { "type": "string", "description": "The version of the Zebra node used by Zenith"} } }, "ZcashWallet": { "type": "object", "properties": { "index": { "type": "integer", "description": "Internal index of wallet"}, "name": { "type": "string", "description": "User-friendly name of the wallet" }, "network": { "type": "string", "description": "Network the wallet is for. Testnet or MainNet" }, "birthday": { "type": "integer", "description": "Wallet's birthday height" }, "lastSync": { "type": "integer", "description": "Last block the wallet is synced to" } } } }, "examples": {}, "tags": { "information": {"name": "Information"}, "wallet": {"name": "Wallet"} }, "errors": { "ZebraNotAvailable": { "code": -32000, "message": "Zebra not available" }, "NoWallets": { "code": -32001, "message": "No wallets available. Please create one first" } } } }