/
factomd.js
591 lines (557 loc) · 16.5 KB
/
factomd.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
var got = require('got')
var postoptions = {
body: {},
json: true,
headers: {
'content-type': 'text/plain'},
retries: 3,
timeout: 2000
}
// const URL_BASE = 'https://courtesy-node.factom.com/v2'
var URL = 'http://courtesy-node.factom.com/v2'
// var URL = 'http://courtesy-node.factom.com'
/**
* Set the URL of the factom node.
* @method setFactomNode
* @param {url} url of the factom node
*/
function setFactomNode (url) {
URL = url
}
/**
* Set the timeout of the JSON request to the factom node
* @method setTimeout
* @param {Number} timeout Set the timeout in milliseconds
*/
function setTimeout (timeout) {
postoptions.timeout = timeout
}
/**
* Utility commands for dispatching JSON commands to the factom server.
* @method dispatch
* @param {Array} jdata
* @param {function} cb function(data,response) as specified by the restler API
*/
function dispatch (jdata) {
var opts = postoptions
opts.body = jdata
// console.log('============++++ ++++============')
// console.log(jdata)
// console.log('============++++ ++++============')
return got.post(URL, opts)
.then(response => {
return response.body
})
.catch(error => {
return error.response.body
})
}
/**
* The directory block head is the last known directory block by factom,
* or in other words, the most recently recorded block.
* @method directoryBlock
* @param {Number} id Arbitrary reference id
* @param {String} keymr
* @param {function} cb function(data,response) as specified by the restler API
*/
function directoryBlock (id, keymr) {
var jdata = { 'jsonrpc': '2.0',
'id': id,
'method': 'directory-block',
'params': {
'KeyMR': keymr
}}
return dispatch(jdata)
}
/**
* The directory block head is the last known directory block by factom,
* or in other words, the most recently recorded block.
* @method directoryBlockHead
* @param {Number} id arbitrary reference id
* @param {function} cb function(data,response) as specified by the restler API
*/
function directoryBlockHead (id) {
var jdata = {'jsonrpc': '2.0', 'id': id, 'method': 'directory-block-head'}
return dispatch(jdata)
}
/**
* Returns various heights that allows you to view the state of the blockchain.
* https://docs.factom.com/api#heights
* @method heights
* @param {Number} id arbitrary reference id
* @param {function} cb function(data,response) as specified by the restler API
*/
function heights (id) {
var jdata = {'jsonrpc': '2.0', 'id': id, 'method': 'heights'}
return dispatch(jdata)
}
/**
* Retrieve an entry or transaction in raw format, the data is a hex encoded string.
* https://docs.factom.com/api#raw-data
* @method rawData
* @param {Number} id arbitrary reference id
* @param {String} hash
* @param {function} cb function(data,response) as specified by the restler API
*/
function rawData (id, hash) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'raw-data',
'params': {
'hash': hash
}}
return dispatch(jdata)
}
/**
* Retrieve a directory block given only its height.
* @method dblockByHeight
* @param {Number} id arbitrary reference id
* @param {Number} height height of block requested
* @param {function} cb function(data,response) as specified by the restler API
*/
function dblockByHeight (id, height) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'dblock-by-height',
'params': {
'height': height
}}
return dispatch(jdata)
}
/**
* Retrieve administrative blocks for any given height.
* @method ablockByHeight
* @param {Number} id arbitrary reference id
* @param {Number} height height of block requested
* @param {function} cb function(data,response) as specified by the restler API
*/
function ablockByHeight (id, height) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'ablock-by-height',
'params': {
'height': height
}}
return dispatch(jdata)
}
/**
* Retrieve the entry credit block for any given height.
* These blocks contain entry credit transaction information.
* @method ecblockByHeight
* @param {Number} id arbitrary reference id
* @param {Number} height height of block requested
* @param {function} cb function(data,response) as specified by the restler API
*/
function ecblockByHeight (id, height) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'ecblock-by-height',
'params': {
'height': height
}}
return dispatch(jdata)
}
/**
* Retrieve the factoid block for any given height.
* These blocks contain factoid arbitrary information.
* @param {Number} id arbitrary reference id
* @param {Number} height height of block requested
* @param {function} cb function(data,response) as specified by the restler API
*/
function fblockByHeight (id, height) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'fblock-by-height',
'params': {
'height': height
}}
return dispatch(jdata)
}
/**
* Retrieve a specified factoid block given its merkle root key.
* @method factoidBlock
* @param {Number} id arbitrary reference id
* @param {String} KeyMr Merkle root key
* @param {function} cb function(data,response) as specified by the restler API
*/
function factoidBlock (id, KeyMr) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'factoid-block',
'params': {
'KeyMr': KeyMr
}}
return dispatch(jdata)
}
/**
* Retrieve a specified entrycredit block given its merkle root key.
* The numbers are minute markers.
* @method entryCreditBlock
* @param {Number} id arbitrary reference id
* @param {String} KeyMr Merkle root key
* @param {function} cb function(data,response) as specified by the restler API
*/
function entryCreditBlock (id, KeyMR) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'entrycredit-block',
'params': {
'KeyMR': KeyMR
}}
return dispatch(jdata)
}
/**
* Retrieve a specified admin block given its merkle root key.
* @method adminBlock
* @param {Number} id arbitrary reference id
* @param {String} KeyMr Merkle root key
* @param {function} cb function(data,response) as specified by the restler API
*/
function adminBlock (id, KeyMR) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'admin-block',
'params': {
'KeyMR': KeyMR
}}
return dispatch(jdata)
}
/**
* Retrieve a specified entry block given its merkle root key.
* The entry block contains 0 to many entries
* @method entryBlock
* @param {Number} id arbitrary reference id
* @param {String} KeyMr Merkle root key
* @param {function} cb function(data,response) as specified by the restler API
*/
function entryBlock (id, KeyMR) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'entry-block',
'params': {
'KeyMR': KeyMR
}}
return dispatch(jdata)
}
/**
* Get an Entry from factomd specified by the Entry Hash.
* @method entry
* @param {Number} id arbitrary reference id
* @param {String} hash entry hash
* @param {function} cb function(data,response) as specified by the restler API
*/
function entry (id, hash) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'entry',
'params': {
'Hash': hash
}}
return dispatch(jdata)
}
/**
* Returns an array of the entries that have been submitted
* but have not been recoreded into the blockchain.
* @method pendingEntries
* @param {Number} id arbitrary reference id
* @param {function} cb function(data,response) as specified by the restler API
*/
function pendingEntries (id) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'pending-entries',
'params': {
}}
return dispatch(jdata)
}
/**
* Retrieve details of a factoid arbitrary using a transactions hash.
* Note that information regarding the directory block height,
* directory block keymr, and transaction block keymr are also included.
* The “blockheight” parameter in the reponse will always be 0 when using
* this call, refer to “includedindirectoryblockheight” if you need the height.
* @method transaction
* @param {Number} id arbitrary reference id
* @param {function} cb function(data,response) as specified by the restler API
*/
function transaction (id, hash) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'transaction',
'params': {
'hash': hash
}}
return dispatch(jdata)
}
/**
* Find the status of a transaction, whether it be a factoid,
* reveal entry, or commit entry.
* @method ack
* @param {Number} id arbitrary reference id
* @param {String} hash entry hash
* @param {String} chainid chain id
* @param {function} cb function(data,response) as specified by the restler API
*/
function ack (id, hash, chainid) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'ack',
'params': {
'hash': hash, 'chainid': chainid, 'fulltransaction': ''
}}
return dispatch(jdata)
}
/**
* Retrieve a reciept providing cryptographially verfiable proof that information
* was recorded in the factom blockchain and that this was subsequently
* anchored in the bitcoin blockchain.
* @method receipt
* @param {Number} id arbitrary reference id
* @param {String} hash
* @param {function} cb function(data,response) as specified by the restler API
*/
function receipt (id, hash) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'receipt',
'params': {
'hash': hash
}}
return dispatch(jdata)
}
/**
* Retrieve a reciept providing cryptographially verfiable proof that information
* was recorded in the factom blockchain and that this was subsequently
* anchored in the bitcoin blockchain.
* @method pendingTransactions
* @param {Number} id arbitrary reference id
* @param {String} Address
* @param {function} cb function(data,response) as specified by the restler API
*/
function pendingTransactions (id, Address) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'pending-transactions',
'params': {
'Address': Address
}}
return dispatch(jdata)
}
/**
* Return the keymr of the head of the chain for a chain ID
* (the unique hash created when the chain was created).
* @method chainHead
* @param {Number} id arbitrary reference id
* @param {Number} ChainID chain id
* @param {function} cb function(data,response) as specified by the restler API
*/
function chainHead (id, ChainID) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'chain-head',
'params': {
'ChainID': ChainID
}}
return dispatch(jdata)
}
/**
* Return its current balance for a specific entry credit address.
* @method entryCreditBalance
* @param {Number} id arbitrary reference id
* @param {String} address entry credit address
* @param {function} cb function(data,response) as specified by the restler API
*/
function entryCreditBalance (id, address) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'entry-credit-balance',
'params': {
'address': address
}}
return dispatch(jdata)
}
/**
* This call returns the number of Factoshis (Factoids *10^-8) that are currently
* available at the address specified.
* @method factoidBalance
* @param {Number} id arbitrary reference id
* @param {String} address factoid address
* @param {function} cb function(data,response) as specified by the restler AP
*/
function factoidBalance (id, address) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'factoid-balance',
'params': {
'address': address
}}
return dispatch(jdata)
}
/**
* Returns the number of Factoshis (Factoids *10^-8) that purchase a single
* Entry Credit. The minimum factoid fees are also determined by this rate,
* along with how complex the factoid arbitrary is.
* @method entryCreditRate
* @param {Number} id arbitrary reference id
* @param {function} cb function(data,response) as specified by the restler API
*/
function entryCreditRate (id) {
var jdata = {'jsonrpc': '2.0', 'id': id, 'method': 'entry-credit-rate'}
return dispatch(jdata)
}
/**
* Retrieve current properties of the Factom system,
* including the software and the API versions.
* @method properties
* @param {Number} id arbitrary reference id
* @param {function} cb function(data,response) as specified by the restler API
*/
function properties (id) {
var jdata = {'jsonrpc': '2.0', 'id': id, 'method': 'properties'}
return dispatch(jdata)
}
/**
* Submit a factoid arbitrary with hex encoded string documented here:
* https://github.com/FactomProject/FactomDocs/blob/master/factomDataStructureDetails.md#factoid-transaction
* A factoid-submit api call can be composed with factom_walletd.compose-transaction
* @method factoidSubmit
* @param {Number} id arbitrary reference id
* @param {String} transaction hex encoded string
* @param {function} cb function(data,response) as specified by the restler API
*/
function factoidSubmit (id, transaction) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'factoid-submit',
'params': {
'transaction': transaction
}}
return dispatch(jdata)
}
/**
* Send a Chain Commit Message to factomd to create a new Chain
* The commit chain hex encoded string is documented here:
* https://github.com/FactomProject/FactomDocs/blob/master/factomDataStructureDetails.md#chain-commit
* https://docs.factom.com/api#factoid-submit
* @method commit_chain
* @param {Number} id arbitrary reference id
* @param {String} message hex encoded string
* @param {function} cb function(data,response) as specified by the restler API
*/
function commitChain (id, message) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'commit-chain',
'params': {
'message': message
}}
return dispatch(jdata)
}
/**
* Reveal the First Entry in a Chain to factomd after the Commit to compleate
* the Chain creation. The reveal chain hex encoded string is documented here:
* https://github.com/FactomProject/FactomDocs/blob/master/factomDataStructureDetails.md#entry
* https://docs.factom.com/api#factoid-submit
* @method revealChain
* @param {Number} id arbitrary reference id
* @param {String} entry reveal chain hex encoded string
* @param {function} cb function(data,response) as specified by the restler API
*/
function revealChain (id, entry) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'reveal-chain',
'params': {
'entry': entry
}}
return dispatch(jdata)
}
/**
* Send an Entry Commit Message to factom to create a new Entry. The entry commit
* hex encoded string is documented here:
* https://github.com/FactomProject/FactomDocs/blob/master/factomDataStructureDetails.md#entry-commit
* https://docs.factom.com/api#reveal-chain
* @method commitEntry
* @param {Number} id arbitrary reference id
* @param {String} message hex encoded string for entry
* @param {function} cb function(data,response) as specified by the restler API
*/
function commitEntry (id, message) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'commit-entry',
'params': {
'message': message
}}
return dispatch(jdata)
}
/**
* Reveal an Entry to factomd after the Commit to compleate the Entry creation.
* The reveal entry hex encoded string is documented here:
* https://github.com/FactomProject/FactomDocs/blob/master/factomDataStructureDetails.md#entry
* https://docs.factom.com/api#reveal-entry
* @method revealEntry
* @param {Number} id arbitrary reference id
* @param {String} entry hex encoded string for reveal entry
* @param {function} cb function(data,response) as specified by the restler API
*/
function revealEntry (id, entry) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'reveal-entry',
'params': {
'entry': entry
}}
return dispatch(jdata)
}
/**
* Send a raw hex encoded binary message to the Factom network.
* This is mostly just for debugging and testing.
* https://docs.factom.com/api#send-raw-message
* @method sendRawMessage
* @param {Number} id arbitrary reference id
* @param {String} message raw hex encoded string
* @param {function} cb function(data,response) as specified by the restler API
*/
function sendRawMessage (id, message) {
var jdata = {'jsonrpc': '2.0',
'id': id,
'method': 'send-raw-message',
'params': {
'message': message
}}
return dispatch(jdata)
}
module.exports = {
setTimeout,
setFactomNode,
directoryBlock,
directoryBlockHead,
heights,
rawData,
dblockByHeight,
ablockByHeight,
ecblockByHeight,
fblockByHeight,
factoidBlock,
entryCreditBlock,
adminBlock,
entryBlock,
entry,
pendingEntries,
transaction,
ack,
receipt,
pendingTransactions,
chainHead,
entryCreditBalance,
factoidBalance,
entryCreditRate,
properties,
factoidSubmit,
commitChain,
revealChain,
commitEntry,
revealEntry,
sendRawMessage
}