feat: remove getTips() api (#483)

* feat: remove getTips() api IRI version 1.8.6 [removes](iotaledger/iri#1788) getTips() endpoint. This commit removes the implementation from this lib. Related: iotaledger/iri#1851 * docs: remove references to getTips * docs: fix missing link Co-authored-by: Rajiv Shah <[email protected]>
iotaledger · Jun 14, 2020 · db68444 · db68444
1 parent 47fd710
commit db68444
Show file tree

Hide file tree

Showing 10 changed files with 9 additions and 197 deletions.
diff --git a/README.md b/README.md
@@ -129,8 +129,6 @@ For details on all available API methods, see the [reference page](api_reference
 
 * [.getNodeInfo([callback])](api_reference.md#module_core.getNodeInfo)
 
-* [getTips([callback])](api_reference.md#module_core.getTips)
-
 * [getTransactionObjects(hashes, [callback])](api_reference.md#module_core.getTransactionObjects)
 
 * [.getTransactionsToApprove(depth, [reference], [callback])](api_reference.md#module_core.getTransactionsToApprove)

diff --git a/api_reference.md b/api_reference.md
@@ -336,10 +336,6 @@ Converts an integer value to trits
 
     * [.getNodeInfo([callback])](#module_core.getNodeInfo)
 
-    * [.createGetTips(provider)](#module_core.createGetTips)
-
-    * [.getTips([callback])](#module_core.getTips)
-
     * [.createGetTransactionObjects(provider)](#module_core.createGetTransactionObjects)
 
     * [.getTransactionObjects(hashes, [callback])](#module_core.getTransactionObjects)
@@ -1083,39 +1079,7 @@ getNodeInfo()
     // ...
   })
 ```
-<a name="module_core.createGetTips"></a>
-
-### *core*.createGetTips(provider)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| provider | <code>Provider</code> | Network provider |
-
-**Returns**: <code>function</code> - [`getTips`](#module_core.getTips)  
-<a name="module_core.getTips"></a>
-
-### *core*.getTips([callback])
-**Fulfil**: <code>Hash[]</code> List of tip hashes  
-**Reject**: <code>Error</code>
-- Fetch error  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [callback] | <code>Callback</code> | Optional callback |
 
-Returns a list of tips (transactions not referenced by other transactions),
-as seen by the connected node.
-
-**Example**  
-```js
-getTips()
-  .then(tips => {
-    // ...
-  })
-  .catch(err => {
-    // ...
-  })
-```
 <a name="module_core.createGetTransactionObjects"></a>
 
 ### *core*.createGetTransactionObjects(provider)

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -61,8 +61,6 @@ yarn add @iota/core
 
     * [.getNodeInfo([callback])](#module_core.getNodeInfo)
 
-    * [.getTips([callback])](#module_core.getTips)
-
     * [.getTransactionObjects(hashes, [callback])](#module_core.getTransactionObjects)
 
     * [.getTransactionsToApprove(depth, [reference], [callback])](#module_core.getTransactionsToApprove)
@@ -807,35 +805,6 @@ getNodeInfo()
     console.log(`Something went wrong: ${error}`);
   })
 ```
-<a name="module_core.getTips"></a>
-
-### *core*.getTips([callback])
-**Summary**: Searches the Tangle for tip transactions.  
-**Fulfil**: <code>Hash[]</code> tips - Array of tip transaction hashes  
-**Reject**: <code>Error</code> error - Fetch error: The connected IOTA node's API returned an error. See the [list of error messages](https://docs.iota.org/docs/node-software/0.1/iri/references/api-errors)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [callback] | <code>Callback</code> | Optional callback function |
-
-This method finds all transactions that aren't referenced by other transactions in the Tangle
-by calling the connected IRI node's [`getTips`](https://docs.iota.org/docs/node-software/0.1/iri/references/api-reference#gettips) endpoint.
-
-## Related methods
-
-To find two consistent tip transactions to use as branch and trunk transactions, use the [`getTransactionsToApprove()`](#module_core.getTransactionsToApprove) method.
-
-**Example**  
-```js
-getTips()
-  .then(tips => {
-    console.log('Found the following tip transactions:');
-    console.log(JSON.stringify(tips));
-  })
-  .catch(error => {
-    console.log(`Something went wrong: ${error}`);
-  })
-```
 <a name="module_core.getTransactionObjects"></a>
 
 ### *core*.getTransactionObjects(hashes, [callback])

diff --git a/packages/core/src/composeAPI.ts b/packages/core/src/composeAPI.ts
@@ -29,7 +29,6 @@ import {
     createGetNeighbors,
     createGetNewAddress,
     createGetNodeInfo,
-    createGetTips,
     createGetTransactionObjects,
     createGetTransactionsToApprove,
     createGetTrytes,
@@ -74,7 +73,7 @@ export function returnType<T>(func: Func<T>) {
 
 /**
  * @method composeApi
- * 
+ *
  * @summary Creates an API object that's used to send requests to an IRI node.
  *
  * @memberof module:core
@@ -89,12 +88,12 @@ export function returnType<T>(func: Func<T>) {
  * @example
  * ```js
  * const Iota = require('@iota/core`);
- * 
+ *
  * const iota = Iota.composeAPI({
  *  provider: 'https://nodes.devnet.thetangle.org:443'
  * });
  * ```
- * 
+ *
  * @return {API} iota - API object to use to interact with an IRI node.
  */
 export const composeAPI = (settings: Partial<Settings> = {}) => {
@@ -103,7 +102,7 @@ export const composeAPI = (settings: Partial<Settings> = {}) => {
 
     /**
      * @method setSettings
-     * 
+     *
      * @summary Defines network provider configuration and [`attachToTangle`]{@link #module_core.attachToTangle} method.
      *
      * @memberof API
@@ -126,13 +125,13 @@ export const composeAPI = (settings: Partial<Settings> = {}) => {
     }
 
     /**
-     * 
+     *
      * @method overrideNetwork
-     * 
+     *
      * @summary Overrides the default provider
      *
      * @memberof API
-     * 
+     *
      * @ignore
      *
      * @param {Provider} network - Provider instance to use to override the existing network settings
@@ -145,11 +144,11 @@ export const composeAPI = (settings: Partial<Settings> = {}) => {
     /**
      *
      * @method overrideAttachToTangle
-     * 
+     *
      * @summary Overrides the default [`attachToTangle`]{@link #module_core.attachToTangle} method
      *
      * @memberof API
-     * 
+     *
      * @ignore
      *
      * @param {function} attachToTangle - Function that overrides the
@@ -171,7 +170,6 @@ export const composeAPI = (settings: Partial<Settings> = {}) => {
         getInclusionStates: createGetInclusionStates(provider),
         getNeighbors: createGetNeighbors(provider),
         getNodeInfo: createGetNodeInfo(provider),
-        getTips: createGetTips(provider),
         getTransactionsToApprove: createGetTransactionsToApprove(provider),
         getTrytes: createGetTrytes(provider),
         interruptAttachingToTangle: createInterruptAttachingToTangle(provider),

diff --git a/packages/core/src/createGetTips.ts b/packages/core/src/createGetTips.ts
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -35,8 +35,6 @@ export {
     GetNeighborsResponse,
     GetNodeInfoCommand,
     GetNodeInfoResponse,
-    GetTipsCommand,
-    GetTipsResponse,
     GetTransactionsToApproveCommand,
     GetTransactionsToApproveResponse,
     TransactionsToApprove,
@@ -68,8 +66,6 @@ export { createGetNeighbors } from './createGetNeighbors'
 
 export { createGetNodeInfo } from './createGetNodeInfo'
 
-export { createGetTips } from './createGetTips'
-
 export { createGetTransactionsToApprove } from './createGetTransactionsToApprove'
 
 export { createGetTrytes } from './createGetTrytes'

diff --git a/packages/core/test/integration/getTips.test.ts b/packages/core/test/integration/getTips.test.ts
diff --git a/packages/core/test/integration/nocks/getTips.ts b/packages/core/test/integration/nocks/getTips.ts
diff --git a/packages/http-client/src/index.ts b/packages/http-client/src/index.ts
@@ -24,8 +24,6 @@ export {
     GetNeighborsResponse,
     GetNodeInfoCommand,
     GetNodeInfoResponse,
-    GetTipsCommand,
-    GetTipsResponse,
     GetTransactionsToApproveCommand,
     GetTransactionsToApproveResponse,
     TransactionsToApprove,

diff --git a/packages/types.ts b/packages/types.ts
@@ -89,7 +89,6 @@ export enum IRICommand {
     GET_NEIGHBORS = 'getNeighbors',
     ADD_NEIGHBORS = 'addNeighbors',
     REMOVE_NEIGHBORS = 'removeNeighbors',
-    GET_TIPS = 'getTips',
     FIND_TRANSACTIONS = 'findTransactions',
     GET_TRYTES = 'getTrytes',
     GET_INCLUSION_STATES = 'getInclusionStates',
@@ -225,15 +224,6 @@ export interface GetNodeInfoResponse {
     readonly transactionsToRequest: number
 }
 
-export interface GetTipsCommand extends BaseCommand {
-    command: IRICommand.GET_TIPS
-}
-
-export interface GetTipsResponse {
-    readonly hashes: ReadonlyArray<Hash>
-    readonly duration: number
-}
-
 export interface TransactionsToApprove {
     readonly trunkTransaction: Hash
     readonly branchTransaction: Hash