kylefang/stacks-puppet-node
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-puppet-node.git synced 2026-04-24 03:45:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

updating docs for persistent setting of keys over REST

Browse Source
This commit is contained in:
Aaron Blankstein
2017-08-17 18:16:23 -04:00
parent 17d6043731
commit d026940601
2 changed files with 92 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
docs/api-specs.md
View File

@@ -485,14 +485,20 @@ Returns core node's payment address.
## Set a specific wallet key [PUT /v1/wallet/keys/{keyname}]
This call instructs the blockstack core node to use a particular key
instead of the core node's configured wallet key. The setting of this
key is *temporary*. It is not written to `~/.blockstack/wallet.json`,
and on a subsequent restart, the key will return to the original key.
However, the core registrar *tracks* the owner key used for each `PREORDER`,
and stores that private key encrypted (with `scrypt` and the core wallet
password) in the queue. When the registrar detects that the key being used
for a particular name has changed, it will recover by submitting further
key is *temporary* by default, meaning that it is not written to
`~/.blockstack/wallet.json`, and on a subsequent restart, the key will
return to the original key. However, the core registrar *tracks* the
owner key used for each `PREORDER`, and stores that private key
encrypted (with `scrypt` and the core wallet password) in the
queue. When the registrar detects that the key being used for a
particular name has changed, it will recover by submitting further
transactions with the stored key.
However, for blockstack core >= 0.14.5, the `persist_change` keyword
will instruct the core node to write the changed key to
`~/.blockstack/wallet.json`. In this mode, the node will backup the
previous wallet to `~/.blockstack/wallet.json.prior.<timestamp>`
+ Requires root authorization
+ Parameters
+ keyname: owner (string) - which key to set (one of 'owner', 'data', 'payment')
@@ -504,52 +510,112 @@ transactions with the stored key.
+ Request (application/json)
+ Schema
{
"type" : "object",
"properties" : {
"private_key" : {
"anyOf": [
{
"anyOf": [
{
"pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$",
"type": "string"
},
{
"pattern": "^([0-9a-fA-F]+)$",
"type": "string"
}
]
},
{
"properties": {
"address": {
"pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$",
"type": "string"
},
"private_keys": {
"items": {
"anyOf": [
{
"pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$",
"type": "string"
},
{
"pattern": "^([0-9a-fA-F]+)$",
"type": "string"
}
]
},
"type": "array"
},
"redeem_script": {
"pattern": "^([0-9a-fA-F]+)$",
"type": "string"
}
},
"required": [
"address",
"redeem_script",
"private_keys"
],
"type": "object"
}
]
},
"persist_change" : {"type" : "boolean"}
},
"required" : [ "private_key" ]
}
+ Request (application/json)
+ Schema
{
"anyOf": [
{
"anyOf": [
{
"pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$",
"pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$",
"type": "string"
},
},
{
"pattern": "^([0-9a-fA-F]+)$",
"pattern": "^([0-9a-fA-F]+)$",
"type": "string"
}
]
},
},
{
"properties": {
"address": {
"pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$",
"pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$",
"type": "string"
},
},
"private_keys": {
"items": {
"anyOf": [
{
"pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+)$",
"type": "string"
},
},
{
"pattern": "^([0-9a-fA-F]+)$",
"pattern": "^([0-9a-fA-F]+)$",
"type": "string"
}
]
},
},
"type": "array"
},
},
"redeem_script": {
"pattern": "^([0-9a-fA-F]+)$",
"pattern": "^([0-9a-fA-F]+)$",
"type": "string"
}
},
},
"required": [
"address",
"redeem_script",
"address",
"redeem_script",
"private_keys"
],
],
"type": "object"
}
]