Document API #26

Open
opened 2 years ago by duke · 1 comments
duke commented 2 years ago
Owner

Zcash never documented the lightwalletd API. I will roughly document on this issue all the API methods that SDL uses so that devs can use the docs to implement SDA talking to lightwalletd

API methods

addresses

get a list of addresses

import

import a zaddr

timport

import a taddr

notes

fetch unspent zutxos

new(type)

create a new address. if type=="zs" it's a zaddr, if type=="R" it's a taddr

sietch(type)

create a new sietch zaddr. only type=="zs" is supported

export(addr)

get the private key of an address

export()

expport all privkeys for taddrs + zaddrs

seed

get seedphrase of wallet

balance

get wallet balance

list

get transaction list

save

save wallet

clear

clears wallet

unlock(password)

unlocks wallet with password

encryptionstatus

get status of wallet encryption, i.e if it's encrypted or decrypted

encrypt(password)

encrypt wallet with password

decrypt(password)

remove wallet encryption

send(params)

send a transaction specified by params

info

similar to getinfo, some basic status info

height

get latest block height

sync_status

Get sync status. JSON response contains keys synced_blocks and total_blocks

sync

Sync to latest block.

shield

shield funds from a taddr to zaddr

coinsupply

get coinsupply status

Zcash never documented the lightwalletd API. I will roughly document on this issue all the API methods that SDL uses so that devs can use the docs to implement SDA talking to lightwalletd # API methods ## addresses get a list of addresses ## import import a zaddr ## timport import a taddr ## notes fetch unspent zutxos ## new(type) create a new address. if type=="zs" it's a zaddr, if type=="R" it's a taddr ## sietch(type) create a new sietch zaddr. only type=="zs" is supported ## export(addr) get the private key of an address ## export() expport all privkeys for taddrs + zaddrs ## seed get seedphrase of wallet ## balance get wallet balance ## list get transaction list ## save save wallet ## clear clears wallet ## unlock(password) unlocks wallet with password ## encryptionstatus get status of wallet encryption, i.e if it's encrypted or decrypted ## encrypt(password) encrypt wallet with password ## decrypt(password) remove wallet encryption ## send(params) send a transaction specified by params ## info similar to getinfo, some basic status info ## height get latest block height ## sync_status Get sync status. JSON response contains keys `synced_blocks` and `total_blocks` ## sync Sync to latest block. ## shield shield funds from a taddr to zaddr ## coinsupply get coinsupply status
Collaborator
Adding Zcash docs here for reference https://zcash.readthedocs.io/en/latest/rtd_pages/lightclient_support.html https://zcash.readthedocs.io/en/latest/lightwalletd/index.html
Sign in to join this conversation.
No Label
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Loading…
There is no content yet.