-
Notifications
You must be signed in to change notification settings - Fork 0
/
estimateFee.js
executable file
·79 lines (74 loc) · 2.19 KB
/
estimateFee.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
const Validator = require('../../utils/Validator');
const argsSchema = require('../schemas/estimateFee');
const validator = new Validator(argsSchema);
/**
* @param coreAPI
* @return {estimateFee}
*/
const estimateFeeFactory = (coreAPI) => {
/**
* Layer 1 endpoint
* estimates fee
* @typedef estimateFee
* @param {object} args
* @param {number} args.blocks - target
* @return {Promise<number>} - fee in haks per kilobyte
*/
async function estimateFee(args) {
validator.validate(args);
const { blocks } = args;
return coreAPI.estimateFee(blocks);
}
return estimateFee;
};
/* eslint-disable max-len */
/**
* @swagger
* /estimateFee:
* post:
* operationId: estimateFee
* deprecated: false
* summary: estimateFee
* description: Estimates the transaction fee necessary for confirmation to occur within a certain number of blocks
* tags:
* - L1
* responses:
* 200:
* description: Successful response. Promise (number) containing fee in haks per kilobyte.
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - method
* - id
* - jsonrpc
* - params
* properties:
* method:
* type: string
* default: estimateFee
* 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:
* - blocks
* properties:
* blocks:
* type: integer
* default: 1
* description: Number of blocks for fee estimate
*/
/* eslint-enable max-len */
module.exports = estimateFeeFactory;