Difference between revisions of "Thawseries"

From Open Transactions
Jump to navigation Jump to search
(Move to new page)
 
(Add version argument, argument names and descriptions)
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
 
This call adds an extended private key to an existing series. The [[Wallet (blockchain)|blockchain wallet]] takes the provided [[xpriv]] and applies it to the correct [[branch]] corresponding to its [[xpub]].
 
This call adds an extended private key to an existing series. The [[Wallet (blockchain)|blockchain wallet]] takes the provided [[xpriv]] and applies it to the correct [[branch]] corresponding to its [[xpub]].
  
===Arguments===
+
==Status==
  
[[Wallet_(blockchain)#Series_Identifier|series identifier]]
+
;Version 1 Release candidate
 +
:This version of the specification contains is believed to be complete, but is still subject to revision before version 1
  
[[xpriv]]
+
==Arguments==
  
===Return Values===
+
; version
 +
: Currently required to be 1. May be incremented for future expansions to the voting pool specification.
  
====Data====
+
; series
 +
: A [[Wallet_(blockchain)#Series_Identifier|series identifier]] for the series containing the [[xpub|extended public key]] (xpub) to be made capable of signing transactions.
 +
 
 +
; key
 +
: The [[xpriv|extended private key]] (xpriv) which empowers an xpub in the specified series.
 +
 
 +
==Return Values==
 +
 
 +
===Data===
  
 
none
 
none
  
====Errors====
+
===Errors===
;Success
+
 
:The wallet has successfully added the xpriv to its corresponding xpub in the given series.
+
; Success
;Invalid series
+
: The wallet has successfully added the xpriv to its corresponding xpub in the given series.
:The supplied series is not defined in the wallet.
+
; Incorrect version
;No matching pubkey
+
: The supplied version does not match the version of the series being thawed.
:None of the xpubs in the supplied series match the supplied xpriv.
+
; Invalid series
;Invalid privkey
+
: The supplied series is not defined in the wallet.
:The supplied xpriv is not a valid [[BIP32]] extended private key.
+
; No matching pubkey
 +
: None of the xpubs in the supplied series match the supplied xpriv.
 +
; Invalid privkey
 +
: The supplied xpriv is not a valid [[BIP32]] extended private key.
  
 
[[Category:Voting Pool Wallet API]]
 
[[Category:Voting Pool Wallet API]]

Latest revision as of 13:47, 23 September 2014

Description

This call adds an extended private key to an existing series. The blockchain wallet takes the provided xpriv and applies it to the correct branch corresponding to its xpub.

Status

Version 1 Release candidate
This version of the specification contains is believed to be complete, but is still subject to revision before version 1

Arguments

version
Currently required to be 1. May be incremented for future expansions to the voting pool specification.
series
A series identifier for the series containing the extended public key (xpub) to be made capable of signing transactions.
key
The extended private key (xpriv) which empowers an xpub in the specified series.

Return Values

Data

none

Errors

Success
The wallet has successfully added the xpriv to its corresponding xpub in the given series.
Incorrect version
The supplied version does not match the version of the series being thawed.
Invalid series
The supplied series is not defined in the wallet.
No matching pubkey
None of the xpubs in the supplied series match the supplied xpriv.
Invalid privkey
The supplied xpriv is not a valid BIP32 extended private key.