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
laumair · Jun 8, 2020 · b280032 · b280032
1 parent 5e2501c
commit b280032
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 128 deletions.
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',
@@ -226,15 +225,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