-
Notifications
You must be signed in to change notification settings - Fork 0
/
getRawBlock.js
executable file
·80 lines (75 loc) · 2.22 KB
/
getRawBlock.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
const Validator = require('../../utils/Validator');
const argsSchema = require('../schemas/getRawBlock');
const validator = new Validator(argsSchema);
/**
* @param coreAPI
* @return {getRawBlock}
*/
const getRawBlockFactory = (coreAPI) => {
// Todo: document summary format
/**
* Layer 1 endpoint
* Returns raw block for the given block hash
* @typedef getRawBlock
* @param args
* @param {string} args.blockHash
* @return {Promise<object>}
*/
async function getRawBlock(args) {
validator.validate(args);
const { blockHash } = args;
return coreAPI.getRawBlock(blockHash);
}
return getRawBlock;
};
/* eslint-disable max-len */
/**
* @swagger
* /getRawBlock:
* post:
* operationId: getRawBlock
* deprecated: false
* summary: getRawBlock
* description: Returns the raw block for the provided block hash
* tags:
* - L1
* responses:
* 200:
* description: Successful response. Promise (object) containing the raw block details.
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - method
* - id
* - jsonrpc
* - params
* properties:
* method:
* type: string
* default: getRawBlock
* description: Method name
* id:
* type: integer
* default: 1
* format: int32
* description: Request ID
* jsonrpc:
* type: string
* default: '2.0'
* description: JSON-RPC Version (2.0)
* params:
* title: Parameters
* type: object
* required:
* - blockHash
* properties:
* blockHash:
* type: string
* default: '0000000000000000000000000000000000000000000000000000000000000000'
* description: Hash of the block to request
*/
/* eslint-enable max-len */
module.exports = getRawBlockFactory;