@audius/sdk 3.0.3-beta.83 → 3.0.3-beta.84

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@audius/sdk",
-  "version": "3.0.3-beta.83",
+  "version": "3.0.3-beta.84",
   "audius": {
-    "releaseSHA": "950901e0c75f4b2f4e478a72ad2316a23fd8bc11"
+    "releaseSHA": "a742c13c166e5def2fca6faf9d40de19f6559e3f"
   },
   "description": "Audius SDK",
   "main": "dist/index.cjs.js",

package/src/api/ServiceProvider.ts

@@ -1,41 +1,13 @@
 import { sampleSize } from 'lodash'
 
 import { Base, BaseConstructorArgs } from './base'
-import { timeRequests } from '../utils/network'
 import { getNStorageNodes } from '../utils/getNStorageNodes'
-import { CreatorNodeSelection } from '../services/creatorNode'
 
-import type { Nullable, ServiceWithEndpoint } from '../utils'
+import type { ServiceWithEndpoint } from '../utils'
 
 const CONTENT_NODE_SERVICE_NAME = 'content-node'
 const DISCOVERY_NODE_SERVICE_NAME = 'discovery-node'
 
-// Default timeout for each content node's sync and health check
-const CONTENT_NODE_DEFAULT_SELECTION_TIMEOUT = 7500
-// Default time at which responses are considered equal weighting.
-// Content nodes that reply within 200ms of eachother are given equal footing
-// in selection
-const CONTENT_NODE_SELECTION_EQUIVALENCY_DELTA = 200
-
-type AutoSelectCreatorNodesConfig = {
-  // total number of nodes to fetch (2 secondaries means 3 total)
-  numberOfNodes?: number
-  // whether or not to include only specified nodes (default no whitelist)
-  whitelist?: Nullable<Set<string>>
-  // whether or not to exclude any nodes (default no blacklist)
-  blacklist?: Nullable<Set<string>>
-  // whether or not to perform sync check
-  performSyncCheck?: boolean
-  // ms applied to each request made to a content node
-  timeout?: number
-  equivalencyDelta?: number
-  preferHigherPatchForPrimary?: boolean
-  preferHigherPatchForSecondaries?: boolean
-  log?: boolean
-  // override going to chain to generate a list of all service endpoints
-  getServices?: () => Promise<string[]>
-}
-
 /**
  * API methods to interact with Audius service providers.
  * Types of services include:
@@ -66,85 +38,6 @@ export class ServiceProvider extends Base {
     )
   }
 
-  /**
-   * Fetches healthy Content Nodes filtered down to a given whitelist and blacklist
-   */
-  async getSelectableCreatorNodes(
-    whitelist: Nullable<Set<string>> = null, // whether or not to include only specified nodes (default no whiltelist)
-    blacklist: Nullable<Set<string>> = null, // whether or not to exclude any nodes (default no blacklist)
-    timeout = CONTENT_NODE_DEFAULT_SELECTION_TIMEOUT
-  ) {
-    let creatorNodes = await this.listCreatorNodes()
-
-    // Filter whitelist
-    if (whitelist) {
-      creatorNodes = creatorNodes.filter((node) => whitelist.has(node.endpoint))
-    }
-    // Filter blacklist
-    if (blacklist) {
-      creatorNodes = creatorNodes.filter(
-        (node) => !blacklist.has(node.endpoint)
-      )
-    }
-
-    // Time requests and get version info
-    const timings = await timeRequests({
-      requests: creatorNodes.map((node) => ({
-        id: node.endpoint,
-        url: `${node.endpoint}/health_check/verbose`
-      })),
-      sortByVersion: true,
-      timeout,
-      headers: {
-        'User-Agent':
-          'Axios - @audius/sdk - ServiceProvider.ts#getSelectableCreatorNodes'
-      }
-    })
-
-    const services: { [id: string]: any } = {}
-    timings.forEach((timing) => {
-      if (timing.response && timing.request.id)
-        services[timing.request.id] = timing.response.data.data
-    })
-
-    return services
-  }
-
-  /**
-   * Fetches healthy Content Nodes and autoselects a primary
-   * and two secondaries.
-   */
-  async autoSelectCreatorNodes({
-    numberOfNodes = 3,
-    whitelist = null,
-    blacklist = null,
-    performSyncCheck = true,
-    timeout = CONTENT_NODE_DEFAULT_SELECTION_TIMEOUT,
-    equivalencyDelta = CONTENT_NODE_SELECTION_EQUIVALENCY_DELTA,
-    preferHigherPatchForPrimary = true,
-    preferHigherPatchForSecondaries = true,
-    log = true,
-    getServices
-  }: AutoSelectCreatorNodesConfig) {
-    const creatorNodeSelection = new CreatorNodeSelection({
-      creatorNode: this.creatorNode,
-      ethContracts: this.ethContracts,
-      logger: this.logger,
-      numberOfNodes,
-      whitelist,
-      blacklist,
-      timeout,
-      equivalencyDelta,
-      preferHigherPatchForPrimary,
-      preferHigherPatchForSecondaries,
-      getServices
-    })
-
-    const { primary, secondaries, services } =
-      await creatorNodeSelection.select(performSyncCheck, log)
-    return { primary, secondaries, services }
-  }
-
   /**
    * Selects numNodes storage nodes from the list of registered storage nodes on chain, optionally ordering them (descending) by rendezvous score.
    * TODO: This might want to handle blocklist/allowlist, latency checks, health checks, etc... but for now it just uses all nodes.

package/src/services/creatorNode/index.ts

@@ -1,2 +1 @@
 export * from './CreatorNode'
-export * from './CreatorNodeSelection'

package/dist/services/creatorNode/CreatorNodeSelection.d.ts

@@ -1,96 +0,0 @@
-import { EthContracts } from '../ethContracts';
-import { ServiceSelection, ServiceSelectionConfig } from '../../service-selection';
-import { ServiceName, Timing, Logger } from '../../utils';
-import { DECISION_TREE_STATE } from './constants';
-import type { MonitoringCallbacks } from '../types';
-declare type Timeout = number | null;
-export declare function getSpIDForEndpoint(endpoint: string): number | undefined;
-export declare function setSpIDForEndpoint(endpoint: string, spID?: number): void;
-declare type CreatorNode = {
-    passList: Set<string> | null;
-    blockList: Set<string> | null;
-    monitoringCallbacks: MonitoringCallbacks;
-};
-declare type CreatorNodeSelectionConfig = Omit<ServiceSelectionConfig, 'getServices'> & {
-    creatorNode: CreatorNode;
-    numberOfNodes: number;
-    ethContracts: EthContracts;
-    maxStorageUsedPercent?: number;
-    timeout?: Timeout;
-    equivalencyDelta?: number | null;
-    preferHigherPatchForPrimary?: boolean;
-    preferHigherPatchForSecondaries?: boolean;
-    logger?: Logger;
-    getServices?: () => Promise<string[]>;
-};
-interface Decision {
-    stage: DECISION_TREE_STATE;
-    val?: unknown;
-}
-export declare class CreatorNodeSelection extends ServiceSelection {
-    decisionTree: Decision[];
-    currentVersion: string | null;
-    ethContracts: EthContracts;
-    creatorNode: CreatorNode;
-    numberOfNodes: number;
-    timeout: Timeout;
-    equivalencyDelta: number | null;
-    preferHigherPatchForPrimary: boolean;
-    preferHigherPatchForSecondaries: boolean;
-    healthCheckPath: string;
-    backupsList: string[];
-    backupTimings: Timing[];
-    maxStorageUsedPercent: number;
-    logger: Logger;
-    constructor({ creatorNode, numberOfNodes, ethContracts, whitelist, blacklist, logger, maxStorageUsedPercent, timeout, equivalencyDelta, preferHigherPatchForPrimary, preferHigherPatchForSecondaries, getServices }: CreatorNodeSelectionConfig);
-    /**
-     * Selects a primary and secondary Content Nodes. Order of preference is highest version, then response time.
-     *
-     * 1. Retrieve all the Content Node services
-     * 2. Filter from/out Content Nodes based off of the whitelist and blacklist
-     * 3. Filter out unhealthy, outdated, and still syncing nodes via health and sync check
-     * 4. Sort by healthiest (highest version -> lowest version); secondary check if equal version based off of responseTime
-     * 5. Select a primary and numberOfNodes-1 number of secondaries (most likely 2) from backups
-     * @param @deprecated performSyncCheck (deprecated / unused) whether or not to check whether the nodes need syncs before selection
-     */
-    select(_performSyncCheck?: boolean, log?: boolean): Promise<{
-        primary: string;
-        secondaries: string[];
-        services: Record<string, any>;
-    }>;
-    /**
-     * Sets backupsList to input
-     * @param backupsList string array of Content Node endpoints
-     */
-    setBackupsList(backupsList: ServiceName[], backupTimings: Timing[]): void;
-    /**
-     * Get backups in the form of an array
-     */
-    getBackupsList(): string[];
-    /**
-     * Get backup timings in the form of an array
-     */
-    getBackupTimings(): Timing[];
-    /**
-     * Select a primary Content Node
-     * @param {string[]} services all healthy Content Node endpoints
-     */
-    getPrimary(services: string[]): string;
-    /**
-     * Selects secondary Content Nodes
-     * Returns first nodes from `services`, optionally sorted by version
-     */
-    getSecondaries(): string[];
-    /**
-     * Performs a health check for every endpoint in services. Returns an array of successful health checked endpoints and
-     * adds the err'd health checked endpoints to this.unhealthy, and a mapping of successful endpoint to its health check response.
-     * @param services content node endpoints
-     */
-    _performHealthChecks(services: string[]): Promise<{
-        healthyServicesList: string[];
-        healthyServicesMap: Record<string, any>;
-        healthyServiceTimings: Timing[];
-    }>;
-    _hasEnoughStorageSpace(storagePathSize?: number | null, storagePathUsed?: number | null): boolean;
-}
-export {};

package/dist/services/creatorNode/CreatorNodeSelection.test.d.ts

@@ -1 +0,0 @@
-export {};