Getdepositscript - Revision history

Justusranvier at 13:38, 23 September 2014

2014-09-23T13:38:10Z

Justusranvier: Add version parameter.

2014-09-23T13:36:33Z

Add version parameter.

Justusranvier: add version status message

2014-09-05T17:14:39Z

add version status message

Justusranvier at 14:59, 5 September 2014

2014-09-05T14:59:53Z

Justusranvier: /* Description */

2014-09-04T17:52:12Z

‎Description

Justusranvier: /* Description */

2014-09-04T17:51:08Z

‎Description

Justusranvier: Move to new page

2014-09-04T17:16:45Z

Move to new page

New page

==Description==

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

===Arguments===

;[[Wallet_(blockchain)#Address_Identification|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 <code>PaymentDetails</code> field of a [[Payment_Protocol_(voting_pools)|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 2<sup>31</sup>.
;series not active
:The [[charter output]] for the pool is not located at the 0<sup>th</sup> [[change address]] for the given series, or the next series.

← Older revision		Revision as of 17:14, 5 September 2014
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===

← Older revision		Revision as of 14:59, 5 September 2014
Line 32:		Line 32:
	;series not active		;series not active
	:The [[charter output]] for the pool is not located at the 0<sup>th</sup> [[change address]] for the given series, or the next series.		:The [[charter output]] for the pool is not located at the 0<sup>th</sup> [[change address]] for the given series, or the next series.
		+
		+
		+	[[Category:Voting Pool Wallet API]]

@@ Line 7: / Line 7: @@
 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 <code>getdepositscript</code> call, it should update its [[lookahead window]] for the relevant [[branch]], ensuring it is watching all addresses in the branch between 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.
 ===Arguments===

← Older revision		Revision as of 17:51, 4 September 2014
Line 2:		Line 2:

	This call requests a deposit script suitable for a BIP70 [[PaymentRequest]] based on a specific address.		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 <code>getdepositscript</code> call, it should update its [[lookahead window]] for the relevant [[branch]], ensuring it is watching all addresses in the branch between 0 and the supplied address identifier.

	===Arguments===		===Arguments===

@@ Line 22: / Line 22: @@
 : the address for which the returned script should correspond
-===Return values===
+==Return values==
-====Data====
+===Data===
 ;deposit script
 :A string containing an output script suitable for being included in the <code>PaymentDetails</code> field of a [[Payment_Protocol_(voting_pools)|PaymentRequest]].
-====Errors====
+===Errors===
 ; incorrect version
 : The version specified in this call must match the version used of the relevant series

@@ Line 14: / Line 14: @@
 :This version of the specification contains is believed to be complete, but is still subject to revision before version 1
-===Arguments===
+==Arguments==
 ;[[Wallet_(blockchain)#Address_Identification|address identifier]]
@@ Line 27: / Line 30: @@
 ====Errors====
-;invalid pool
+; incorrect version
-:The given pool is not defined in the wallet.
+: The version specified in this call must match the version used of the relevant series
-;invalid series
+; invalid pool
-:The given series is not defined in the wallet.
+: The given pool is not defined in the wallet.
-;invalid branch
+; invalid series
-:The given branch is not defined in the wallet.
+: The given series is not defined in the wallet.
-;invalid index
+; invalid branch
-:The index supplied is not a positive integer between 0 an 2<sup>31</sup>.
+: The given branch is not defined in the wallet.
-;series not active
+; invalid index
-:The [[charter output]] for the pool is not located at the 0<sup>th</sup> [[change address]] for the given series, or the next series.
+: The index supplied is not a positive integer between 0 an 2<sup>31</sup>.
 [[Category:Voting Pool Wallet API]]