[PAY-2860] SDK Services Config - Configure SDK using environment

[rickyrombo]

Description

Fixes PAY-2860

Init SDK for a given environment using a simple environment key in config, eg:

const audiusSdk = sdk({ appName: 'ddex',  environment: 'staging' })

• Moves "network/environment" related config into the generated config objects
• Does away with the "bootstrap" idea, this is the config now
• Revamps the service initialization to be much more clear
• Changes defaultSomeServiceConfig constant to be getDefaultSomeServiceConfig() method that takes in the environment's service config

The SdkServiceConfig object has a key per network:

• network is the Audius network, which contains all the nodes (eg. Discovery Nodes, Storage Nodes, Anti Abuse Oracle Nodes, and Identity Service) and the min service version
• acdc is the key for the Audius chain, contains contracts and config used by Audius for ACDC
• solana is the key for the Solana network, contains the programs and mints used by Audius on Solana
• When we support eth contract interaction in SDK, that will go in an eth key.

Example SdkServicesConfig (dev) since it's hard to view in the diff:

/*
 * This file is autogenerated by ./scripts/generateServicesConfig.ts.
 * DO NOT EDIT MANUALLY!
 */
/* eslint-disable prettier/prettier */
import type { SdkServicesConfig } from './types'
export const developmentConfig: SdkServicesConfig = {
  "network": {
    "minVersion": "0.0.0",
    "discoveryNodes": [
      {
        "delegateOwnerWallet": "0xd09ba371c359f10f22ccda12fd26c598c7921bda3220c9942174562bc6a36fe8",
        "endpoint": "http://audius-protocol-discovery-provider-1",
        "ownerWallet": "0xd09ba371c359f10f22ccda12fd26c598c7921bda3220c9942174562bc6a36fe8"
      }
    ],
    "storageNodes": [
      {
        "delegateOwnerWallet": "0x0D38e653eC28bdea5A2296fD5940aaB2D0B8875c",
        "endpoint": "http://audius-protocol-creator-node-1"
      }
    ],
    "antiAbuseOracleNodes": {
      "endpoints": [
        "http://audius-protocol-anti-abuse-oracle-1:8000"
      ],
      "registeredAddresses": [
        "0xF0D5BC18421fa04D0a2A2ef540ba5A9f04014BE3"
      ]
    },
    "identityService": "https://audius-protocol-identity-service-1"
  },
  "acdc": {
    "entityManagerContractAddress": "0x254dffcd3277C0b1660F6d42EFbB754edaBAbC2B",
    "web3ProviderUrl": "http://audius-protocol-poa-ganache-1"
  },
  "solana": {
    "claimableTokensProgramAddress": "testHKV1B56fbvop4w6f2cTGEub9dRQ2Euta5VmqdX9",
    "rewardManagerProgramAddress": "testLsJKtyABc9UXJF8JWFKf1YH4LmqCWBC42c6akPb",
    "rewardManagerStateAddress": "DJPzVothq58SmkpRb1ATn5ddN2Rpv1j2TcGvM3XsHf1c",
    "rpcEndpoint": "http://audius-protocol-solana-test-validator-1",
    "usdcTokenMint": "26Q7gP8UfkDzi7GMFEQxTJaNJ8D2ybCUjex58M5MLu8y",
    "wAudioTokenMint": "37RCjhgV1qGV2Q54EHFScdxZ22ydRMdKMtVgod47fDP3"
  }
}

What getDefaultConfig looks like (DiscoveryNodeSelector):

import type { SdkServicesConfig } from '../../config/types'
import { Logger } from '../Logger'

import type { DiscoveryNodeSelectorServiceConfigInternal } from './types'

export const getDefaultDiscoveryNodeSelectorConfig = (
  config: SdkServicesConfig
): DiscoveryNodeSelectorServiceConfigInternal => ({
  initialSelectedNode: null,
  blocklist: null,
  allowlist: null,
  maxConcurrentRequests: 6,
  requestTimeout: 30000, // 30s
  unhealthyTTL: 3600000, // 1 hour
  backupsTTL: 120000, // 2 min
  healthCheckThresholds: {
    minVersion: config.network.minVersion,
    maxSlotDiffPlays: null,
    maxBlockDiff: 15
  },
  bootstrapServices: config.network.discoveryNodes,
  logger: new Logger()
})

Note that the service specific config (eg maxBlockDiff etc) is not in the root services config. It's not information about the environment.

The service constructor then looks like:

  constructor(config?: DiscoveryNodeSelectorServiceConfig) {
    this.config = mergeConfigWithDefaults(
      config,
      getDefaultDiscoveryNodeSelectorConfig(productionConfig)
    )
   // ...

And initialization in sdk.ts:

import { developmentConfig } from './config/development'
import { productionConfig } from './config/production'
import { stagingConfig } from './config/staging'

// ...

const initializeServices = (config: SdkConfig) => {
  const servicesConfig =
    config.environment === 'development'
      ? developmentConfig
      : config.environment === 'staging'
      ? stagingConfig
      : productionConfig

// ...

  const discoveryNodeSelector =
    config.services?.discoveryNodeSelector ??
    new DiscoveryNodeSelector({
      ...getDefaultDiscoveryNodeSelectorConfig(servicesConfig),
      logger
    })

//...

How Has This Been Tested?

TBD

[changeset-bot]

🦋 Changeset detected

Latest commit: f3d1dac

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@audius/sdk	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[gitguardian]

⚠️ GitGuardian has uncovered 14 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
1606950	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/scripts/generateServicesConfig.ts	View secret
1606950	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/config/production.ts	View secret
2416685	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/config/staging.ts	View secret
2460750	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/config/production.ts	View secret
4714545	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/config/development.ts	View secret
4714545	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/scripts/generateServicesConfig.ts	View secret
7150224	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/config/staging.ts	View secret
7150224	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/scripts/generateServicesConfig.ts	View secret
10622416	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/scripts/generateServicesConfig.ts	View secret
10622416	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/scripts/generateServicesConfig.ts	View secret
10622416	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/config/staging.ts	View secret
10622416	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/config/production.ts	View secret
10622417	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/scripts/generateServicesConfig.ts	View secret
10622417	Triggered	Generic High Entropy Secret	87b840e	packages/libs/src/sdk/config/development.ts	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secrets safely. Learn here the best practices.
3. Revoke and rotate these secrets.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

[raymondjacobson]

structure looks great to me. @audius/erc stuff should be straightforward to add

[sliptype]

Awesome! We def want a changeset for this, but I believe it's just an additive change so minor version bump?

[rickyrombo]

@sliptype i removed a barrel file for config but I can add it back to make it additive? want to talk about barrel files in sdk generally.. might be worth trying to eliminate those earlier rather than later

[sliptype]

@sliptype i removed a barrel file for config but I can add it back to make it additive? want to talk about barrel files in sdk generally.. might be worth trying to eliminate those earlier rather than later

Oh right, well we already have an existing major bump that hasn't been released so we can mark this one as major too. It will only result in one version increase

And yeah, I'm all for removing barrel files

[audius-infra]

Preview this change https://demo.audius.co/mjp-sdk-config-2

[audius-infra]

Preview this change https://demo.audius.co/mjp-sdk-config-2

[audius-infra]

Preview this change https://demo.audius.co/mjp-sdk-config-2