Skip to content

Commit 1ac2fda

Browse files
SomberNightSomberNight
committed
protocol-methods: split off altcoin stuff
1 parent 56a3c3c commit 1ac2fda

2 files changed

Lines changed: 378 additions & 367 deletions

File tree

‎docs/protocol-methods-altcoins.rst‎

Lines changed: 375 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,375 @@
1+
.. _Protocol Methods for altcoins:
2+
3+
=================================
4+
Protocol Methods (for altcoins)
5+
=================================
6+
7+
8+
Masternode methods (Dash and compatible coins)
9+
==============================================
10+
11+
12+
masternode.announce.broadcast
13+
=============================
14+
15+
Pass through the masternode announce message to be broadcast by the daemon.
16+
17+
Whenever a masternode comes online or a client is syncing, they will
18+
send this message which describes the masternode entry and how to
19+
validate messages from it.
20+
21+
**Signature**
22+
23+
.. function:: masternode.announce.broadcast(signmnb)
24+
25+
* *signmnb*
26+
27+
Signed masternode broadcast message in hexadecimal format.
28+
29+
**Result**
30+
31+
:const:`true` if the message was broadcasted successfully otherwise
32+
:const:`false`.
33+
34+
**Example**::
35+
36+
masternode.announce.broadcast("012b825a65a24e2eb8edadbe27c4716dab993bf1046a66da77268ec87dbdd9dfc80100000000ffffffff00000000000000000000ffff22db1fec42d82103bfc9e296bcf4d63eced97b204df8f7b2b90131d452abd2b50909fa2ce6f66d752103bfc9e296bcf4d63eced97b204df8f7b2b90131d452abd2b50909fa2ce6f66d754120e95f74e9c242776df88a586bd52d2bd1838b600e5f3ce9d45d04865ff39a994632d617e810a4480ce24c882980746bc517a92be027d2ea70e4baece33a763608b1f91e5b00000000451201002b825a65a24e2eb8edadbe27c4716dab993bf1046a66da77268ec87dbdd9dfc80100000000ffffffff57280bc007121a0db854998f72e9a9fd2a690f38abffbd9aa94256330c020000b0f91e5b00000000412027c03b1531ee14db6160a62a0cc8b1a7e93ae122bbc6f2dffec721e0ae308b0e19e68523dd429450612bda3a616b56411b4e35d098e25b7c83f19fd2d8537e970000000000000000")
37+
38+
**Example Result**::
39+
40+
true
41+
42+
masternode.subscribe
43+
====================
44+
45+
Returns the status of masternode.
46+
47+
**Signature**
48+
49+
.. function:: masternode.subscribe(collateral)
50+
51+
* *collateral*
52+
53+
The txId and the index of the collateral.
54+
55+
A masternode collateral is a transaction with a specific amount of
56+
coins, it's also known as a masternode identifier.
57+
58+
i.e. for DASH the required amount is 1,000 DASH or for $PAC is
59+
500,000 $PAC.
60+
61+
**Result**
62+
63+
As this is a subscription, the client will receive a notification
64+
when the masternode status changes.
65+
66+
The status depends on the server the masternode is hosted, the
67+
internet connection, the offline time and even the collateral
68+
amount, so this subscription notice these changes to the user.
69+
70+
**Example**::
71+
72+
masternode.subscribe("8c59133e714797650cf69043d05e409bbf45670eed7c4e4a386e52c46f1b5e24-0")
73+
74+
**Example Result**::
75+
76+
{'method': 'masternode.subscribe', u'jsonrpc': u'2.0', u'result': u'ENABLED', 'params': ['8c59133e714797650cf69043d05e409bbf45670eed7c4e4a386e52c46f1b5e24-0'], u'id': 19}
77+
78+
masternode.list
79+
===============
80+
81+
Returns the list of masternodes.
82+
83+
**Signature**
84+
85+
.. function:: masternode.list(payees)
86+
87+
* *payees*
88+
89+
An array of masternode payee addresses.
90+
91+
**Result**
92+
93+
An array with the masternodes information.
94+
95+
**Example**::
96+
97+
masternode.list("['PDFHmjKLvSGdnWgDJSJX49Rrh0SJtRANcE',
98+
'PDFHmjKLvSGdnWgDJSJX49Rrh0SJtRANcF']")
99+
100+
**Example Result**::
101+
102+
[
103+
{
104+
"vin": "9d298c00dae8b491d6801f50cab2e0037852cb556c5619ddb07c50421x9a31ab",
105+
"status": "ENABLED",
106+
"protocol": 70213,
107+
"payee": "PDFHmjKLvSGdnWgDJSJX49Rrh0SJtRANcE",
108+
"lastseen": "2018-04-01 12:34",
109+
"activeseconds": 1258000,
110+
"lastpaidtime": "2018-03-10 12:29",
111+
"lastpaidblock": 1234,
112+
"ip": "1.0.0.1",
113+
"paymentposition": 184,
114+
"inselection": true,
115+
"balance": 510350
116+
},
117+
{
118+
"vin": "9d298c00dae8b491d6801f50cab2e0037852cb556c5619ddb07c50421x9a31ac",
119+
"status": "ENABLED",
120+
"protocol": 70213,
121+
"payee": "PDFHmjKLvSGdnWgDJSJX49Rrh0SJtRANcF",
122+
"lastseen": "2018-04-01 12:34",
123+
"activeseconds": 1258000,
124+
"lastpaidtime": "2018-03-15 05:29",
125+
"lastpaidblock": 1234,
126+
"ip": "1.0.0.2",
127+
"paymentposition": 3333,
128+
"inselection": false,
129+
"balance": 520700
130+
},
131+
...,
132+
...,
133+
...,
134+
...
135+
]
136+
137+
138+
ProTx methods (Dash DIP3)
139+
==============================================
140+
141+
142+
protx.diff
143+
=============================
144+
145+
Returns a diff between two deterministic masternode lists.
146+
The result also contains proof data.
147+
148+
**Signature**
149+
150+
.. function:: protx.diff(base_height, height)
151+
152+
*base_height*
153+
154+
The starting block height
155+
156+
*1* <= *base_height*
157+
158+
*height*
159+
160+
The ending block height.
161+
162+
*base_height* <= *height*
163+
164+
165+
**Result**
166+
167+
A dictionary with deterministic masternode lists diff plus proof data
168+
169+
**Example**::
170+
171+
protx.diff(1, 20000)
172+
173+
**Example Result**::
174+
175+
{
176+
"baseBlockHash": "000000000b866e7fefc7df2b4b37f236175cee9ab6dc925a30c62401d92b7406",
177+
"blockHash": "0000000005b3f97e0af8c72f9a96eca720237e374ca860938ba0d7a68471c4d6",
178+
"cbTxMerkleTree": "0200000002c9802d02435cfe09e4253bc1ba4875e9a2f920d5d6adf005d5b9306e5322e6f476d885273422c2fe18e8c420d09484f89eaeee7bb7f4e1ff54bddeb94e099a910103",
179+
"cbTx": "03000500010000000000000000000000000000000000000000000000000000000000000000ffffffff4b02204e047867335c08fabe6d6d8b2b76b7000000000470393f63424273736170747365743a7265737574736574010000000000000010000015770000000d2f6e6f64655374726174756d2f000000000336c8a119010000001976a914cb594917ad4e5849688ec63f29a0f7f3badb5da688ac6c62c216010000001976a914a3c5284d3cd896815ac815f2dd76a3a71cb3d8e688acba65df02000000001976a9146d649e1c05e89d30809ef39cc8ee1002c0c8c84b88ac00000000260100204e0000b301c3d88e4072305bec5d09e2ed6b836b23af640bcdefd7b8ae7e2ca182dc17",
180+
"deletedMNs": [
181+
],
182+
"mnList": [
183+
{
184+
"proRegTxHash": "6f0bdd7034ce8d3a6976a15e4b4442c274b5c1739fb63fc0a50f01425580e17e",
185+
"confirmedHash": "000000000be653cd1fbc213239cfec83ca68da657f24cc05305d0be75d34e392",
186+
"service": "173.61.30.231:19023",
187+
"pubKeyOperator": "8da7ee1a40750868badef2c17d5385480cae7543f8d4d6e5f3c85b37fdd00a6b4f47726b96e7e7c7a3ea68b5d5cb2196",
188+
"keyIDVoting": "b35c75cbc69433175d3459843e1f6ebe145bf6a3",
189+
"isValid": true
190+
}
191+
],
192+
"merkleRootMNList": "17dc82a12c7eaeb8d7efcd0b64af236b836bede2095dec5b3072408ed8c301b3"
193+
}
194+
195+
protx.info
196+
=============================
197+
198+
Returns detailed information about a deterministic masternode.
199+
200+
**Signature**
201+
202+
.. function:: protx.info(protx_hash)
203+
204+
*protx_hash*
205+
206+
The hash of the initial ProRegTx.
207+
208+
**Result**
209+
210+
A dictionary with detailed deterministic masternode data
211+
212+
**Example**::
213+
214+
protx.info("6f0bdd7034ce8d3a6976a15e4b4442c274b5c1739fb63fc0a50f01425580e17e")
215+
216+
**Example Result**::
217+
218+
{
219+
"proTxHash": "6f0bdd7034ce8d3a6976a15e4b4442c274b5c1739fb63fc0a50f01425580e17e",
220+
"collateralHash": "b41439376b6117aebe6ad1ce31dcd217d4934fd00c104029ecb7d21c11d17c94",
221+
"collateralIndex": 3,
222+
"operatorReward": 0,
223+
"state": {
224+
"registeredHeight": 19525,
225+
"lastPaidHeight": 20436,
226+
"PoSePenalty": 0,
227+
"PoSeRevivedHeight": -1,
228+
"PoSeBanHeight": -1,
229+
"revocationReason": 0,
230+
"keyIDOwner": "b35c75cbc69433175d3459843e1f6ebe145bf6a3",
231+
"pubKeyOperator": "8da7ee1a40750868badef2c17d5385480cae7543f8d4d6e5f3c85b37fdd00a6b4f47726b96e7e7c7a3ea68b5d5cb2196",
232+
"keyIDVoting": "b35c75cbc69433175d3459843e1f6ebe145bf6a3",
233+
"ownerKeyAddr": "ybGQ7a6e7dkJY2jxdbDwdBtyjKZJ8VB7YC",
234+
"votingKeyAddr": "ybGQ7a6e7dkJY2jxdbDwdBtyjKZJ8VB7YC",
235+
"addr": "173.61.30.231:19023",
236+
"payoutAddress": "yWdXnYxGbouNoo8yMvcbZmZ3Gdp6BpySxL"
237+
},
238+
"confirmations": 984
239+
}
240+
241+
Name methods (Namecoin and compatible coins)
242+
==============================================
243+
244+
245+
blockchain.name.get_value_proof
246+
===============================
247+
248+
Returns a name resolution proof, suitable for low-latency (single round-trip) resolution.
249+
250+
**Signature**
251+
252+
.. function:: blockchain.name.get_value_proof(scripthash, cp_height)
253+
.. versionadded:: 1.4.3
254+
255+
*scripthash*
256+
257+
Script hash of the name being resolved.
258+
259+
*cp_height*
260+
261+
Checkpoint height.
262+
263+
264+
**Result**
265+
266+
A dictionary with transaction and proof data for each transaction associated with the name, from the most recent update back to either the registration transaction or a checkpointed transaction (whichever is later).
267+
268+
**Example**::
269+
270+
blockchain.name.get_value_proof(bdd490728e7f1cbea1836919db5e932cce651a82f5a13aa18a5267c979c95d3c, 518353)
271+
272+
**Example Result**::
273+
274+
{
275+
"bdd490728e7f1cbea1836919db5e932cce651a82f5a13aa18a5267c979c95d3c": [
276+
{
277+
"height": 607853,
278+
"tx": "00710000000102e3d236710b0a21cb9bb4c11d2a2ac6730e6e3c776773f688a53c14fc89ced5ab0100000000ffffffff261a3e3b04326e0dd33208d23e3119144f8cce8394de5757374a37323ee1b6060100000000ffffffff0240420f0000000000415309642f626974636f696e1d76657269667920323032322d30342d313620393a30353a3030204345546d7500144e5cafde0d7fd4f31323e14182a9c3412e026d88978d4e1400000000160014d1a61d11d434ca9197ae47b59a5f8933682140eb02473044022018129841dbd0e9700702b94dfaebee9f00a5e5dc847156faf992195c384a73a502204802754d4a7f406b3fb538d7f2a6c96967deb61eb87597e27dd30410b25e363401210261c92aa521e0e9660d605fff64129ada7faa6f2a201d9f82fd71b4a7ccd0cc230247304402200495ff83f6d2edc697abd3530eb16a315366cf4383225708826ab98c471e8a4b02207ef49122589aaf009e6c7515e04a2e5179263d6efb0f7043d871d3024aae136e0121020138a32ab1be1ae4ee0bf08a2dd6e7208f4e39f98312eebb09016a3fdf31978100000000",
279+
"tx_merkle": {
280+
"merkle": [
281+
"5b08bf9b8e8bff946da742641fc27c107096af5a05c0dcdec1848c3f7423a746",
282+
"11c88190df88b334f2ce38e7034c1d1caec2e9fccb226ff3229c6440b7a94e6f",
283+
"ce68ac63e88da5554218cdd7e6811088b1189ab8635bda557044c0518d174d1d"
284+
],
285+
"pos": 1
286+
}
287+
},
288+
{
289+
"height": 597196,
290+
"tx": "00710000000102c575b325030f89a7515596c2661967b02ff5a2594ba0a4774833d6bd6bdd41ca0000000000feffffff8afb31ffd43385ff4477c28d81f0dd43e6fc6cc63fe56f7d87733c1de7d67eaa0000000000feffffff028327374a010000001600142715d587d4c8e3edddbac11417b736964c519c6440420f00000000002c5309642f626974636f696e0872657365727665646d750014e893563837316a53cb00c99e13a8079f311173a9024730440220597930ab6071d009ec05e14a9247cbbae4f31c7e3c4e812a995e873eb31646ac02204236ad5e2ee4b72e25428c3e5d70dd9dc387e96bd5dab1f921c6a3dbe7b3f4a8012103549f0ee91a8ce86087fc05862fb06247affca4688d4c6ab166eb9d1531357da90247304402204f48be0eab589fb08acc3cd9281f2c23a742c7745f374176978d7ff1ccf3fd39022052c66eaabab908d7c332083fc88cf863bcf0aea574a1aba6b2dc8106bf0c455a012103877c7f65da9ecc3bd126ee9126b9a03569c2eaebd9b9ef7a30989327321231a7cb1c0900",
291+
"tx_merkle": {
292+
"merkle": [
293+
"bee7bcd954879e9110b019617f443a31f51210b4c841a577abc84dae583a115e",
294+
"e412f9f6832238fc209fddb2f7aeeedb939e252e0b4a8f7df4b3c509d2b0233e",
295+
"63e144e0a0726cf8cc9a8c776e6411fc5dfb7f225730bddba0c6a3ab656b3bcd",
296+
"b5c75bfaaec4c2029b5b175168f9b91af766581dd8496d1184a44e432b20d1fb",
297+
"4905bf1dc9fbedb16ccacd26a0f406fc62c53b860ac099369010ec610521c4af",
298+
"3e74dbd7730487df73e07c1fa03b25355c82fbbbd81b35bf28cc8322dda9f3bb"
299+
],
300+
"pos": 38
301+
}
302+
},
303+
{
304+
"height": 563168,
305+
"tx": "007100000001026bfeb4ee7d7a5ab62b2e16abf439173a460ac013ee19a0115c26569673eb71eb0000000000feffffff6cee0ee75d60d1a02671d7d2e15e8a8c19045e15d9c6738f76395e8de63ccca30000000000feffffff0240420f00000000002c5309642f626974636f696e0872657365727665646d750014b1cfea8dbd1de3e2e0640b42838f1078f73c050d44d13f4a01000000160014d40f8f5b62c73e2167540001aa1634e60c27fa5a0247304402200207688a4c8e1ca3c093a81f862a0192a94590b2ff4e829564b164ca82b9fada02203ff970582e49ac3d0a8452d211903ba8405153ac556f0a46cfea2d0f3faff182012103cac6fecff4c3a06c71e429dc29a6bea58e42adcc283e5f98e66cb550d6d145df02473044022009e2ec71addf23c21df3034561997aac6e5c7700ac6dd44fcba6157afb865ca202203ad3ff0484f94a405c175184fa9a9ccb6fc8ceab67edc1dba314432e76757d6d01210289706af81a776c60a088ae35021142325f17f81da5778667a172dd1a92e1a644df970800",
306+
"tx_merkle": {
307+
"merkle": [
308+
"9ed4efd8e6b1cf9773db60ef0ad7213ce4282f56df709dd8c69ab2caf466f23b",
309+
"5cb725f78154e33288b724a59cd6c0146ffb8d0e39ace6f1333479a6eafcb76c",
310+
"596f00ade273423324821e88c8b99fbe7274470d04c062a0453c7ec1db1086d2",
311+
"7dfcb41cabce612dc5ab7c4309ada78dbab9dc977321147b2a82ddaae7eb5d02",
312+
"45d7679dc5e8f92f314b9776ac93e0dcb92015c989c076326511d5a5be5e4a17",
313+
"ef5096cd39456fe5850c221ad6ec722e11820aa4f6e1773c380e6718e68625e7"
314+
],
315+
"pos": 26
316+
}
317+
},
318+
{
319+
"height": 528949,
320+
"tx": "0071000000010234f902ef0f953862bb9ba5b6e9fc1a8a914d8b5b1b9af89e843d85176318c5ff0000000000feffffff24802c9ae06cd5af3dd11bdb653b5df4e9cc6a7bb27b4f1cac13a16fd5249e9b0000000000feffffff0240420f00000000002c5309642f626974636f696e0872657365727665646d750014004b1245eb3ac8724d0bc684e15859c9d5eb9ddabfa39e4a0100000016001440fb148f07ff3c8b1d801628754d8ec5cbe1f7e70247304402203ec1e1907ecefd90180b1f7f9fec4a10b75fdb21a85f0df28ea8fe48419338760220549bebe6b96869eeb3175de8149cd127a42bdb344945bd32571950a1e5df40210121020d0bb22a3730f1de67b87af7e2e5517c7649932e4ad8105817372fd99ca1ce8102473044022013d238876040649429f29f5df08712a3b7439db436e7c7a42e38a2d8c733d05402201475420bfea26e684a4bd488ba6ef0b954ca703234d1536b7a545c55d53759e501210321307ece7f4731fef37b0208807ce1a04d1013c765fef1567752df06e5d7bfe233120800",
321+
"tx_merkle": {
322+
"merkle": [
323+
"0c1a965febb58cd57e8019e6b437f5124968b15855c3066c60a36ae863a900a6",
324+
"643623318b6409171edb487dc6f14ea56db8956c0bc958abf524ddcf845fd805",
325+
"1eeb4f63067c4b9ccba24eb717887b3b1f7b95f60ab461b04a785b57251d62d9",
326+
"94baa94fe1153cc616420bb17bbad79591b409405f8d670b8a1f188e1eda3bc8",
327+
"bdc4cc1c882e039866939b0ac0c923d1581de93fba1ff1140d3ddc616d1a768d",
328+
"ac9dbfac19c216f593a932dafe813c3a9ad1d706fdeb2406a0c39db0209cba2c"
329+
],
330+
"pos": 42
331+
}
332+
},
333+
{
334+
"height": 495000,
335+
"tx": "007100000001020489c88ef8f718c9ac94bef1424986bfeaa79ec1b66e28841d3de4c3e8238e7f000000006a47304402200b3c3b859fe978f69cadb516e563122ef27fb68dcfea641cbfe69b4c71866cda02206a56c2e1d113e2032cb67a3b506a74ebbdaabca51b3601d9e269042ccce2c3ba012102184feeaa11d4a2ecc0f5c34c10222f6c858d33148c330ad115515d697c77d01efeffffffda3ec65cd0f1d8a5e3b56237993f53c5e1cacc9adec82a808a718023e3592c9a0000000000feffffff0240420f00000000002c5309642f626974636f696e0872657365727665646d75001417e6be040f4b08e4e161db3c27c1dc46b235bba8135a750100000000160014b9667261ba2f8127240b1de27515734bdd5761c00002473044022077d5fc03bdcdd0ced102c2b04ef67d8d9398cc03243f70cef59cbcdae6df0bc202200510a7bc5dc8d8a89dcc16575041912e9fa8913846c1c4ec796c95400ef346d301210330b9946e3a7aaf15858119423ca8cec8bb71e71267e8531feccbeb941abe2e17978d0700",
336+
"tx_merkle": {
337+
"merkle": [
338+
"b87f44bf986dccd425caf731ab403f5d423689977ac15a8d6204e0c8bbf00cf7",
339+
"f1182408914fa2c86f935ed14a9925a4a20f077b56610131f995b45230155713",
340+
"78d090050c52d44bf36a99ee4b884a95b6da8fb764fc6e383c6f7b5a4a8ff8be",
341+
"523dc9ce6021858807700836f65b2b3bf8ea701d723b979afff6ea0cf096815f",
342+
"0c7c131ab0bf11ba122af39d63a4483b4dbc845a33b507bce7cc0bcefee6d724",
343+
"a2e5f09a5663c567471571d91c2f8cbd4270d286e772067573439f93e8b4befa",
344+
"820fbb93b424b3e67602ce2b4136764080f5329b46bc671b97553e2340588e0c"
345+
],
346+
"pos": 11
347+
},
348+
"header": {
349+
"header": "040101003c59eef5329201b1f077d6f8b832b8200cbe9aff82feb75cf5e5bf3240eed8750768161b62133b7b758fe6a724362e3e5948ff4ba3e59098336d057a24d8bd4c37a7535e2394131700000000",
350+
"branch": [
351+
"c28a169077edcec70fbb74dac6c64229e862a286fcc22f8695eeb268e7b454a1",
352+
"7de3af1dce3faf8c93f40608f257a00c042cd13a2b7f5635454079931254602e",
353+
"9e1f18e383256e49872da0ed2affac378baba7566f2ea0abf6b06d156b331d91",
354+
"52f09f8d938efcc083643da4171ff0eb77a48dfbbe6ba801494caeb33dd8f2f4",
355+
"a591862302cb03aebf74fcf9bf552d0ebe50634816719459669532e1f5122d19",
356+
"2f17efd7c29f3e5f2fc10d494a4dc8cd1e1346fc6848b5f8f053d6133b56af5e",
357+
"6b1656ebb4b82071b85a6bb6bbf64106f7f9cbd60531d8bbfa665d2d02eae9b0",
358+
"1841b9a4bc6782948ec92bdbb93c0c8a330728052547f1b2ecd38a2adcff310b",
359+
"8f5675ecfbdc76c4516f6b110e43b3dd66adb73d2d7f01957055973b832210fa",
360+
"ede6544bcc09e29229bfaf7d099503172a7826174473816805891b5381dcae3e",
361+
"9c9a8d5d2d3a7888bedc7906d22ebdd73f684cbc14c435aa4543ad18d56a4ef7",
362+
"98f0e303e64ddfce18ee0ea9aaf95cecc0d6b849c2d6eb772aba3bf984660601",
363+
"96c3e6226d5608ccf0a8f3e02d20a258044c9fedb726b041eb94d1d3112cfeb0",
364+
"f71672e8b1d7621fbf2462e89b0c8d5af91efee7c9de54587acb7d705a8d4659",
365+
"f9188789442cfeff1955b5030d82317fd77133524bcc4be4e3c24bd857a4925e",
366+
"7b920859b50d0030c18725888aac05e7edea5bb4f4d3cadd5d6e71fe52a9ebac",
367+
"e1185d87453a4392ff4d4aea556597bc1b0a1a6320714f364410a73aa136d7aa",
368+
"345a13ed174cc91593862162fab8610ed84d5dd9cfc1533fd604d812cb13a699",
369+
"88191322193a9f6ae984009b694edd97670795c8afb130082cf90cd4640e5701"
370+
],
371+
"root": "476a138d228b66a094c20d5bbaea3230ea60201ba16af81500c5f368b06dc48b"
372+
}
373+
}
374+
]
375+
}

0 commit comments

Comments
 (0)