@iota-pico/api
Advanced tools
Comparing version 0.9.3 to 0.9.4
# Changelog | ||
## v0.9.4 | ||
* Fixed repo links in readme and coverage config | ||
## v0.9.3 | ||
@@ -4,0 +8,0 @@ |
@@ -47,6 +47,8 @@ [@iota-pico/api](../README.md) > [ApiClient](../classes/apiclient.md) | ||
### ⊕ **new ApiClient**(networkClient: *`INetworkClient`*, apiVersion?: *`string`*, additionalHeaders?: *`object`*, logger?: *`ILogger`*): [ApiClient](apiclient.md) | ||
### constructor | ||
*Defined in [client/apiClient.ts:49](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L49)* | ||
⊕ **new ApiClient**(networkClient: *`INetworkClient`*, apiVersion?: *`string`*, additionalHeaders?: *`object`*, logger?: *`ILogger`*): [ApiClient](apiclient.md) | ||
*Defined in [client/apiClient.ts:49](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L49)* | ||
Create an instance of ApiClient. | ||
@@ -58,10 +60,10 @@ | ||
| ------ | ------ | ------ | ------ | | ||
| networkClient | `INetworkClient` | - | The network client to communicate through. | | ||
| apiVersion | `string` | "1" | The API version to send with the requests | | ||
| additionalHeaders | `object` | - | Extra headers to send with the requests. | | ||
| logger | `ILogger` | - | Logger to send communication info to. | | ||
| networkClient | `INetworkClient` | - | The network client to communicate through. | | ||
| `Default value` apiVersion | `string` | "1" | The API version to send with the requests | | ||
| `Optional` additionalHeaders | `object` | - | Extra headers to send with the requests. | | ||
| `Optional` logger | `ILogger` | - | Logger to send communication info to. | | ||
**Returns:** [ApiClient](apiclient.md) | ||
--- | ||
___ | ||
@@ -74,7 +76,7 @@ ## Methods | ||
▸ **addNeighbors**(request: *[IAddNeighborsRequest](../interfaces/iaddneighborsrequest.md)*): `Promise`.<[IAddNeighborsResponse](../interfaces/iaddneighborsresponse.md)> | ||
▸ **addNeighbors**(request: *[IAddNeighborsRequest](../interfaces/iaddneighborsrequest.md)*): `Promise`<[IAddNeighborsResponse](../interfaces/iaddneighborsresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[addNeighbors](../interfaces/iapiclient.md#addneighbors)* | ||
*Defined in [client/apiClient.ts:94](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L94)* | ||
*Defined in [client/apiClient.ts:94](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L94)* | ||
@@ -87,9 +89,8 @@ Add a list of neighbors to your node. It should be noted that this is only temporary, and the added neighbors will be removed from your set of neighbors after you relaunch IRI. | ||
| ------ | ------ | ------ | | ||
| request | [IAddNeighborsRequest](../interfaces/iaddneighborsrequest.md) | The add neighbours request object. | | ||
| request | [IAddNeighborsRequest](../interfaces/iaddneighborsrequest.md) | The add neighbours request object. | | ||
**Returns:** `Promise`.<[IAddNeighborsResponse](../interfaces/iaddneighborsresponse.md)> | ||
**Returns:** `Promise`<[IAddNeighborsResponse](../interfaces/iaddneighborsresponse.md)> | ||
Promise which resolves to the addNeighbors response object or rejects with error. | ||
___ | ||
<a id="attachtotangle"></a> | ||
@@ -99,7 +100,7 @@ | ||
▸ **attachToTangle**(request: *[IAttachToTangleRequest](../interfaces/iattachtotanglerequest.md)*): `Promise`.<[IAttachToTangleResponse](../interfaces/iattachtotangleresponse.md)> | ||
▸ **attachToTangle**(request: *[IAttachToTangleRequest](../interfaces/iattachtotanglerequest.md)*): `Promise`<[IAttachToTangleResponse](../interfaces/iattachtotangleresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[attachToTangle](../interfaces/iapiclient.md#attachtotangle)* | ||
*Defined in [client/apiClient.ts:237](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L237)* | ||
*Defined in [client/apiClient.ts:237](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L237)* | ||
@@ -112,9 +113,8 @@ Attaches the specified transactions (trytes) to the Tangle by doing Proof of Work. You need to supply branchTransaction as well as trunkTransaction (basically the tips which you're going to validate and reference with this transaction) - both of which you'll get through the getTransactionsToApprove API call. | ||
| ------ | ------ | ------ | | ||
| request | [IAttachToTangleRequest](../interfaces/iattachtotanglerequest.md) | The attachToTangle request object. | | ||
| request | [IAttachToTangleRequest](../interfaces/iattachtotanglerequest.md) | The attachToTangle request object. | | ||
**Returns:** `Promise`.<[IAttachToTangleResponse](../interfaces/iattachtotangleresponse.md)> | ||
**Returns:** `Promise`<[IAttachToTangleResponse](../interfaces/iattachtotangleresponse.md)> | ||
Promise which resolves to the attachToTangle response object or rejects with error. | ||
___ | ||
<a id="broadcasttransactions"></a> | ||
@@ -124,7 +124,7 @@ | ||
▸ **broadcastTransactions**(request: *[IBroadcastTransactionsRequest](../interfaces/ibroadcasttransactionsrequest.md)*): `Promise`.<[ICommonResponse](../interfaces/icommonresponse.md)> | ||
▸ **broadcastTransactions**(request: *[IBroadcastTransactionsRequest](../interfaces/ibroadcasttransactionsrequest.md)*): `Promise`<[ICommonResponse](../interfaces/icommonresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[broadcastTransactions](../interfaces/iapiclient.md#broadcasttransactions)* | ||
*Defined in [client/apiClient.ts:269](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L269)* | ||
*Defined in [client/apiClient.ts:269](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L269)* | ||
@@ -137,9 +137,8 @@ Broadcast a list of transactions to all neighbors. The input trytes for this call are provided by attachToTangle. | ||
| ------ | ------ | ------ | | ||
| request | [IBroadcastTransactionsRequest](../interfaces/ibroadcasttransactionsrequest.md) | The broadcastTransactions request object. | | ||
| request | [IBroadcastTransactionsRequest](../interfaces/ibroadcasttransactionsrequest.md) | The broadcastTransactions request object. | | ||
**Returns:** `Promise`.<[ICommonResponse](../interfaces/icommonresponse.md)> | ||
**Returns:** `Promise`<[ICommonResponse](../interfaces/icommonresponse.md)> | ||
Promise which resolves with empty response object or rejects with error. | ||
___ | ||
<a id="checkconsistency"></a> | ||
@@ -149,7 +148,7 @@ | ||
▸ **checkConsistency**(request: *[ICheckConsistencyRequest](../interfaces/icheckconsistencyrequest.md)*): `Promise`.<[ICheckConsistencyResponse](../interfaces/icheckconsistencyresponse.md)> | ||
▸ **checkConsistency**(request: *[ICheckConsistencyRequest](../interfaces/icheckconsistencyrequest.md)*): `Promise`<[ICheckConsistencyResponse](../interfaces/icheckconsistencyresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[checkConsistency](../interfaces/iapiclient.md#checkconsistency)* | ||
*Defined in [client/apiClient.ts:308](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L308)* | ||
*Defined in [client/apiClient.ts:308](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L308)* | ||
@@ -162,9 +161,8 @@ Check the consistency of tail hashes. | ||
| ------ | ------ | ------ | | ||
| request | [ICheckConsistencyRequest](../interfaces/icheckconsistencyrequest.md) | The checkConsistency request object. | | ||
| request | [ICheckConsistencyRequest](../interfaces/icheckconsistencyrequest.md) | The checkConsistency request object. | | ||
**Returns:** `Promise`.<[ICheckConsistencyResponse](../interfaces/icheckconsistencyresponse.md)> | ||
**Returns:** `Promise`<[ICheckConsistencyResponse](../interfaces/icheckconsistencyresponse.md)> | ||
Promise which resolves to the checkConsistency response object or rejects with error. | ||
___ | ||
<a id="findtransactions"></a> | ||
@@ -174,7 +172,7 @@ | ||
▸ **findTransactions**(request: *[IFindTransactionsRequest](../interfaces/ifindtransactionsrequest.md)*): `Promise`.<[IFindTransactionsResponse](../interfaces/ifindtransactionsresponse.md)> | ||
▸ **findTransactions**(request: *[IFindTransactionsRequest](../interfaces/ifindtransactionsrequest.md)*): `Promise`<[IFindTransactionsResponse](../interfaces/ifindtransactionsresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[findTransactions](../interfaces/iapiclient.md#findtransactions)* | ||
*Defined in [client/apiClient.ts:136](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L136)* | ||
*Defined in [client/apiClient.ts:136](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L136)* | ||
@@ -187,9 +185,8 @@ Find the transactions which match the specified input and return. All input values are lists, for which a list of return values (transaction hashes), in the same order, is returned for all individual elements. The input fields can either be bundles, addresses, tags or approvees. Using multiple of these input fields returns the intersection of the values. | ||
| ------ | ------ | ------ | | ||
| request | [IFindTransactionsRequest](../interfaces/ifindtransactionsrequest.md) | The find transactions request object. | | ||
| request | [IFindTransactionsRequest](../interfaces/ifindtransactionsrequest.md) | The find transactions request object. | | ||
**Returns:** `Promise`.<[IFindTransactionsResponse](../interfaces/ifindtransactionsresponse.md)> | ||
**Returns:** `Promise`<[IFindTransactionsResponse](../interfaces/ifindtransactionsresponse.md)> | ||
Promise which resolves to the findTransactions response object or rejects with error. | ||
___ | ||
<a id="getbalances"></a> | ||
@@ -199,7 +196,7 @@ | ||
▸ **getBalances**(request: *[IGetBalancesRequest](../interfaces/igetbalancesrequest.md)*): `Promise`.<[IGetBalancesResponse](../interfaces/igetbalancesresponse.md)> | ||
▸ **getBalances**(request: *[IGetBalancesRequest](../interfaces/igetbalancesrequest.md)*): `Promise`<[IGetBalancesResponse](../interfaces/igetbalancesresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[getBalances](../interfaces/iapiclient.md#getbalances)* | ||
*Defined in [client/apiClient.ts:194](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L194)* | ||
*Defined in [client/apiClient.ts:194](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L194)* | ||
@@ -212,9 +209,8 @@ Returns the confirmed balance which a list of addresses have at the latest confirmed milestone. In addition to the balances, it also returns the milestone as well as the index with which the confirmed balance was determined. The balances is returned as a list in the same order as the addresses were provided as input. | ||
| ------ | ------ | ------ | | ||
| request | [IGetBalancesRequest](../interfaces/igetbalancesrequest.md) | The getBalances request object. | | ||
| request | [IGetBalancesRequest](../interfaces/igetbalancesrequest.md) | The getBalances request object. | | ||
**Returns:** `Promise`.<[IGetBalancesResponse](../interfaces/igetbalancesresponse.md)> | ||
**Returns:** `Promise`<[IGetBalancesResponse](../interfaces/igetbalancesresponse.md)> | ||
Promise which resolves to the getBalances response object or rejects with error. | ||
___ | ||
<a id="getinclusionstates"></a> | ||
@@ -224,7 +220,7 @@ | ||
▸ **getInclusionStates**(request: *[IGetInclusionStatesRequest](../interfaces/igetinclusionstatesrequest.md)*): `Promise`.<[IGetInclusionStatesResponse](../interfaces/igetinclusionstatesresponse.md)> | ||
▸ **getInclusionStates**(request: *[IGetInclusionStatesRequest](../interfaces/igetinclusionstatesrequest.md)*): `Promise`<[IGetInclusionStatesResponse](../interfaces/igetinclusionstatesresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[getInclusionStates](../interfaces/iapiclient.md#getinclusionstates)* | ||
*Defined in [client/apiClient.ts:173](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L173)* | ||
*Defined in [client/apiClient.ts:173](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L173)* | ||
@@ -237,9 +233,8 @@ Get the inclusion states of a set of transactions. This is for determining if a transaction was accepted and confirmed by the network or not. You can search for multiple tips (and thus, milestones) to get past inclusion states of transactions. | ||
| ------ | ------ | ------ | | ||
| request | [IGetInclusionStatesRequest](../interfaces/igetinclusionstatesrequest.md) | The get inclusion states request object. | | ||
| request | [IGetInclusionStatesRequest](../interfaces/igetinclusionstatesrequest.md) | The get inclusion states request object. | | ||
**Returns:** `Promise`.<[IGetInclusionStatesResponse](../interfaces/igetinclusionstatesresponse.md)> | ||
**Returns:** `Promise`<[IGetInclusionStatesResponse](../interfaces/igetinclusionstatesresponse.md)> | ||
Promise which resolves to the getInclusionStates response object or rejects with error. | ||
___ | ||
<a id="getmissingtransactions"></a> | ||
@@ -249,15 +244,14 @@ | ||
▸ **getMissingTransactions**(): `Promise`.<[IGetMissingTransactionsResponse](../interfaces/igetmissingtransactionsresponse.md)> | ||
▸ **getMissingTransactions**(): `Promise`<[IGetMissingTransactionsResponse](../interfaces/igetmissingtransactionsresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[getMissingTransactions](../interfaces/iapiclient.md#getmissingtransactions)* | ||
*Defined in [client/apiClient.ts:299](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L299)* | ||
*Defined in [client/apiClient.ts:299](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L299)* | ||
Get transactions with missing references. | ||
**Returns:** `Promise`.<[IGetMissingTransactionsResponse](../interfaces/igetmissingtransactionsresponse.md)> | ||
**Returns:** `Promise`<[IGetMissingTransactionsResponse](../interfaces/igetmissingtransactionsresponse.md)> | ||
Promise which resolves to the getMissingTransactions response object or rejects with error. | ||
___ | ||
<a id="getneighbors"></a> | ||
@@ -267,15 +261,14 @@ | ||
▸ **getNeighbors**(): `Promise`.<[IGetNeighborsResponse](../interfaces/igetneighborsresponse.md)> | ||
▸ **getNeighbors**(): `Promise`<[IGetNeighborsResponse](../interfaces/igetneighborsresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[getNeighbors](../interfaces/iapiclient.md#getneighbors)* | ||
*Defined in [client/apiClient.ts:84](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L84)* | ||
*Defined in [client/apiClient.ts:84](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L84)* | ||
Returns the set of neighbors you are connected with, as well as their activity count. The activity counter is reset after restarting IRI. | ||
**Returns:** `Promise`.<[IGetNeighborsResponse](../interfaces/igetneighborsresponse.md)> | ||
**Returns:** `Promise`<[IGetNeighborsResponse](../interfaces/igetneighborsresponse.md)> | ||
Promise which resolves to the getNeighbors response object or rejects with error. | ||
___ | ||
<a id="getnodeinfo"></a> | ||
@@ -285,15 +278,14 @@ | ||
▸ **getNodeInfo**(): `Promise`.<[IGetNodeInfoResponse](../interfaces/igetnodeinforesponse.md)> | ||
▸ **getNodeInfo**(): `Promise`<[IGetNodeInfoResponse](../interfaces/igetnodeinforesponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[getNodeInfo](../interfaces/iapiclient.md#getnodeinfo)* | ||
*Defined in [client/apiClient.ts:75](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L75)* | ||
*Defined in [client/apiClient.ts:75](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L75)* | ||
Returns information about your node. | ||
**Returns:** `Promise`.<[IGetNodeInfoResponse](../interfaces/igetnodeinforesponse.md)> | ||
**Returns:** `Promise`<[IGetNodeInfoResponse](../interfaces/igetnodeinforesponse.md)> | ||
Promise which resolves to the getNodeInfo response object or rejects with error. | ||
___ | ||
<a id="gettips"></a> | ||
@@ -303,15 +295,14 @@ | ||
▸ **getTips**(): `Promise`.<[IGetTipsResponse](../interfaces/igettipsresponse.md)> | ||
▸ **getTips**(): `Promise`<[IGetTipsResponse](../interfaces/igettipsresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[getTips](../interfaces/iapiclient.md#gettips)* | ||
*Defined in [client/apiClient.ts:124](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L124)* | ||
*Defined in [client/apiClient.ts:124](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L124)* | ||
Returns the list of tips. | ||
**Returns:** `Promise`.<[IGetTipsResponse](../interfaces/igettipsresponse.md)> | ||
**Returns:** `Promise`<[IGetTipsResponse](../interfaces/igettipsresponse.md)> | ||
Promise which resolves to the getTips response object or rejects with error. | ||
___ | ||
<a id="gettransactionstoapprove"></a> | ||
@@ -321,7 +312,7 @@ | ||
▸ **getTransactionsToApprove**(request: *[IGetTransactionsToApproveRequest](../interfaces/igettransactionstoapproverequest.md)*): `Promise`.<[IGetTransactionsToApproveResponse](../interfaces/igettransactionstoapproveresponse.md)> | ||
▸ **getTransactionsToApprove**(request: *[IGetTransactionsToApproveRequest](../interfaces/igettransactionstoapproverequest.md)*): `Promise`<[IGetTransactionsToApproveResponse](../interfaces/igettransactionstoapproveresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[getTransactionsToApprove](../interfaces/iapiclient.md#gettransactionstoapprove)* | ||
*Defined in [client/apiClient.ts:214](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L214)* | ||
*Defined in [client/apiClient.ts:214](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L214)* | ||
@@ -334,9 +325,8 @@ Tip selection which returns trunkTransaction and branchTransaction. The input value is depth, which basically determines how many bundles to go back to for finding the transactions to approve. The higher your depth value, the more "babysitting" you do for the network (as you have to confirm more transactions). | ||
| ------ | ------ | ------ | | ||
| request | [IGetTransactionsToApproveRequest](../interfaces/igettransactionstoapproverequest.md) | The getTransactionsToApprove request object. | | ||
| request | [IGetTransactionsToApproveRequest](../interfaces/igettransactionstoapproverequest.md) | The getTransactionsToApprove request object. | | ||
**Returns:** `Promise`.<[IGetTransactionsToApproveResponse](../interfaces/igettransactionstoapproveresponse.md)> | ||
**Returns:** `Promise`<[IGetTransactionsToApproveResponse](../interfaces/igettransactionstoapproveresponse.md)> | ||
Promise which resolves to the getTransactionsToApprove response object or rejects with error. | ||
___ | ||
<a id="gettrytes"></a> | ||
@@ -346,7 +336,7 @@ | ||
▸ **getTrytes**(request: *[IGetTrytesRequest](../interfaces/igettrytesrequest.md)*): `Promise`.<[IGetTrytesResponse](../interfaces/igettrytesresponse.md)> | ||
▸ **getTrytes**(request: *[IGetTrytesRequest](../interfaces/igettrytesrequest.md)*): `Promise`<[IGetTrytesResponse](../interfaces/igettrytesresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[getTrytes](../interfaces/iapiclient.md#gettrytes)* | ||
*Defined in [client/apiClient.ts:156](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L156)* | ||
*Defined in [client/apiClient.ts:156](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L156)* | ||
@@ -359,9 +349,8 @@ Returns the raw transaction data (trytes) of a specific transaction. These trytes can then be easily converted into the actual transaction object. | ||
| ------ | ------ | ------ | | ||
| request | [IGetTrytesRequest](../interfaces/igettrytesrequest.md) | The get trytes request object. | | ||
| request | [IGetTrytesRequest](../interfaces/igettrytesrequest.md) | The get trytes request object. | | ||
**Returns:** `Promise`.<[IGetTrytesResponse](../interfaces/igettrytesresponse.md)> | ||
**Returns:** `Promise`<[IGetTrytesResponse](../interfaces/igettrytesresponse.md)> | ||
Promise which resolves to the findTransactions response object or rejects with error. | ||
___ | ||
<a id="interruptattachingtotangle"></a> | ||
@@ -371,15 +360,14 @@ | ||
▸ **interruptAttachingToTangle**(): `Promise`.<[ICommonResponse](../interfaces/icommonresponse.md)> | ||
▸ **interruptAttachingToTangle**(): `Promise`<[ICommonResponse](../interfaces/icommonresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[interruptAttachingToTangle](../interfaces/iapiclient.md#interruptattachingtotangle)* | ||
*Defined in [client/apiClient.ts:260](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L260)* | ||
*Defined in [client/apiClient.ts:260](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L260)* | ||
Interrupts and completely aborts the attachToTangle process | ||
**Returns:** `Promise`.<[ICommonResponse](../interfaces/icommonresponse.md)> | ||
**Returns:** `Promise`<[ICommonResponse](../interfaces/icommonresponse.md)> | ||
Promise which resolves with empty response object or rejects with error. | ||
___ | ||
<a id="removeneighbors"></a> | ||
@@ -389,7 +377,7 @@ | ||
▸ **removeNeighbors**(request: *[IRemoveNeighborsRequest](../interfaces/iremoveneighborsrequest.md)*): `Promise`.<[IRemoveNeighborsResponse](../interfaces/iremoveneighborsresponse.md)> | ||
▸ **removeNeighbors**(request: *[IRemoveNeighborsRequest](../interfaces/iremoveneighborsrequest.md)*): `Promise`<[IRemoveNeighborsResponse](../interfaces/iremoveneighborsresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[removeNeighbors](../interfaces/iapiclient.md#removeneighbors)* | ||
*Defined in [client/apiClient.ts:110](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L110)* | ||
*Defined in [client/apiClient.ts:110](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L110)* | ||
@@ -402,9 +390,8 @@ Removes a list of neighbors from your node. This is only temporary, and if you have your neighbors added via the command line, they will be retained after you restart your node. | ||
| ------ | ------ | ------ | | ||
| request | [IRemoveNeighborsRequest](../interfaces/iremoveneighborsrequest.md) | The remove neighbours request object. | | ||
| request | [IRemoveNeighborsRequest](../interfaces/iremoveneighborsrequest.md) | The remove neighbours request object. | | ||
**Returns:** `Promise`.<[IRemoveNeighborsResponse](../interfaces/iremoveneighborsresponse.md)> | ||
**Returns:** `Promise`<[IRemoveNeighborsResponse](../interfaces/iremoveneighborsresponse.md)> | ||
Promise which resolves to the removeNeighbors response object or rejects with error. | ||
___ | ||
<a id="storetransactions"></a> | ||
@@ -414,7 +401,7 @@ | ||
▸ **storeTransactions**(request: *[IStoreTransactionsRequest](../interfaces/istoretransactionsrequest.md)*): `Promise`.<[ICommonResponse](../interfaces/icommonresponse.md)> | ||
▸ **storeTransactions**(request: *[IStoreTransactionsRequest](../interfaces/istoretransactionsrequest.md)*): `Promise`<[ICommonResponse](../interfaces/icommonresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[storeTransactions](../interfaces/iapiclient.md#storetransactions)* | ||
*Defined in [client/apiClient.ts:284](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L284)* | ||
*Defined in [client/apiClient.ts:284](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L284)* | ||
@@ -427,9 +414,8 @@ Store transactions into the local storage. The trytes to be used for this call are returned by attachToTangle. | ||
| ------ | ------ | ------ | | ||
| request | [IStoreTransactionsRequest](../interfaces/istoretransactionsrequest.md) | The storeTransactions request object. | | ||
| request | [IStoreTransactionsRequest](../interfaces/istoretransactionsrequest.md) | The storeTransactions request object. | | ||
**Returns:** `Promise`.<[ICommonResponse](../interfaces/icommonresponse.md)> | ||
**Returns:** `Promise`<[ICommonResponse](../interfaces/icommonresponse.md)> | ||
Promise which resolves with empty response object or rejects with error. | ||
___ | ||
<a id="wereaddressesspentfrom"></a> | ||
@@ -439,7 +425,7 @@ | ||
▸ **wereAddressesSpentFrom**(request: *[IWereAddressesSpentFromRequest](../interfaces/iwereaddressesspentfromrequest.md)*): `Promise`.<[IWereAddressesSpentFromResponse](../interfaces/iwereaddressesspentfromresponse.md)> | ||
▸ **wereAddressesSpentFrom**(request: *[IWereAddressesSpentFromRequest](../interfaces/iwereaddressesspentfromrequest.md)*): `Promise`<[IWereAddressesSpentFromResponse](../interfaces/iwereaddressesspentfromresponse.md)> | ||
*Implementation of [IApiClient](../interfaces/iapiclient.md).[wereAddressesSpentFrom](../interfaces/iapiclient.md#wereaddressesspentfrom)* | ||
*Defined in [client/apiClient.ts:323](https://github.com/iota-pico/api/blob/5406202/src/client/apiClient.ts#L323)* | ||
*Defined in [client/apiClient.ts:323](https://github.com/iota-pico/api/blob/f238b42/src/client/apiClient.ts#L323)* | ||
@@ -452,5 +438,5 @@ Have the requested addresses been spent from already. | ||
| ------ | ------ | ------ | | ||
| request | [IWereAddressesSpentFromRequest](../interfaces/iwereaddressesspentfromrequest.md) | The wereAddressesSpentFrom request object. | | ||
| request | [IWereAddressesSpentFromRequest](../interfaces/iwereaddressesspentfromrequest.md) | The wereAddressesSpentFrom request object. | | ||
**Returns:** `Promise`.<[IWereAddressesSpentFromResponse](../interfaces/iwereaddressesspentfromresponse.md)> | ||
**Returns:** `Promise`<[IWereAddressesSpentFromResponse](../interfaces/iwereaddressesspentfromresponse.md)> | ||
Promise which resolves to the wereAddressesSpentFrom response object or rejects with error. | ||
@@ -457,0 +443,0 @@ |
@@ -39,7 +39,9 @@ [@iota-pico/api](../README.md) > [ApiError](../classes/apierror.md) | ||
### ⊕ **new ApiError**(message: *`string`*, additional?: *`object`*, innerError?: *`Error`*): [ApiError](apierror.md) | ||
### constructor | ||
⊕ **new ApiError**(message: *`string`*, additional?: *`object`*, innerError?: *`Error`*): [ApiError](apierror.md) | ||
*Overrides CoreError.__constructor* | ||
*Defined in [error/apiError.ts:6](https://github.com/iota-pico/api/blob/5406202/src/error/apiError.ts#L6)* | ||
*Defined in [error/apiError.ts:6](https://github.com/iota-pico/api/blob/f238b42/src/error/apiError.ts#L6)* | ||
@@ -52,9 +54,9 @@ Create an instance of ApiError. | ||
| ------ | ------ | ------ | | ||
| message | `string` | The message for the error. | | ||
| additional | `object` | Additional details about the error. | | ||
| innerError | `Error` | Add information from inner error if there was one. | | ||
| message | `string` | The message for the error. | | ||
| `Optional` additional | `object` | Additional details about the error. | | ||
| `Optional` innerError | `Error` | Add information from inner error if there was one. | | ||
**Returns:** [ApiError](apierror.md) | ||
--- | ||
___ | ||
@@ -67,3 +69,3 @@ ## Properties | ||
**● additional**: *`object`* | ||
**● additional**: *`object`* | ||
@@ -81,3 +83,2 @@ *Inherited from CoreError.additional* | ||
___ | ||
<a id="domain"></a> | ||
@@ -87,3 +88,3 @@ | ||
**● domain**: *`string`* | ||
**● domain**: *`string`* | ||
@@ -97,3 +98,2 @@ *Inherited from CoreError.domain* | ||
___ | ||
<a id="innererror"></a> | ||
@@ -103,3 +103,3 @@ | ||
**● innerError**: *`Error`* | ||
**● innerError**: *`Error`* | ||
@@ -113,3 +113,2 @@ *Inherited from CoreError.innerError* | ||
___ | ||
<a id="message"></a> | ||
@@ -119,3 +118,3 @@ | ||
**● message**: *`string`* | ||
**● message**: *`string`* | ||
@@ -127,3 +126,2 @@ *Inherited from Error.message* | ||
___ | ||
<a id="name"></a> | ||
@@ -133,3 +131,3 @@ | ||
**● name**: *`string`* | ||
**● name**: *`string`* | ||
@@ -141,3 +139,2 @@ *Inherited from Error.name* | ||
___ | ||
<a id="stack"></a> | ||
@@ -147,3 +144,3 @@ | ||
**● stack**: *`string`* | ||
**● stack**: *`string`* | ||
@@ -174,3 +171,2 @@ *Inherited from Error.stack* | ||
___ | ||
<a id="iserror"></a> | ||
@@ -192,3 +188,3 @@ | ||
| ------ | ------ | ------ | | ||
| obj | `any` | The object to check if it is a CoreError. | | ||
| obj | `any` | The object to check if it is a CoreError. | | ||
@@ -195,0 +191,0 @@ **Returns:** `boolean` |
@@ -26,5 +26,5 @@ [@iota-pico/api](../README.md) > [IAddNeighborsRequest](../interfaces/iaddneighborsrequest.md) | ||
**● uris**: *`string`[]* | ||
**● uris**: *`string`[]* | ||
*Defined in [models/IAddNeighborsRequest.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/IAddNeighborsRequest.ts#L9)* | ||
*Defined in [models/IAddNeighborsRequest.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/IAddNeighborsRequest.ts#L9)* | ||
@@ -31,0 +31,0 @@ List of URI elements. |
@@ -29,5 +29,5 @@ [@iota-pico/api](../README.md) > [IAddNeighborsResponse](../interfaces/iaddneighborsresponse.md) | ||
**● addedNeighbors**: *`number`* | ||
**● addedNeighbors**: *`number`* | ||
*Defined in [models/IAddNeighborsResponse.ts:11](https://github.com/iota-pico/api/blob/5406202/src/models/IAddNeighborsResponse.ts#L11)* | ||
*Defined in [models/IAddNeighborsResponse.ts:11](https://github.com/iota-pico/api/blob/f238b42/src/models/IAddNeighborsResponse.ts#L11)* | ||
@@ -37,3 +37,2 @@ The number of neighbours added. | ||
___ | ||
<a id="duration"></a> | ||
@@ -43,7 +42,7 @@ | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -50,0 +49,0 @@ The duration of the request. |
@@ -46,5 +46,5 @@ [@iota-pico/api](../README.md) > [IApiClient](../interfaces/iapiclient.md) | ||
▸ **addNeighbors**(request: *[IAddNeighborsRequest](iaddneighborsrequest.md)*): `Promise`.<[IAddNeighborsResponse](iaddneighborsresponse.md)> | ||
▸ **addNeighbors**(request: *[IAddNeighborsRequest](iaddneighborsrequest.md)*): `Promise`<[IAddNeighborsResponse](iaddneighborsresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:52](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L52)* | ||
*Defined in [interfaces/IApiClient.ts:52](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L52)* | ||
@@ -55,11 +55,10 @@ Add a list of neighbors to your node. It should be noted that this is only temporary, and the added neighbors will be removed from your set of neighbors after you relaunch IRI. | ||
| Param | Type | Description | | ||
| ------ | ------ | ------ | | ||
| request | [IAddNeighborsRequest](iaddneighborsrequest.md) | - | | ||
| Param | Type | | ||
| ------ | ------ | | ||
| request | [IAddNeighborsRequest](iaddneighborsrequest.md) | | ||
**Returns:** `Promise`.<[IAddNeighborsResponse](iaddneighborsresponse.md)> | ||
**Returns:** `Promise`<[IAddNeighborsResponse](iaddneighborsresponse.md)> | ||
Promise which resolves to the addNeighbors response object or rejects with error. | ||
___ | ||
<a id="attachtotangle"></a> | ||
@@ -69,5 +68,5 @@ | ||
▸ **attachToTangle**(request: *[IAttachToTangleRequest](iattachtotanglerequest.md)*): `Promise`.<[IAttachToTangleResponse](iattachtotangleresponse.md)> | ||
▸ **attachToTangle**(request: *[IAttachToTangleRequest](iattachtotanglerequest.md)*): `Promise`<[IAttachToTangleResponse](iattachtotangleresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:117](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L117)* | ||
*Defined in [interfaces/IApiClient.ts:117](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L117)* | ||
@@ -80,9 +79,8 @@ Attaches the specified transactions (trytes) to the Tangle by doing Proof of Work. You need to supply branchTransaction as well as trunkTransaction (basically the tips which you're going to validate and reference with this transaction) - both of which you'll get through the getTransactionsToApprove API call. | ||
| ------ | ------ | ------ | | ||
| request | [IAttachToTangleRequest](iattachtotanglerequest.md) | The attachToTangle request object. | | ||
| request | [IAttachToTangleRequest](iattachtotanglerequest.md) | The attachToTangle request object. | | ||
**Returns:** `Promise`.<[IAttachToTangleResponse](iattachtotangleresponse.md)> | ||
**Returns:** `Promise`<[IAttachToTangleResponse](iattachtotangleresponse.md)> | ||
Promise which resolves to the attachToTangle response object or rejects with error. | ||
___ | ||
<a id="broadcasttransactions"></a> | ||
@@ -92,5 +90,5 @@ | ||
▸ **broadcastTransactions**(request: *[IBroadcastTransactionsRequest](ibroadcasttransactionsrequest.md)*): `Promise`.<[ICommonResponse](icommonresponse.md)> | ||
▸ **broadcastTransactions**(request: *[IBroadcastTransactionsRequest](ibroadcasttransactionsrequest.md)*): `Promise`<[ICommonResponse](icommonresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:130](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L130)* | ||
*Defined in [interfaces/IApiClient.ts:130](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L130)* | ||
@@ -103,9 +101,8 @@ Broadcast a list of transactions to all neighbors. The input trytes for this call are provided by attachToTangle. | ||
| ------ | ------ | ------ | | ||
| request | [IBroadcastTransactionsRequest](ibroadcasttransactionsrequest.md) | The broadcastTransactions request object. | | ||
| request | [IBroadcastTransactionsRequest](ibroadcasttransactionsrequest.md) | The broadcastTransactions request object. | | ||
**Returns:** `Promise`.<[ICommonResponse](icommonresponse.md)> | ||
**Returns:** `Promise`<[ICommonResponse](icommonresponse.md)> | ||
Promise which resolves with empty response object or rejects with error. | ||
___ | ||
<a id="checkconsistency"></a> | ||
@@ -115,5 +112,5 @@ | ||
▸ **checkConsistency**(request: *[ICheckConsistencyRequest](icheckconsistencyrequest.md)*): `Promise`.<[ICheckConsistencyResponse](icheckconsistencyresponse.md)> | ||
▸ **checkConsistency**(request: *[ICheckConsistencyRequest](icheckconsistencyrequest.md)*): `Promise`<[ICheckConsistencyResponse](icheckconsistencyresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:151](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L151)* | ||
*Defined in [interfaces/IApiClient.ts:151](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L151)* | ||
@@ -126,9 +123,8 @@ Check the consistency of tail hashes. | ||
| ------ | ------ | ------ | | ||
| request | [ICheckConsistencyRequest](icheckconsistencyrequest.md) | The checkConsistency request object. | | ||
| request | [ICheckConsistencyRequest](icheckconsistencyrequest.md) | The checkConsistency request object. | | ||
**Returns:** `Promise`.<[ICheckConsistencyResponse](icheckconsistencyresponse.md)> | ||
**Returns:** `Promise`<[ICheckConsistencyResponse](icheckconsistencyresponse.md)> | ||
Promise which resolves to the checkConsistency response object or rejects with error. | ||
___ | ||
<a id="findtransactions"></a> | ||
@@ -138,5 +134,5 @@ | ||
▸ **findTransactions**(request: *[IFindTransactionsRequest](ifindtransactionsrequest.md)*): `Promise`.<[IFindTransactionsResponse](ifindtransactionsresponse.md)> | ||
▸ **findTransactions**(request: *[IFindTransactionsRequest](ifindtransactionsrequest.md)*): `Promise`<[IFindTransactionsResponse](ifindtransactionsresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:74](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L74)* | ||
*Defined in [interfaces/IApiClient.ts:74](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L74)* | ||
@@ -147,11 +143,10 @@ Find the transactions which match the specified input and return. All input values are lists, for which a list of return values (transaction hashes), in the same order, is returned for all individual elements. The input fields can either be bundles, addresses, tags or approvees. Using multiple of these input fields returns the intersection of the values. | ||
| Param | Type | Description | | ||
| ------ | ------ | ------ | | ||
| request | [IFindTransactionsRequest](ifindtransactionsrequest.md) | - | | ||
| Param | Type | | ||
| ------ | ------ | | ||
| request | [IFindTransactionsRequest](ifindtransactionsrequest.md) | | ||
**Returns:** `Promise`.<[IFindTransactionsResponse](ifindtransactionsresponse.md)> | ||
**Returns:** `Promise`<[IFindTransactionsResponse](ifindtransactionsresponse.md)> | ||
Promise which resolves to the findTransactions response object or rejects with error. | ||
___ | ||
<a id="getbalances"></a> | ||
@@ -161,5 +156,5 @@ | ||
▸ **getBalances**(request: *[IGetBalancesRequest](igetbalancesrequest.md)*): `Promise`.<[IGetBalancesResponse](igetbalancesresponse.md)> | ||
▸ **getBalances**(request: *[IGetBalancesRequest](igetbalancesrequest.md)*): `Promise`<[IGetBalancesResponse](igetbalancesresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:99](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L99)* | ||
*Defined in [interfaces/IApiClient.ts:99](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L99)* | ||
@@ -172,9 +167,8 @@ Returns the confirmed balance which a list of addresses have at the latest confirmed milestone. In addition to the balances, it also returns the milestone as well as the index with which the confirmed balance was determined. The balances is returned as a list in the same order as the addresses were provided as input. | ||
| ------ | ------ | ------ | | ||
| request | [IGetBalancesRequest](igetbalancesrequest.md) | The getBalances request object. | | ||
| request | [IGetBalancesRequest](igetbalancesrequest.md) | The getBalances request object. | | ||
**Returns:** `Promise`.<[IGetBalancesResponse](igetbalancesresponse.md)> | ||
**Returns:** `Promise`<[IGetBalancesResponse](igetbalancesresponse.md)> | ||
Promise which resolves to the getBalances response object or rejects with error. | ||
___ | ||
<a id="getinclusionstates"></a> | ||
@@ -184,5 +178,5 @@ | ||
▸ **getInclusionStates**(request: *[IGetInclusionStatesRequest](igetinclusionstatesrequest.md)*): `Promise`.<[IGetInclusionStatesResponse](igetinclusionstatesresponse.md)> | ||
▸ **getInclusionStates**(request: *[IGetInclusionStatesRequest](igetinclusionstatesrequest.md)*): `Promise`<[IGetInclusionStatesResponse](igetinclusionstatesresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:89](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L89)* | ||
*Defined in [interfaces/IApiClient.ts:89](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L89)* | ||
@@ -193,11 +187,10 @@ Get the inclusion states of a set of transactions. This is for determining if a transaction was accepted and confirmed by the network or not. You can search for multiple tips (and thus, milestones) to get past inclusion states of transactions. | ||
| Param | Type | Description | | ||
| ------ | ------ | ------ | | ||
| request | [IGetInclusionStatesRequest](igetinclusionstatesrequest.md) | - | | ||
| Param | Type | | ||
| ------ | ------ | | ||
| request | [IGetInclusionStatesRequest](igetinclusionstatesrequest.md) | | ||
**Returns:** `Promise`.<[IGetInclusionStatesResponse](igetinclusionstatesresponse.md)> | ||
**Returns:** `Promise`<[IGetInclusionStatesResponse](igetinclusionstatesresponse.md)> | ||
Promise which resolves to the getInclusionStates response object or rejects with error. | ||
___ | ||
<a id="getmissingtransactions"></a> | ||
@@ -207,13 +200,12 @@ | ||
▸ **getMissingTransactions**(): `Promise`.<[IGetMissingTransactionsResponse](igetmissingtransactionsresponse.md)> | ||
▸ **getMissingTransactions**(): `Promise`<[IGetMissingTransactionsResponse](igetmissingtransactionsresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:144](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L144)* | ||
*Defined in [interfaces/IApiClient.ts:144](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L144)* | ||
Get transactions with missing references. | ||
**Returns:** `Promise`.<[IGetMissingTransactionsResponse](igetmissingtransactionsresponse.md)> | ||
**Returns:** `Promise`<[IGetMissingTransactionsResponse](igetmissingtransactionsresponse.md)> | ||
Promise which resolves to the getMissingTransactions response object or rejects with error. | ||
___ | ||
<a id="getneighbors"></a> | ||
@@ -223,13 +215,12 @@ | ||
▸ **getNeighbors**(): `Promise`.<[IGetNeighborsResponse](igetneighborsresponse.md)> | ||
▸ **getNeighbors**(): `Promise`<[IGetNeighborsResponse](igetneighborsresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:45](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L45)* | ||
*Defined in [interfaces/IApiClient.ts:45](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L45)* | ||
Returns the set of neighbors you are connected with, as well as their activity count. The activity counter is reset after restarting IRI. | ||
**Returns:** `Promise`.<[IGetNeighborsResponse](igetneighborsresponse.md)> | ||
**Returns:** `Promise`<[IGetNeighborsResponse](igetneighborsresponse.md)> | ||
Promise which resolves to the getNeighbors response object or rejects with error. | ||
___ | ||
<a id="getnodeinfo"></a> | ||
@@ -239,13 +230,12 @@ | ||
▸ **getNodeInfo**(): `Promise`.<[IGetNodeInfoResponse](igetnodeinforesponse.md)> | ||
▸ **getNodeInfo**(): `Promise`<[IGetNodeInfoResponse](igetnodeinforesponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:38](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L38)* | ||
*Defined in [interfaces/IApiClient.ts:38](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L38)* | ||
Returns information about your node. | ||
**Returns:** `Promise`.<[IGetNodeInfoResponse](igetnodeinforesponse.md)> | ||
**Returns:** `Promise`<[IGetNodeInfoResponse](igetnodeinforesponse.md)> | ||
Promise which resolves to the getNodeInfo response object or rejects with error. | ||
___ | ||
<a id="gettips"></a> | ||
@@ -255,13 +245,12 @@ | ||
▸ **getTips**(): `Promise`.<[IGetTipsResponse](igettipsresponse.md)> | ||
▸ **getTips**(): `Promise`<[IGetTipsResponse](igettipsresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:65](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L65)* | ||
*Defined in [interfaces/IApiClient.ts:65](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L65)* | ||
Returns the list of tips. | ||
**Returns:** `Promise`.<[IGetTipsResponse](igettipsresponse.md)> | ||
**Returns:** `Promise`<[IGetTipsResponse](igettipsresponse.md)> | ||
Promise which resolves to the getTips response object or rejects with error. | ||
___ | ||
<a id="gettransactionstoapprove"></a> | ||
@@ -271,5 +260,5 @@ | ||
▸ **getTransactionsToApprove**(request: *[IGetTransactionsToApproveRequest](igettransactionstoapproverequest.md)*): `Promise`.<[IGetTransactionsToApproveResponse](igettransactionstoapproveresponse.md)> | ||
▸ **getTransactionsToApprove**(request: *[IGetTransactionsToApproveRequest](igettransactionstoapproverequest.md)*): `Promise`<[IGetTransactionsToApproveResponse](igettransactionstoapproveresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:108](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L108)* | ||
*Defined in [interfaces/IApiClient.ts:108](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L108)* | ||
@@ -282,9 +271,8 @@ Tip selection which returns trunkTransaction and branchTransaction. The input value is depth, which basically determines how many bundles to go back to for finding the transactions to approve. The higher your depth value, the more "babysitting" you do for the network (as you have to confirm more transactions). | ||
| ------ | ------ | ------ | | ||
| request | [IGetTransactionsToApproveRequest](igettransactionstoapproverequest.md) | The getTransactionsToApprove request object. | | ||
| request | [IGetTransactionsToApproveRequest](igettransactionstoapproverequest.md) | The getTransactionsToApprove request object. | | ||
**Returns:** `Promise`.<[IGetTransactionsToApproveResponse](igettransactionstoapproveresponse.md)> | ||
**Returns:** `Promise`<[IGetTransactionsToApproveResponse](igettransactionstoapproveresponse.md)> | ||
Promise which resolves to the getTransactionsToApprove response object or rejects with error. | ||
___ | ||
<a id="gettrytes"></a> | ||
@@ -294,5 +282,5 @@ | ||
▸ **getTrytes**(request: *[IGetTrytesRequest](igettrytesrequest.md)*): `Promise`.<[IGetTrytesResponse](igettrytesresponse.md)> | ||
▸ **getTrytes**(request: *[IGetTrytesRequest](igettrytesrequest.md)*): `Promise`<[IGetTrytesResponse](igettrytesresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:81](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L81)* | ||
*Defined in [interfaces/IApiClient.ts:81](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L81)* | ||
@@ -303,11 +291,10 @@ Returns the raw transaction data (trytes) of a specific transaction. These trytes can then be easily converted into the actual transaction object. | ||
| Param | Type | Description | | ||
| ------ | ------ | ------ | | ||
| request | [IGetTrytesRequest](igettrytesrequest.md) | - | | ||
| Param | Type | | ||
| ------ | ------ | | ||
| request | [IGetTrytesRequest](igettrytesrequest.md) | | ||
**Returns:** `Promise`.<[IGetTrytesResponse](igettrytesresponse.md)> | ||
**Returns:** `Promise`<[IGetTrytesResponse](igettrytesresponse.md)> | ||
Promise which resolves to the getTrytes response object or rejects with error. | ||
___ | ||
<a id="interruptattachingtotangle"></a> | ||
@@ -317,13 +304,12 @@ | ||
▸ **interruptAttachingToTangle**(): `Promise`.<[ICommonResponse](icommonresponse.md)> | ||
▸ **interruptAttachingToTangle**(): `Promise`<[ICommonResponse](icommonresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:123](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L123)* | ||
*Defined in [interfaces/IApiClient.ts:123](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L123)* | ||
Interrupts and completely aborts the attachToTangle process | ||
**Returns:** `Promise`.<[ICommonResponse](icommonresponse.md)> | ||
**Returns:** `Promise`<[ICommonResponse](icommonresponse.md)> | ||
Promise which resolves with empty response object or rejects with error. | ||
___ | ||
<a id="removeneighbors"></a> | ||
@@ -333,5 +319,5 @@ | ||
▸ **removeNeighbors**(request: *[IRemoveNeighborsRequest](iremoveneighborsrequest.md)*): `Promise`.<[IRemoveNeighborsResponse](iremoveneighborsresponse.md)> | ||
▸ **removeNeighbors**(request: *[IRemoveNeighborsRequest](iremoveneighborsrequest.md)*): `Promise`<[IRemoveNeighborsResponse](iremoveneighborsresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:59](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L59)* | ||
*Defined in [interfaces/IApiClient.ts:59](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L59)* | ||
@@ -342,11 +328,10 @@ Removes a list of neighbors from your node. This is only temporary, and if you have your neighbors added via the command line, they will be retained after you restart your node. | ||
| Param | Type | Description | | ||
| ------ | ------ | ------ | | ||
| request | [IRemoveNeighborsRequest](iremoveneighborsrequest.md) | - | | ||
| Param | Type | | ||
| ------ | ------ | | ||
| request | [IRemoveNeighborsRequest](iremoveneighborsrequest.md) | | ||
**Returns:** `Promise`.<[IRemoveNeighborsResponse](iremoveneighborsresponse.md)> | ||
**Returns:** `Promise`<[IRemoveNeighborsResponse](iremoveneighborsresponse.md)> | ||
Promise which resolves to the removeNeighbors response object or rejects with error. | ||
___ | ||
<a id="storetransactions"></a> | ||
@@ -356,5 +341,5 @@ | ||
▸ **storeTransactions**(request: *[IStoreTransactionsRequest](istoretransactionsrequest.md)*): `Promise`.<[ICommonResponse](icommonresponse.md)> | ||
▸ **storeTransactions**(request: *[IStoreTransactionsRequest](istoretransactionsrequest.md)*): `Promise`<[ICommonResponse](icommonresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:137](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L137)* | ||
*Defined in [interfaces/IApiClient.ts:137](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L137)* | ||
@@ -367,9 +352,8 @@ Store transactions into the local storage. The trytes to be used for this call are returned by attachToTangle. | ||
| ------ | ------ | ------ | | ||
| request | [IStoreTransactionsRequest](istoretransactionsrequest.md) | The storeTransactions request object. | | ||
| request | [IStoreTransactionsRequest](istoretransactionsrequest.md) | The storeTransactions request object. | | ||
**Returns:** `Promise`.<[ICommonResponse](icommonresponse.md)> | ||
**Returns:** `Promise`<[ICommonResponse](icommonresponse.md)> | ||
Promise which resolves with empty response object or rejects with error. | ||
___ | ||
<a id="wereaddressesspentfrom"></a> | ||
@@ -379,5 +363,5 @@ | ||
▸ **wereAddressesSpentFrom**(request: *[IWereAddressesSpentFromRequest](iwereaddressesspentfromrequest.md)*): `Promise`.<[IWereAddressesSpentFromResponse](iwereaddressesspentfromresponse.md)> | ||
▸ **wereAddressesSpentFrom**(request: *[IWereAddressesSpentFromRequest](iwereaddressesspentfromrequest.md)*): `Promise`<[IWereAddressesSpentFromResponse](iwereaddressesspentfromresponse.md)> | ||
*Defined in [interfaces/IApiClient.ts:158](https://github.com/iota-pico/api/blob/5406202/src/interfaces/IApiClient.ts#L158)* | ||
*Defined in [interfaces/IApiClient.ts:158](https://github.com/iota-pico/api/blob/f238b42/src/interfaces/IApiClient.ts#L158)* | ||
@@ -390,5 +374,5 @@ Have the requested addresses been spent from already. | ||
| ------ | ------ | ------ | | ||
| request | [IWereAddressesSpentFromRequest](iwereaddressesspentfromrequest.md) | The wereAddressesSpentFrom request object. | | ||
| request | [IWereAddressesSpentFromRequest](iwereaddressesspentfromrequest.md) | The wereAddressesSpentFrom request object. | | ||
**Returns:** `Promise`.<[IWereAddressesSpentFromResponse](iwereaddressesspentfromresponse.md)> | ||
**Returns:** `Promise`<[IWereAddressesSpentFromResponse](iwereaddressesspentfromresponse.md)> | ||
Promise which resolves to the wereAddressesSpentFrom response object or rejects with error. | ||
@@ -395,0 +379,0 @@ |
@@ -29,5 +29,5 @@ [@iota-pico/api](../README.md) > [IAttachToTangleRequest](../interfaces/iattachtotanglerequest.md) | ||
**● branchTransaction**: *`string`* | ||
**● branchTransaction**: *`string`* | ||
*Defined in [models/IAttachToTangleRequest.ts:13](https://github.com/iota-pico/api/blob/5406202/src/models/IAttachToTangleRequest.ts#L13)* | ||
*Defined in [models/IAttachToTangleRequest.ts:13](https://github.com/iota-pico/api/blob/f238b42/src/models/IAttachToTangleRequest.ts#L13)* | ||
@@ -37,3 +37,2 @@ Branch transaction to approve. | ||
___ | ||
<a id="minweightmagnitude"></a> | ||
@@ -43,5 +42,5 @@ | ||
**● minWeightMagnitude**: *`number`* | ||
**● minWeightMagnitude**: *`number`* | ||
*Defined in [models/IAttachToTangleRequest.ts:17](https://github.com/iota-pico/api/blob/5406202/src/models/IAttachToTangleRequest.ts#L17)* | ||
*Defined in [models/IAttachToTangleRequest.ts:17](https://github.com/iota-pico/api/blob/f238b42/src/models/IAttachToTangleRequest.ts#L17)* | ||
@@ -51,3 +50,2 @@ Proof of Work intensity. Minimum value is 18 | ||
___ | ||
<a id="trunktransaction"></a> | ||
@@ -57,5 +55,5 @@ | ||
**● trunkTransaction**: *`string`* | ||
**● trunkTransaction**: *`string`* | ||
*Defined in [models/IAttachToTangleRequest.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/IAttachToTangleRequest.ts#L9)* | ||
*Defined in [models/IAttachToTangleRequest.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/IAttachToTangleRequest.ts#L9)* | ||
@@ -65,3 +63,2 @@ Trunk transaction to approve. | ||
___ | ||
<a id="trytes"></a> | ||
@@ -71,5 +68,5 @@ | ||
**● trytes**: *`string`[]* | ||
**● trytes**: *`string`[]* | ||
*Defined in [models/IAttachToTangleRequest.ts:21](https://github.com/iota-pico/api/blob/5406202/src/models/IAttachToTangleRequest.ts#L21)* | ||
*Defined in [models/IAttachToTangleRequest.ts:21](https://github.com/iota-pico/api/blob/f238b42/src/models/IAttachToTangleRequest.ts#L21)* | ||
@@ -76,0 +73,0 @@ List of trytes (raw transaction data) to attach to the tangle. |
@@ -29,7 +29,7 @@ [@iota-pico/api](../README.md) > [IAttachToTangleResponse](../interfaces/iattachtotangleresponse.md) | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -39,3 +39,2 @@ The duration of the request. | ||
___ | ||
<a id="trytes"></a> | ||
@@ -45,5 +44,5 @@ | ||
**● trytes**: *`string`[]* | ||
**● trytes**: *`string`[]* | ||
*Defined in [models/IAttachToTangleResponse.ts:12](https://github.com/iota-pico/api/blob/5406202/src/models/IAttachToTangleResponse.ts#L12)* | ||
*Defined in [models/IAttachToTangleResponse.ts:12](https://github.com/iota-pico/api/blob/f238b42/src/models/IAttachToTangleResponse.ts#L12)* | ||
@@ -50,0 +49,0 @@ The returned tryte value, the last 243 trytes basically consist of the: trunkTransaction + branchTransaction + nonce. |
@@ -26,5 +26,5 @@ [@iota-pico/api](../README.md) > [IBroadcastTransactionsRequest](../interfaces/ibroadcasttransactionsrequest.md) | ||
**● trytes**: *`string`[]* | ||
**● trytes**: *`string`[]* | ||
*Defined in [models/IBroadcastTransactionsRequest.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/IBroadcastTransactionsRequest.ts#L9)* | ||
*Defined in [models/IBroadcastTransactionsRequest.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/IBroadcastTransactionsRequest.ts#L9)* | ||
@@ -31,0 +31,0 @@ List of raw data of transactions to be rebroadcast. |
@@ -26,5 +26,5 @@ [@iota-pico/api](../README.md) > [ICheckConsistencyRequest](../interfaces/icheckconsistencyrequest.md) | ||
**● tails**: *`string`[]* | ||
**● tails**: *`string`[]* | ||
*Defined in [models/ICheckConsistencyRequest.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICheckConsistencyRequest.ts#L9)* | ||
*Defined in [models/ICheckConsistencyRequest.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICheckConsistencyRequest.ts#L9)* | ||
@@ -31,0 +31,0 @@ The tail hashes to check for consistency. |
@@ -30,7 +30,7 @@ [@iota-pico/api](../README.md) > [ICheckConsistencyResponse](../interfaces/icheckconsistencyresponse.md) | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -40,3 +40,2 @@ The duration of the request. | ||
___ | ||
<a id="info"></a> | ||
@@ -46,5 +45,5 @@ | ||
**● info**: *`string`* | ||
**● info**: *`string`* | ||
*Defined in [models/ICheckConsistencyResponse.ts:15](https://github.com/iota-pico/api/blob/5406202/src/models/ICheckConsistencyResponse.ts#L15)* | ||
*Defined in [models/ICheckConsistencyResponse.ts:15](https://github.com/iota-pico/api/blob/f238b42/src/models/ICheckConsistencyResponse.ts#L15)* | ||
@@ -54,3 +53,2 @@ Is the tail reference consistent. | ||
___ | ||
<a id="state"></a> | ||
@@ -60,5 +58,5 @@ | ||
**● state**: *`boolean`* | ||
**● state**: *`boolean`* | ||
*Defined in [models/ICheckConsistencyResponse.ts:11](https://github.com/iota-pico/api/blob/5406202/src/models/ICheckConsistencyResponse.ts#L11)* | ||
*Defined in [models/ICheckConsistencyResponse.ts:11](https://github.com/iota-pico/api/blob/f238b42/src/models/ICheckConsistencyResponse.ts#L11)* | ||
@@ -65,0 +63,0 @@ Is the tail reference consistent. |
@@ -54,5 +54,5 @@ [@iota-pico/api](../README.md) > [ICommonResponse](../interfaces/icommonresponse.md) | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -59,0 +59,0 @@ The duration of the request. |
@@ -29,5 +29,5 @@ [@iota-pico/api](../README.md) > [IFindTransactionsRequest](../interfaces/ifindtransactionsrequest.md) | ||
**● addresses**: *`string`[]* | ||
**● addresses**: *`string`[]* | ||
*Defined in [models/IFindTransactionsRequest.ts:13](https://github.com/iota-pico/api/blob/5406202/src/models/IFindTransactionsRequest.ts#L13)* | ||
*Defined in [models/IFindTransactionsRequest.ts:13](https://github.com/iota-pico/api/blob/f238b42/src/models/IFindTransactionsRequest.ts#L13)* | ||
@@ -37,3 +37,2 @@ List of addresses. | ||
___ | ||
<a id="approvees"></a> | ||
@@ -43,5 +42,5 @@ | ||
**● approvees**: *`string`[]* | ||
**● approvees**: *`string`[]* | ||
*Defined in [models/IFindTransactionsRequest.ts:21](https://github.com/iota-pico/api/blob/5406202/src/models/IFindTransactionsRequest.ts#L21)* | ||
*Defined in [models/IFindTransactionsRequest.ts:21](https://github.com/iota-pico/api/blob/f238b42/src/models/IFindTransactionsRequest.ts#L21)* | ||
@@ -51,3 +50,2 @@ List of approvees of a transaction. | ||
___ | ||
<a id="bundles"></a> | ||
@@ -57,5 +55,5 @@ | ||
**● bundles**: *`string`[]* | ||
**● bundles**: *`string`[]* | ||
*Defined in [models/IFindTransactionsRequest.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/IFindTransactionsRequest.ts#L9)* | ||
*Defined in [models/IFindTransactionsRequest.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/IFindTransactionsRequest.ts#L9)* | ||
@@ -65,3 +63,2 @@ List of bundle hashes. The hashes need to be extended to 81chars by padding the hash with 9's. | ||
___ | ||
<a id="tags"></a> | ||
@@ -71,5 +68,5 @@ | ||
**● tags**: *`string`[]* | ||
**● tags**: *`string`[]* | ||
*Defined in [models/IFindTransactionsRequest.ts:17](https://github.com/iota-pico/api/blob/5406202/src/models/IFindTransactionsRequest.ts#L17)* | ||
*Defined in [models/IFindTransactionsRequest.ts:17](https://github.com/iota-pico/api/blob/f238b42/src/models/IFindTransactionsRequest.ts#L17)* | ||
@@ -76,0 +73,0 @@ List of transaction tags. |
@@ -29,7 +29,7 @@ [@iota-pico/api](../README.md) > [IFindTransactionsResponse](../interfaces/ifindtransactionsresponse.md) | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -39,3 +39,2 @@ The duration of the request. | ||
___ | ||
<a id="hashes"></a> | ||
@@ -45,5 +44,5 @@ | ||
**● hashes**: *`string`[]* | ||
**● hashes**: *`string`[]* | ||
*Defined in [models/IFindTransactionsResponse.ts:16](https://github.com/iota-pico/api/blob/5406202/src/models/IFindTransactionsResponse.ts#L16)* | ||
*Defined in [models/IFindTransactionsResponse.ts:16](https://github.com/iota-pico/api/blob/f238b42/src/models/IFindTransactionsResponse.ts#L16)* | ||
@@ -50,0 +49,0 @@ The transaction hashes which are returned depend on your input. For each specified input value, the command will return the following: bundles: returns the list of transactions which contain the specified bundle hash. addresses: returns the list of transactions which have the specified address as an input/output field. tags: returns the list of transactions which contain the specified tag value. approvees: returns the list of transaction which reference (i.e. confirm) the specified transaction. |
@@ -27,5 +27,5 @@ [@iota-pico/api](../README.md) > [IGetBalancesRequest](../interfaces/igetbalancesrequest.md) | ||
**● addresses**: *`string`[]* | ||
**● addresses**: *`string`[]* | ||
*Defined in [models/IGetBalancesRequest.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/IGetBalancesRequest.ts#L9)* | ||
*Defined in [models/IGetBalancesRequest.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetBalancesRequest.ts#L9)* | ||
@@ -35,3 +35,2 @@ List of addresses you want to get the confirmed balance from. | ||
___ | ||
<a id="threshold"></a> | ||
@@ -41,5 +40,5 @@ | ||
**● threshold**: *`number`* | ||
**● threshold**: *`number`* | ||
*Defined in [models/IGetBalancesRequest.ts:13](https://github.com/iota-pico/api/blob/5406202/src/models/IGetBalancesRequest.ts#L13)* | ||
*Defined in [models/IGetBalancesRequest.ts:13](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetBalancesRequest.ts#L13)* | ||
@@ -46,0 +45,0 @@ Confirmation threshold, should be set to 100. |
@@ -31,5 +31,5 @@ [@iota-pico/api](../README.md) > [IGetBalancesResponse](../interfaces/igetbalancesresponse.md) | ||
**● balances**: *`string`[]* | ||
**● balances**: *`string`[]* | ||
*Defined in [models/IGetBalancesResponse.ts:11](https://github.com/iota-pico/api/blob/5406202/src/models/IGetBalancesResponse.ts#L11)* | ||
*Defined in [models/IGetBalancesResponse.ts:11](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetBalancesResponse.ts#L11)* | ||
@@ -39,3 +39,2 @@ List of balances for the addresses. | ||
___ | ||
<a id="duration"></a> | ||
@@ -45,7 +44,7 @@ | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -55,3 +54,2 @@ The duration of the request. | ||
___ | ||
<a id="milestone"></a> | ||
@@ -61,5 +59,5 @@ | ||
**● milestone**: *`string`* | ||
**● milestone**: *`string`* | ||
*Defined in [models/IGetBalancesResponse.ts:15](https://github.com/iota-pico/api/blob/5406202/src/models/IGetBalancesResponse.ts#L15)* | ||
*Defined in [models/IGetBalancesResponse.ts:15](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetBalancesResponse.ts#L15)* | ||
@@ -69,3 +67,2 @@ The milestone at which the balances were calculated. | ||
___ | ||
<a id="milestoneindex"></a> | ||
@@ -75,5 +72,5 @@ | ||
**● milestoneIndex**: *`number`* | ||
**● milestoneIndex**: *`number`* | ||
*Defined in [models/IGetBalancesResponse.ts:19](https://github.com/iota-pico/api/blob/5406202/src/models/IGetBalancesResponse.ts#L19)* | ||
*Defined in [models/IGetBalancesResponse.ts:19](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetBalancesResponse.ts#L19)* | ||
@@ -80,0 +77,0 @@ The milestone index at which the balances were calculated. |
@@ -27,5 +27,5 @@ [@iota-pico/api](../README.md) > [IGetInclusionStatesRequest](../interfaces/igetinclusionstatesrequest.md) | ||
**● tips**: *`string`[]* | ||
**● tips**: *`string`[]* | ||
*Defined in [models/IGetInclusionStatesRequest.ts:13](https://github.com/iota-pico/api/blob/5406202/src/models/IGetInclusionStatesRequest.ts#L13)* | ||
*Defined in [models/IGetInclusionStatesRequest.ts:13](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetInclusionStatesRequest.ts#L13)* | ||
@@ -35,3 +35,2 @@ List of tips (including milestones) you want to search for the inclusion state. | ||
___ | ||
<a id="transactions"></a> | ||
@@ -41,5 +40,5 @@ | ||
**● transactions**: *`string`[]* | ||
**● transactions**: *`string`[]* | ||
*Defined in [models/IGetInclusionStatesRequest.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/IGetInclusionStatesRequest.ts#L9)* | ||
*Defined in [models/IGetInclusionStatesRequest.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetInclusionStatesRequest.ts#L9)* | ||
@@ -46,0 +45,0 @@ List of transactions you want to get the inclusion state for. |
@@ -29,7 +29,7 @@ [@iota-pico/api](../README.md) > [IGetInclusionStatesResponse](../interfaces/igetinclusionstatesresponse.md) | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -39,3 +39,2 @@ The duration of the request. | ||
___ | ||
<a id="states"></a> | ||
@@ -45,5 +44,5 @@ | ||
**● states**: *`boolean`[]* | ||
**● states**: *`boolean`[]* | ||
*Defined in [models/IGetInclusionStatesResponse.ts:12](https://github.com/iota-pico/api/blob/5406202/src/models/IGetInclusionStatesResponse.ts#L12)* | ||
*Defined in [models/IGetInclusionStatesResponse.ts:12](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetInclusionStatesResponse.ts#L12)* | ||
@@ -50,0 +49,0 @@ List of boolean values in the same order as the transaction list you submitted, thus you get a true/false whether a transaction is confirmed or not. |
@@ -29,7 +29,7 @@ [@iota-pico/api](../README.md) > [IGetMissingTransactionsResponse](../interfaces/igetmissingtransactionsresponse.md) | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -39,3 +39,2 @@ The duration of the request. | ||
___ | ||
<a id="hashes"></a> | ||
@@ -45,5 +44,5 @@ | ||
**● hashes**: *`string`[]* | ||
**● hashes**: *`string`[]* | ||
*Defined in [models/IGetMissingTransactionsResponse.ts:11](https://github.com/iota-pico/api/blob/5406202/src/models/IGetMissingTransactionsResponse.ts#L11)* | ||
*Defined in [models/IGetMissingTransactionsResponse.ts:11](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetMissingTransactionsResponse.ts#L11)* | ||
@@ -50,0 +49,0 @@ The transactions with missing references. |
@@ -29,7 +29,7 @@ [@iota-pico/api](../README.md) > [IGetNeighborsResponse](../interfaces/igetneighborsresponse.md) | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -39,3 +39,2 @@ The duration of the request. | ||
___ | ||
<a id="neighbors"></a> | ||
@@ -45,5 +44,5 @@ | ||
**● neighbors**: *[INeighbor](ineighbor.md)[]* | ||
**● neighbors**: *[INeighbor](ineighbor.md)[]* | ||
*Defined in [models/IGetNeighborsResponse.ts:12](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNeighborsResponse.ts#L12)* | ||
*Defined in [models/IGetNeighborsResponse.ts:12](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNeighborsResponse.ts#L12)* | ||
@@ -50,0 +49,0 @@ The neighbors of the node. |
@@ -44,5 +44,5 @@ [@iota-pico/api](../README.md) > [IGetNodeInfoResponse](../interfaces/igetnodeinforesponse.md) | ||
**● appName**: *`string`* | ||
**● appName**: *`string`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:11](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L11)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:11](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L11)* | ||
@@ -52,3 +52,2 @@ Name of the IOTA software you're currently using (IRI stands for Initial Reference Implementation). | ||
___ | ||
<a id="appversion"></a> | ||
@@ -58,5 +57,5 @@ | ||
**● appVersion**: *`string`* | ||
**● appVersion**: *`string`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:15](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L15)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:15](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L15)* | ||
@@ -66,3 +65,2 @@ The version of the IOTA software you're currently running. | ||
___ | ||
<a id="duration"></a> | ||
@@ -72,7 +70,7 @@ | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -82,3 +80,2 @@ The duration of the request. | ||
___ | ||
<a id="jreavailableprocessors"></a> | ||
@@ -88,5 +85,5 @@ | ||
**● jreAvailableProcessors**: *`number`* | ||
**● jreAvailableProcessors**: *`number`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:19](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L19)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:19](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L19)* | ||
@@ -96,3 +93,2 @@ Available cores on your machine for JRE. | ||
___ | ||
<a id="jrefreememory"></a> | ||
@@ -102,5 +98,5 @@ | ||
**● jreFreeMemory**: *`number`* | ||
**● jreFreeMemory**: *`number`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:27](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L27)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:27](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L27)* | ||
@@ -110,3 +106,2 @@ Returns the amount of free memory in the Java Virtual Machine. | ||
___ | ||
<a id="jremaxmemory"></a> | ||
@@ -116,5 +111,5 @@ | ||
**● jreMaxMemory**: *`number`* | ||
**● jreMaxMemory**: *`number`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:31](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L31)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:31](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L31)* | ||
@@ -124,3 +119,2 @@ Returns the maximum amount of memory that the Java virtual machine will attempt to use. | ||
___ | ||
<a id="jretotalmemory"></a> | ||
@@ -130,5 +124,5 @@ | ||
**● jreTotalMemory**: *`number`* | ||
**● jreTotalMemory**: *`number`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:35](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L35)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:35](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L35)* | ||
@@ -138,3 +132,2 @@ Returns the total amount of memory in the Java virtual machine. | ||
___ | ||
<a id="jreversion"></a> | ||
@@ -144,5 +137,5 @@ | ||
**● jreVersion**: *`number`* | ||
**● jreVersion**: *`number`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:23](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L23)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:23](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L23)* | ||
@@ -152,3 +145,2 @@ The version of the Java Virtual Machine. | ||
___ | ||
<a id="latestmilestone"></a> | ||
@@ -158,5 +150,5 @@ | ||
**● latestMilestone**: *`string`* | ||
**● latestMilestone**: *`string`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:39](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L39)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:39](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L39)* | ||
@@ -166,3 +158,2 @@ Latest milestone that was signed off by the coordinator. | ||
___ | ||
<a id="latestmilestoneindex"></a> | ||
@@ -172,5 +163,5 @@ | ||
**● latestMilestoneIndex**: *`number`* | ||
**● latestMilestoneIndex**: *`number`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:43](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L43)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:43](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L43)* | ||
@@ -180,3 +171,2 @@ Index of the latest milestone. | ||
___ | ||
<a id="latestsolidsubtanglemilestone"></a> | ||
@@ -186,5 +176,5 @@ | ||
**● latestSolidSubtangleMilestone**: *`string`* | ||
**● latestSolidSubtangleMilestone**: *`string`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:49](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L49)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:49](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L49)* | ||
@@ -194,3 +184,2 @@ The latest milestone which is solid and is used for sending transactions. For a milestone to become solid your local node must basically approve the subtangle of coordinator-approved transactions, and have a consistent view of all referenced transactions. | ||
___ | ||
<a id="latestsolidsubtanglemilestoneindex"></a> | ||
@@ -200,5 +189,5 @@ | ||
**● latestSolidSubtangleMilestoneIndex**: *`number`* | ||
**● latestSolidSubtangleMilestoneIndex**: *`number`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:53](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L53)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:53](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L53)* | ||
@@ -208,3 +197,2 @@ Index of the latest solid subtangle. | ||
___ | ||
<a id="neighbors"></a> | ||
@@ -214,5 +202,5 @@ | ||
**● neighbors**: *`number`* | ||
**● neighbors**: *`number`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:57](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L57)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:57](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L57)* | ||
@@ -222,3 +210,2 @@ Number of neighbors you are directly connected with. | ||
___ | ||
<a id="packetsqueuesize"></a> | ||
@@ -228,5 +215,5 @@ | ||
**● packetsQueueSize**: *`number`* | ||
**● packetsQueueSize**: *`number`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:61](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L61)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:61](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L61)* | ||
@@ -236,3 +223,2 @@ Packets which are currently queued up. | ||
___ | ||
<a id="time"></a> | ||
@@ -242,5 +228,5 @@ | ||
**● time**: *`number`* | ||
**● time**: *`number`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:65](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L65)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:65](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L65)* | ||
@@ -250,3 +236,2 @@ Current UNIX timestamp. | ||
___ | ||
<a id="tips"></a> | ||
@@ -256,5 +241,5 @@ | ||
**● tips**: *`number`* | ||
**● tips**: *`number`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:69](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L69)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:69](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L69)* | ||
@@ -264,3 +249,2 @@ Number of tips in the network. | ||
___ | ||
<a id="transactionstorequest"></a> | ||
@@ -270,5 +254,5 @@ | ||
**● transactionsToRequest**: *`number`* | ||
**● transactionsToRequest**: *`number`* | ||
*Defined in [models/IGetNodeInfoResponse.ts:73](https://github.com/iota-pico/api/blob/5406202/src/models/IGetNodeInfoResponse.ts#L73)* | ||
*Defined in [models/IGetNodeInfoResponse.ts:73](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetNodeInfoResponse.ts#L73)* | ||
@@ -275,0 +259,0 @@ Transactions to request during syncing process. |
@@ -29,7 +29,7 @@ [@iota-pico/api](../README.md) > [IGetTipsResponse](../interfaces/igettipsresponse.md) | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -39,3 +39,2 @@ The duration of the request. | ||
___ | ||
<a id="hashes"></a> | ||
@@ -45,5 +44,5 @@ | ||
**● hashes**: *`string`[]* | ||
**● hashes**: *`string`[]* | ||
*Defined in [models/IGetTipsResponse.ts:11](https://github.com/iota-pico/api/blob/5406202/src/models/IGetTipsResponse.ts#L11)* | ||
*Defined in [models/IGetTipsResponse.ts:11](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetTipsResponse.ts#L11)* | ||
@@ -50,0 +49,0 @@ The hashes for the tips. |
@@ -28,5 +28,5 @@ [@iota-pico/api](../README.md) > [IGetTransactionsToApproveRequest](../interfaces/igettransactionstoapproverequest.md) | ||
**● depth**: *`number`* | ||
**● depth**: *`number`* | ||
*Defined in [models/IGetTransactionsToApproveRequest.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/IGetTransactionsToApproveRequest.ts#L9)* | ||
*Defined in [models/IGetTransactionsToApproveRequest.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetTransactionsToApproveRequest.ts#L9)* | ||
@@ -36,3 +36,2 @@ Number of bundles to go back to determine the transactions for approval. | ||
___ | ||
<a id="numwalks"></a> | ||
@@ -42,5 +41,5 @@ | ||
**● numWalks**: *`number`* | ||
**● numWalks**: *`number`* | ||
*Defined in [models/IGetTransactionsToApproveRequest.ts:19](https://github.com/iota-pico/api/blob/5406202/src/models/IGetTransactionsToApproveRequest.ts#L19)* | ||
*Defined in [models/IGetTransactionsToApproveRequest.ts:19](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetTransactionsToApproveRequest.ts#L19)* | ||
@@ -50,3 +49,2 @@ The number of walks to perform. | ||
___ | ||
<a id="reference"></a> | ||
@@ -56,5 +54,5 @@ | ||
**● reference**: *`string`* | ||
**● reference**: *`string`* | ||
*Defined in [models/IGetTransactionsToApproveRequest.ts:14](https://github.com/iota-pico/api/blob/5406202/src/models/IGetTransactionsToApproveRequest.ts#L14)* | ||
*Defined in [models/IGetTransactionsToApproveRequest.ts:14](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetTransactionsToApproveRequest.ts#L14)* | ||
@@ -61,0 +59,0 @@ The reference to include in the lookup. |
@@ -30,5 +30,5 @@ [@iota-pico/api](../README.md) > [IGetTransactionsToApproveResponse](../interfaces/igettransactionstoapproveresponse.md) | ||
**● branchTransaction**: *`string`* | ||
**● branchTransaction**: *`string`* | ||
*Defined in [models/IGetTransactionsToApproveResponse.ts:15](https://github.com/iota-pico/api/blob/5406202/src/models/IGetTransactionsToApproveResponse.ts#L15)* | ||
*Defined in [models/IGetTransactionsToApproveResponse.ts:15](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetTransactionsToApproveResponse.ts#L15)* | ||
@@ -38,3 +38,2 @@ The branch transaction. | ||
___ | ||
<a id="duration"></a> | ||
@@ -44,7 +43,7 @@ | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -54,3 +53,2 @@ The duration of the request. | ||
___ | ||
<a id="trunktransaction"></a> | ||
@@ -60,5 +58,5 @@ | ||
**● trunkTransaction**: *`string`* | ||
**● trunkTransaction**: *`string`* | ||
*Defined in [models/IGetTransactionsToApproveResponse.ts:11](https://github.com/iota-pico/api/blob/5406202/src/models/IGetTransactionsToApproveResponse.ts#L11)* | ||
*Defined in [models/IGetTransactionsToApproveResponse.ts:11](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetTransactionsToApproveResponse.ts#L11)* | ||
@@ -65,0 +63,0 @@ The trunk transaction. |
@@ -26,5 +26,5 @@ [@iota-pico/api](../README.md) > [IGetTrytesRequest](../interfaces/igettrytesrequest.md) | ||
**● hashes**: *`string`[]* | ||
**● hashes**: *`string`[]* | ||
*Defined in [models/IGetTrytesRequest.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/IGetTrytesRequest.ts#L9)* | ||
*Defined in [models/IGetTrytesRequest.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetTrytesRequest.ts#L9)* | ||
@@ -31,0 +31,0 @@ List of transaction hashes of which you want to get trytes from. |
@@ -29,7 +29,7 @@ [@iota-pico/api](../README.md) > [IGetTrytesResponse](../interfaces/igettrytesresponse.md) | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -39,3 +39,2 @@ The duration of the request. | ||
___ | ||
<a id="trytes"></a> | ||
@@ -45,5 +44,5 @@ | ||
**● trytes**: *`string`[]* | ||
**● trytes**: *`string`[]* | ||
*Defined in [models/IGetTrytesResponse.ts:11](https://github.com/iota-pico/api/blob/5406202/src/models/IGetTrytesResponse.ts#L11)* | ||
*Defined in [models/IGetTrytesResponse.ts:11](https://github.com/iota-pico/api/blob/f238b42/src/models/IGetTrytesResponse.ts#L11)* | ||
@@ -50,0 +49,0 @@ Trytes of the requested hashes. |
@@ -29,5 +29,5 @@ [@iota-pico/api](../README.md) > [INeighbor](../interfaces/ineighbor.md) | ||
**● address**: *`string`* | ||
**● address**: *`string`* | ||
*Defined in [models/INeighbor.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/INeighbor.ts#L9)* | ||
*Defined in [models/INeighbor.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/INeighbor.ts#L9)* | ||
@@ -37,3 +37,2 @@ The address of your peer. | ||
___ | ||
<a id="numberofalltransactions"></a> | ||
@@ -43,5 +42,5 @@ | ||
**● numberOfAllTransactions**: *`number`* | ||
**● numberOfAllTransactions**: *`number`* | ||
*Defined in [models/INeighbor.ts:13](https://github.com/iota-pico/api/blob/5406202/src/models/INeighbor.ts#L13)* | ||
*Defined in [models/INeighbor.ts:13](https://github.com/iota-pico/api/blob/f238b42/src/models/INeighbor.ts#L13)* | ||
@@ -51,3 +50,2 @@ Number of all transactions sent (invalid, valid, already-seen). | ||
___ | ||
<a id="numberofinvalidtransactions"></a> | ||
@@ -57,5 +55,5 @@ | ||
**● numberOfInvalidTransactions**: *`number`* | ||
**● numberOfInvalidTransactions**: *`number`* | ||
*Defined in [models/INeighbor.ts:18](https://github.com/iota-pico/api/blob/5406202/src/models/INeighbor.ts#L18)* | ||
*Defined in [models/INeighbor.ts:18](https://github.com/iota-pico/api/blob/f238b42/src/models/INeighbor.ts#L18)* | ||
@@ -65,3 +63,2 @@ Invalid transactions your peer has sent you. These are transactions with invalid signatures or overall schema. | ||
___ | ||
<a id="numberofnewtransactions"></a> | ||
@@ -71,5 +68,5 @@ | ||
**● numberOfNewTransactions**: *`number`* | ||
**● numberOfNewTransactions**: *`number`* | ||
*Defined in [models/INeighbor.ts:22](https://github.com/iota-pico/api/blob/5406202/src/models/INeighbor.ts#L22)* | ||
*Defined in [models/INeighbor.ts:22](https://github.com/iota-pico/api/blob/f238b42/src/models/INeighbor.ts#L22)* | ||
@@ -76,0 +73,0 @@ New transactions which were transmitted. |
@@ -26,5 +26,5 @@ [@iota-pico/api](../README.md) > [IRemoveNeighborsRequest](../interfaces/iremoveneighborsrequest.md) | ||
**● uris**: *`string`[]* | ||
**● uris**: *`string`[]* | ||
*Defined in [models/IRemoveNeighborsRequest.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/IRemoveNeighborsRequest.ts#L9)* | ||
*Defined in [models/IRemoveNeighborsRequest.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/IRemoveNeighborsRequest.ts#L9)* | ||
@@ -31,0 +31,0 @@ List of URI elements. |
@@ -29,7 +29,7 @@ [@iota-pico/api](../README.md) > [IRemoveNeighborsResponse](../interfaces/iremoveneighborsresponse.md) | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -39,3 +39,2 @@ The duration of the request. | ||
___ | ||
<a id="removedneighbors"></a> | ||
@@ -45,5 +44,5 @@ | ||
**● removedNeighbors**: *`number`* | ||
**● removedNeighbors**: *`number`* | ||
*Defined in [models/IRemoveNeighborsResponse.ts:11](https://github.com/iota-pico/api/blob/5406202/src/models/IRemoveNeighborsResponse.ts#L11)* | ||
*Defined in [models/IRemoveNeighborsResponse.ts:11](https://github.com/iota-pico/api/blob/f238b42/src/models/IRemoveNeighborsResponse.ts#L11)* | ||
@@ -50,0 +49,0 @@ The number of neighbours removed. |
@@ -26,5 +26,5 @@ [@iota-pico/api](../README.md) > [IStoreTransactionsRequest](../interfaces/istoretransactionsrequest.md) | ||
**● trytes**: *`string`[]* | ||
**● trytes**: *`string`[]* | ||
*Defined in [models/IStoreTransactionsRequest.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/IStoreTransactionsRequest.ts#L9)* | ||
*Defined in [models/IStoreTransactionsRequest.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/IStoreTransactionsRequest.ts#L9)* | ||
@@ -31,0 +31,0 @@ List of raw data of transactions to be stored. |
@@ -26,5 +26,5 @@ [@iota-pico/api](../README.md) > [IWereAddressesSpentFromRequest](../interfaces/iwereaddressesspentfromrequest.md) | ||
**● addresses**: *`string`[]* | ||
**● addresses**: *`string`[]* | ||
*Defined in [models/IWereAddressesSpentFromRequest.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/IWereAddressesSpentFromRequest.ts#L9)* | ||
*Defined in [models/IWereAddressesSpentFromRequest.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/IWereAddressesSpentFromRequest.ts#L9)* | ||
@@ -31,0 +31,0 @@ The address hashes to check if they were spent from. |
@@ -29,7 +29,7 @@ [@iota-pico/api](../README.md) > [IWereAddressesSpentFromResponse](../interfaces/iwereaddressesspentfromresponse.md) | ||
**● duration**: *`number`* | ||
**● duration**: *`number`* | ||
*Inherited from [ICommonResponse](icommonresponse.md).[duration](icommonresponse.md#duration)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/5406202/src/models/ICommonResponse.ts#L9)* | ||
*Defined in [models/ICommonResponse.ts:9](https://github.com/iota-pico/api/blob/f238b42/src/models/ICommonResponse.ts#L9)* | ||
@@ -39,3 +39,2 @@ The duration of the request. | ||
___ | ||
<a id="states"></a> | ||
@@ -45,5 +44,5 @@ | ||
**● states**: *`boolean`[]* | ||
**● states**: *`boolean`[]* | ||
*Defined in [models/IWereAddressesSpentFromResponse.ts:11](https://github.com/iota-pico/api/blob/5406202/src/models/IWereAddressesSpentFromResponse.ts#L11)* | ||
*Defined in [models/IWereAddressesSpentFromResponse.ts:11](https://github.com/iota-pico/api/blob/f238b42/src/models/IWereAddressesSpentFromResponse.ts#L11)* | ||
@@ -50,0 +49,0 @@ States which are true if the corresponding input address was spent from. |
{ | ||
"name": "@iota-pico/api", | ||
"version": "0.9.3", | ||
"version": "0.9.4", | ||
"description": "IOTA Pico Framework API", | ||
@@ -50,3 +50,3 @@ "typings": "dist/index.d.ts", | ||
"dependencies": { | ||
"@iota-pico/core": "^0.9.3" | ||
"@iota-pico/core": "^0.9.4" | ||
}, | ||
@@ -58,3 +58,3 @@ "devDependencies": { | ||
"@babel/runtime": "^7.0.0-beta.42", | ||
"@types/chai": "^4.1.1", | ||
"@types/chai": "^4.1.3", | ||
"@types/mocha": "^5.2.0", | ||
@@ -74,4 +74,4 @@ "@types/sinon": "^4.3.1", | ||
"sinon": "^4.5.0", | ||
"source-map-support": "^0.5.4", | ||
"ts-node": "^5.0.1", | ||
"source-map-support": "^0.5.5", | ||
"ts-node": "^6.0.1", | ||
"tslint": "^5.9.1", | ||
@@ -81,8 +81,8 @@ "tslint-eslint-rules": "^5.1.0", | ||
"typedoc": "^0.11.1", | ||
"typedoc-plugin-markdown": "^1.1.4", | ||
"typedoc-plugin-markdown": "^1.1.6", | ||
"typescript": "^2.8.3", | ||
"uglifyjs-webpack-plugin": "^1.2.5", | ||
"webpack": "^4.6.0", | ||
"webpack-cli": "^2.0.14" | ||
"webpack-cli": "^2.0.15" | ||
} | ||
} |
@@ -1,3 +0,3 @@ | ||
[](https://raw.githubusercontent.com/https://github.com/iota-pico/api/master/LICENSE) [](https://travis-ci.org/https://github.com/iota-pico/api) [](https://nodesecurity.io/orgs/https://github.com/iota-pico/projects/32c93b32-c428-469a-9cea-41362108fe86) | ||
[](https://coveralls.io/github/https://github.com/iota-pico/api) | ||
[](https://raw.githubusercontent.com/iota-pico/api/master/LICENSE) [](https://travis-ci.org/iota-pico/api) [](https://nodesecurity.io/orgs/iota-pico/projects/32c93b32-c428-469a-9cea-41362108fe86) | ||
[](https://coveralls.io/github/iota-pico/api) | ||
@@ -4,0 +4,0 @@ # IOTA Pico Framework API |
384885
Updated@iota-pico/core@^0.9.4