Difference between revisions of "Getdepositscript"

From Open Transactions
Jump to navigation Jump to search
m
(add version status message)
Line 8: Line 8:
  
 
When a wallet receives a valid <code>getdepositscript</code> call, it should update its [[lookahead window]] for the relevant [[branch]], ensuring it is watching all addresses in the branch between index 0 and the supplied address identifier.
 
When a wallet receives a valid <code>getdepositscript</code> call, it should update its [[lookahead window]] for the relevant [[branch]], ensuring it is watching all addresses in the branch between index 0 and the supplied address identifier.
 +
 +
==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===
 
===Arguments===

Revision as of 17:14, 5 September 2014

Description

This call requests a deposit script suitable for a BIP70 PaymentRequest based on a specific address.

Deposit scripts may only be requested from active series, as indicated by the location of the charter output.

All auditors in a voting pool will request the deposit script for every bailment message they see, and compare the script to the corresponding initiatedBailment message.

When a wallet receives a valid getdepositscript call, it should update its lookahead window for the relevant branch, ensuring it is watching all addresses in the branch between index 0 and the supplied address identifier.

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

address identifier
the address for which the returned script should correspond

Return values

Data

deposit script
A string containing an output script suitable for being included in the PaymentDetails field of a PaymentRequest.

Errors

invalid pool
The given pool is not defined in the wallet.
invalid series
The given series is not defined in the wallet.
invalid branch
The given branch is not defined in the wallet.
invalid index
The index supplied is not a positive integer between 0 an 231.
series not active
The charter output for the pool is not located at the 0th change address for the given series, or the next series.