Skip to content

Commit fe6d990

Browse files
#noticket getTransactionSize method
1 parent 3427f39 commit fe6d990

File tree

5 files changed

+36
-5
lines changed

5 files changed

+36
-5
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## 2019-12-20, Version 4.2.1
2+
3+
#### Notable changes:
4+
* Added `getTransactionSize` method for BTC based
5+
16
## 2019-12-20, Version 4.2.0
27

38
#### Notable changes:

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ NOTES:
118118
* caClient.BC.XXX.transaction.newTransaction ([docs](https://docs.cryptoapis.io/rest-apis/blockchain-as-a-service-apis/btc/index#btc-transactions-new-transactions))
119119
* caClient.BC.XXX.transaction.createHDWalletTransaction ([docs](https://docs.cryptoapis.io/rest-apis/blockchain-as-a-service-apis/btc/index#btc-transactions-hdwallet-transactions))
120120
* caClient.BC.XXX.transaction.getTransactionsFee ([docs](https://docs.cryptoapis.io/rest-apis/blockchain-as-a-service-apis/btc/index#btc-transactions-fee-endpoint))
121+
* caClient.BC.XXX.transaction.getTransactionSize ([docs](https://docs.cryptoapis.io/rest-apis/blockchain-as-a-service-apis/btc/index#btc-transactions-size))
121122
* caClient.BC.XXX.transaction.refund ([docs](https://docs.cryptoapis.io/rest-apis/blockchain-as-a-service-apis/btc/index#btc-refund-transaction))
122123

123124
#### Payment Forwarding methods

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "cryptoapis.io",
3-
"version": "4.2.0",
3+
"version": "4.2.1",
44
"description": "Crypto APIs SDK",
55
"main": "src/index.js",
66
"scripts": {

src/common/blockchain/base-transaction.js

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ class BaseTransaction extends BaseChainComponent {
9595
*
9696
* @param {Array} inputs
9797
* @param {Array} outputs
98-
* @param {Object<{number} value>} fee
98+
* @param {object<{number} value>} fee
9999
* @param {object} [optData] - Optional data.
100100
* @param {object} [queryParams] - Additional query parameters.
101101
*
@@ -167,7 +167,7 @@ class BaseTransaction extends BaseChainComponent {
167167
*
168168
* @param {Array} inputs
169169
* @param {Array} outputs
170-
* @param {Object<{number} value>} fee
170+
* @param {object<{number} value>} fee
171171
* @param {Array} wifs
172172
* @param {object} [optData] - Optional data.
173173
* @param {object} [queryParams] - Additional query parameters.
@@ -203,7 +203,7 @@ class BaseTransaction extends BaseChainComponent {
203203
* @param {string} walletName - Wallet name.
204204
* @param {string} password - Wallet password.
205205
* @param {Array} outputs
206-
* @param {Object<{number} value, {string} [address]>} fee
206+
* @param {object<{number} value, {string} [address]>} fee
207207
* @param {object} [optData] - Optional data.
208208
* @param {object} [queryParams] - Additional query parameters.
209209
*
@@ -248,6 +248,31 @@ class BaseTransaction extends BaseChainComponent {
248248
return this.request.get(this.basePath + this.getSelectedNetwork() + '/txs/fee', queryParams);
249249
}
250250

251+
/**
252+
* Transaction Size Endpoint
253+
*
254+
* @async
255+
* @desc Using Crypto APIs, you can calculate the approximate size of a standard transaction.
256+
*
257+
* @param {array} inputs
258+
* @param {array} outputs
259+
* @param {object} fee
260+
* @param {object} [optData] - Optional data.
261+
* @param {object} [queryParams] - Additional query parameters.
262+
*
263+
* @returns {*|Promise|Promise<any>}
264+
*/
265+
getTransactionSize(inputs, outputs, fee, optData = {}, queryParams = {}) {
266+
const data = {
267+
...optData,
268+
inputs,
269+
outputs,
270+
fee,
271+
};
272+
273+
return this.request.post(this.basePath + this.getSelectedNetwork() + '/txs/size', data, queryParams);
274+
}
275+
251276
/**
252277
* Refund Transaction Endpoint
253278
*

0 commit comments

Comments
 (0)