@audius/sdk 0.0.1 → 0.0.2

package/dist/types.d.ts

@@ -2111,12 +2111,12 @@ declare type ButtonOptions = {
     fullWidth: boolean;
 };
 declare type OauthConfig = {
-    appName?: string;
+    appName: string;
     discoveryProvider: DiscoveryProvider;
 };
 declare class Oauth {
     discoveryProvider: DiscoveryProvider;
-    appName: string | null;
+    appName: string;
     activePopupWindow: null | Window;
     popupCheckInterval: NodeJS.Timer | null;
     loginSuccessCallback: LoginSuccessCallback | null;
@@ -2145,7 +2145,7 @@ declare type SdkConfig = {
 /**
  * The Audius SDK
  */
-declare const sdk: (config?: SdkConfig | undefined) => Promise<{
+declare const sdk: (config: SdkConfig) => Promise<{
     oauth: Oauth | undefined;
     discoveryNode: DiscoveryProvider;
 }>;

package/examples/initAudiusLibs.js

@@ -43,9 +43,9 @@ async function initAudiusLibs(
         ethWeb3ProviderEndpoint,
         ethWallet
       ),
-      discoveryProviderConfig: AudiusLibs.configDiscoveryProvider(
-        new Set(['http://docker.for.mac.localhost:5000'])
-      ),
+      discoveryProviderConfig: {
+        whitelist: new Set(['http://docker.for.mac.localhost:5000'])
+      },
       isServer,
       isDebug
     }
@@ -63,7 +63,6 @@ async function initAudiusLibs(
         ethContractsConfig.ownerWallet
       ),
       creatorNodeConfig: AudiusLibs.configCreatorNode(creatorNodeEndpoint),
-      discoveryProviderConfig: AudiusLibs.configDiscoveryProvider(),
       identityServiceConfig: AudiusLibs.configIdentityService(
         identityServiceEndpoint
       ),

package/examples/initializeVersions.js

@@ -2,7 +2,8 @@ const Web3 = require('../src/web3')
 const AudiusLibs = require('../src/index')
 const serviceTypeList = ['discovery-node', 'content-node']
 const dataWeb3ProviderEndpoint = 'https://sokol.poa.network:443'
-const ethWeb3ProviderEndpoint = 'https://ropsten.infura.io/v3/c569c6faf4f14d15a49d0044e7ddd668'
+const ethWeb3ProviderEndpoint =
+  'https://ropsten.infura.io/v3/c569c6faf4f14d15a49d0044e7ddd668'
 const dataRegistryAddress = '0x09033761774Fe45F40A47191DdF873F18B62DE05'
 const ethRegistryAddress = '0xB631ABAA63a26311366411b2025F0cAca00DE27F'
 const ethTokenAddress = '0xF8e679Aa54361467B12c7394BFF57Eb890f6d934'
@@ -10,7 +11,7 @@ let latestVersionStr = '0.1.0'
 
 const isServer = true
 
-const getEnv = env => {
+const getEnv = (env) => {
   const value = process.env[env]
   if (typeof value === 'undefined') {
     console.log(`${env} has not been set.`)
@@ -25,7 +26,7 @@ const getEnv = env => {
    export AUDIUS_OWNER_WALLET=
  * */
 
-async function initializeVersionServiceProviderContracts () {
+async function initializeVersionServiceProviderContracts() {
   let audiusLibsConfig
   let privateKey = getEnv('AUDIUS_PRIVATE_KEY')
   let ownerWallet = getEnv('AUDIUS_OWNER_WALLET')
@@ -36,7 +37,9 @@ async function initializeVersionServiceProviderContracts () {
   console.log(privateKey)
   console.log(ownerWallet)
 
-  const dataWeb3 = new Web3(new Web3.providers.HttpProvider(dataWeb3ProviderEndpoint))
+  const dataWeb3 = new Web3(
+    new Web3.providers.HttpProvider(dataWeb3ProviderEndpoint)
+  )
   let web3DataContractConfig = {
     registryAddress: dataRegistryAddress,
     useExternalWeb3: true,
@@ -46,7 +49,9 @@ async function initializeVersionServiceProviderContracts () {
     }
   }
 
-  const ethWeb3 = new Web3(new Web3.providers.HttpProvider(ethWeb3ProviderEndpoint))
+  const ethWeb3 = new Web3(
+    new Web3.providers.HttpProvider(ethWeb3ProviderEndpoint)
+  )
   audiusLibsConfig = {
     web3Config: web3DataContractConfig,
     ethWeb3Config: AudiusLibs.configEthWeb3(
@@ -55,7 +60,6 @@ async function initializeVersionServiceProviderContracts () {
       ethWeb3,
       ownerWallet
     ),
-    discoveryProviderConfig: AudiusLibs.configDiscoveryProvider(),
     isServer: isServer
   }
   let audiusLibs = new AudiusLibs(audiusLibsConfig)
@@ -84,9 +88,17 @@ async function initializeVersionServiceProviderContracts () {
   }
   */
   for (const serviceType of serviceTypeList) {
-    let versionTx = await audiusLibs.ethContracts.ServiceTypeManagerClient.getCurrentVersion(serviceType)
-    let numVersionsTx = await audiusLibs.ethContracts.ServiceTypeManagerClient.getNumberOfVersions(serviceType)
-    console.log(`${serviceType} | current version: ${versionTx} | number of versions : ${numVersionsTx}`)
+    let versionTx =
+      await audiusLibs.ethContracts.ServiceTypeManagerClient.getCurrentVersion(
+        serviceType
+      )
+    let numVersionsTx =
+      await audiusLibs.ethContracts.ServiceTypeManagerClient.getNumberOfVersions(
+        serviceType
+      )
+    console.log(
+      `${serviceType} | current version: ${versionTx} | number of versions : ${numVersionsTx}`
+    )
   }
 
   console.log('/----version init---')

package/initScripts/mainnet.js

@@ -34,29 +34,47 @@ const run = async () => {
         const versionStr = args[5]
         let dryRun = true
         // if args[6] is defined and the value is either bool or string false, set dryRun to false
-        if (args[6] && (['false', false].includes(args[6]))) {
+        if (args[6] && ['false', false].includes(args[6])) {
           dryRun = false
         }
         if (!serviceType || !versionStr) {
-          throw new Error('missing arguments - format: node mainnet.js setversion <serviceType> <versionStr>')
+          throw new Error(
+            'missing arguments - format: node mainnet.js setversion <serviceType> <versionStr>'
+          )
         }
-        await setServiceVersion(audiusLibs, serviceType, versionStr, privateKey, dryRun)
+        await setServiceVersion(
+          audiusLibs,
+          serviceType,
+          versionStr,
+          privateKey,
+          dryRun
+        )
         break
       case 'addservicetype':
         const newServiceType = args[4]
         const serviceTypeMin = args[5]
         const serviceTypeMax = args[6]
         if (!newServiceType || !serviceTypeMin || !serviceTypeMax) {
-          throw new Error('missing arguments - format: node mainnet.js addservicetype <serviceType> <serviceTypeMin> <serviceTypeMax>')
+          throw new Error(
+            'missing arguments - format: node mainnet.js addservicetype <serviceType> <serviceTypeMin> <serviceTypeMax>'
+          )
         }
-        await addServiceType(audiusLibs, newServiceType, serviceTypeMin, serviceTypeMax, privateKey)
+        await addServiceType(
+          audiusLibs,
+          newServiceType,
+          serviceTypeMin,
+          serviceTypeMax,
+          privateKey
+        )
         break
       case 'getclaim':
         await getClaimInfo(audiusLibs)
         break
       case 'fundclaim':
         if (!args[4]) {
-          throw new Error('missing argument - format: node mainnet.js fundclaim <amountOfAuds>')
+          throw new Error(
+            'missing argument - format: node mainnet.js fundclaim <amountOfAuds>'
+          )
         }
 
         const amountOfAuds = args[4]
@@ -77,7 +95,7 @@ const run = async () => {
 
 run()
 
-function getLibsConfig (config, privateKey, ownerWallet) {
+function getLibsConfig(config, privateKey, ownerWallet) {
   let audiusLibsConfig
   if (!privateKey || !ownerWallet) {
     throw new Error('Missing private key or owner wallet')
@@ -86,7 +104,9 @@ function getLibsConfig (config, privateKey, ownerWallet) {
   console.log(privateKey)
   console.log(ownerWallet)
 
-  const dataWeb3 = new Web3(new Web3.providers.HttpProvider(config.dataWeb3ProviderEndpoint))
+  const dataWeb3 = new Web3(
+    new Web3.providers.HttpProvider(config.dataWeb3ProviderEndpoint)
+  )
   const web3DataContractConfig = {
     registryAddress: config.dataRegistryAddress,
     useExternalWeb3: true,
@@ -96,7 +116,9 @@ function getLibsConfig (config, privateKey, ownerWallet) {
     }
   }
 
-  const ethWeb3 = new Web3(new Web3.providers.HttpProvider(config.ethWeb3ProviderEndpoint))
+  const ethWeb3 = new Web3(
+    new Web3.providers.HttpProvider(config.ethWeb3ProviderEndpoint)
+  )
   audiusLibsConfig = {
     web3Config: web3DataContractConfig,
     ethWeb3Config: AudiusLibs.configEthWeb3(
@@ -105,20 +127,19 @@ function getLibsConfig (config, privateKey, ownerWallet) {
       ethWeb3,
       ownerWallet
     ),
-    discoveryProviderConfig: AudiusLibs.configDiscoveryProvider(),
     isServer: isServer
   }
   return audiusLibsConfig
 }
 
-async function getAudiusLibs (config, privateKey, ownerWallet) {
+async function getAudiusLibs(config, privateKey, ownerWallet) {
   const audiusLibsConfig = getLibsConfig(config, privateKey, ownerWallet)
   const audiusLibs = new AudiusLibs(audiusLibsConfig)
   await audiusLibs.init()
   return audiusLibs
 }
 
-function _getEnv (env) {
+function _getEnv(env) {
   const value = process.env[env]
   if (typeof value === 'undefined') {
     throw new Error(`${env} has not been set.`)
@@ -126,6 +147,8 @@ function _getEnv (env) {
   return value
 }
 
-function _throwArgError () {
-  throw new Error('missing argument - format: node mainnet.js <configFilePath> [setversion, fundclaim, getclaim, stakeinfo] [additional options]')
+function _throwArgError() {
+  throw new Error(
+    'missing argument - format: node mainnet.js <configFilePath> [setversion, fundclaim, getclaim, stakeinfo] [additional options]'
+  )
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@audius/sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/types.d.ts",

package/src/libs.js

@@ -5,7 +5,7 @@ const { SolanaAudiusData } = require('./services/solanaAudiusData/index')
 const { Web3Manager } = require('./services/web3Manager')
 const { EthContracts } = require('./services/ethContracts')
 const SolanaWeb3Manager = require('./services/solanaWeb3Manager/index')
-const { AudiusContracts } = require('./services/dataContracts/index')
+const { AudiusContracts } = require('./services/dataContracts')
 const { IdentityService } = require('./services/identity')
 const { Comstock } = require('./services/comstock')
 const { Hedgehog } = require('./services/hedgehog')
@@ -34,50 +34,12 @@ const {
   RewardsAttester
 } = require('./services/solanaWeb3Manager/rewardsAttester')
 class AudiusLibs {
-  /**
-   * Configures a discovery provider wrapper
-   * @param {Set<string>?} whitelist whether or not to include only specified nodes (default no whitelist)
-   * @param {Set<string>?} blacklist whether or not to exclude specified nodes (default no blacklist)
-   * @param {number?} reselectTimeout timeout to clear locally cached discovery providers
-   * @param {(selection: string) => void?} selectionCallback invoked with the select discovery provider
-   * @param {object?} monitoringCallbacks callbacks to be invoked with metrics from requests sent to a service
-   *  @param {function} monitoringCallbacks.request
-   *  @param {function} monitoringCallbacks.healthCheck
-   * @param {number?} selectionRequestTimeout the amount of time (ms) an individual request should take before reselecting
-   * @param {number?} selectionRequestRetries the number of retries to a given discovery node we make before reselecting
-   * @param {number?} unhealthySlotDiffPlays the number of slots we would consider a discovery node unhealthy
-   * @param {number?} unhealthyBlockDiff the number of missed blocks after which we would consider a discovery node unhealthy
-   */
-  static configDiscoveryProvider(
-    whitelist = null,
-    blacklist = null,
-    reselectTimeout = null,
-    selectionCallback = null,
-    monitoringCallbacks = {},
-    selectionRequestTimeout = null,
-    selectionRequestRetries = null,
-    unhealthySlotDiffPlays = null,
-    unhealthyBlockDiff = null
-  ) {
-    return {
-      whitelist,
-      blacklist,
-      reselectTimeout,
-      selectionCallback,
-      monitoringCallbacks,
-      selectionRequestTimeout,
-      selectionRequestRetries,
-      unhealthySlotDiffPlays,
-      unhealthyBlockDiff
-    }
-  }
-
   /**
    * Configures an identity service wrapper
    * @param {string} url
    * @param {boolean?} useHedgehogLocalStorage whether or not to read hedgehog entropy in local storage
    */
-  static configIdentityService(url, useHedgehogLocalStorage = true) {
+  static configIdentityService (url, useHedgehogLocalStorage = true) {
     return { url, useHedgehogLocalStorage }
   }
 
@@ -85,7 +47,7 @@ class AudiusLibs {
    * Configures an identity service wrapper
    * @param {string} url
    */
-  static configComstock(url) {
+  static configComstock (url) {
     return { url }
   }
 
@@ -100,7 +62,7 @@ class AudiusLibs {
    * @param {function} monitoringCallbacks.request
    * @param {function} monitoringCallbacks.healthCheck
    */
-  static configCreatorNode(
+  static configCreatorNode (
     fallbackUrl,
     lazyConnect = false,
     passList = null,
@@ -124,7 +86,7 @@ class AudiusLibs {
    * @param {?string} walletOverride wallet address to force use instead of the first wallet on the provided web3
    * @param {?number} walletIndex if using a wallet returned from web3, pick the wallet at this index
    */
-  static async configExternalWeb3(
+  static async configExternalWeb3 (
     registryAddress,
     web3Provider,
     networkId,
@@ -150,7 +112,7 @@ class AudiusLibs {
    * @param {string} registryAddress
    * @param {string | Web3 | Array<string>} providers web3 provider endpoint(s)
    */
-  static configInternalWeb3(registryAddress, providers, privateKey) {
+  static configInternalWeb3 (registryAddress, providers, privateKey) {
     let providerList
     if (typeof providers === 'string') {
       providerList = providers.split(',')
@@ -183,7 +145,7 @@ class AudiusLibs {
    * @param {string?} claimDistributionContractAddress
    * @param {string?} wormholeContractAddress
    */
-  static configEthWeb3(
+  static configEthWeb3 (
     tokenAddress,
     registryAddress,
     providers,
@@ -223,7 +185,7 @@ class AudiusLibs {
    * @param {string} config.ethBridgeAddress
    * @param {string} config.ethTokenBridgeAddress
    */
-  static configWormhole({
+  static configWormhole ({
     rpcHosts,
     solBridgeAddress,
     solTokenBridgeAddress,
@@ -267,7 +229,7 @@ class AudiusLibs {
    * @param {PublicKey|string} audiusDataProgramId program ID for the audius-data Anchor program
    * @param {Idl} audiusDataIdl IDL for the audius-data Anchor program.
    */
-  static configSolanaWeb3({
+  static configSolanaWeb3 ({
     solanaClusterEndpoint,
     mintAddress,
     solanaTokenAddress,
@@ -319,7 +281,7 @@ class AudiusLibs {
    * @param {string} config.programId Program ID of the audius data program
    * @param {string} config.adminAccount Public Key of admin account
    */
-  static configSolanaAudiusData({ programId, adminAccount }) {
+  static configSolanaAudiusData ({ programId, adminAccount }) {
     return {
       programId,
       adminAccount
@@ -331,12 +293,12 @@ class AudiusLibs {
    * Unless default-valued, all configs are optional.
    * @example
    *  const audius = AudiusLibs({
-   *    discoveryProviderConfig: configDiscoveryProvider(),
+   *    discoveryProviderConfig: {},
    *    creatorNodeConfig: configCreatorNode('https://my-creator.node')
    *  })
    *  await audius.init()
    */
-  constructor({
+  constructor ({
     web3Config,
     ethWeb3Config,
     solanaWeb3Config,
@@ -405,7 +367,7 @@ class AudiusLibs {
   }
 
   /** Init services based on presence of a relevant config. */
-  async init() {
+  async init () {
     this.userStateManager = new UserStateManager()
     // Config external web3 is an async function, so await it here in case it needs to be
     this.web3Config = await this.web3Config
@@ -523,26 +485,13 @@ class AudiusLibs {
     }
 
     /** Discovery Provider */
-    if (this.discoveryProviderConfig) {
-      this.discoveryProvider = new DiscoveryProvider({
-        whitelist: this.discoveryProviderConfig.whitelist,
-        blacklist: this.discoveryProviderConfig.blacklist,
-        userStateManager: this.userStateManager,
-        ethContracts: this.ethContracts,
-        web3Manager: this.web3Manager,
-        reselectTimeout: this.discoveryProviderConfig.reselectTimeout,
-        selectionCallback: this.discoveryProviderConfig.selectionCallback,
-        monitoringCallbacks: this.discoveryProviderConfig.monitoringCallbacks,
-        selectionRequestTimeout:
-          this.discoveryProviderConfig.selectionRequestTimeout,
-        selectionRequestRetries:
-          this.discoveryProviderConfig.selectionRequestRetries,
-        unhealthySlothDiffPlays:
-          this.discoveryProviderConfig.unhealthySlotDiffPlays,
-        unhealthBlockDiff: this.discoveryProviderConfig.unhealthyBlockDiff
-      })
-      await this.discoveryProvider.init()
-    }
+    this.discoveryProvider = new DiscoveryProvider({
+      userStateManager: this.userStateManager,
+      ethContracts: this.ethContracts,
+      web3Manager: this.web3Manager,
+      ...this.discoveryProviderConfig
+    })
+    await this.discoveryProvider.init()
 
     /** Creator Node */
     if (this.creatorNodeConfig) {

package/src/sdk/oauth/Oauth.ts

@@ -105,13 +105,13 @@ const OAUTH_URL = 'https://audius.co/oauth/auth'
 const CSRF_TOKEN_KEY = 'audiusOauthState'
 
 type OauthConfig = {
-  appName?: string
+  appName: string
   discoveryProvider: DiscoveryProvider
 }
 
 export class Oauth {
   discoveryProvider: DiscoveryProvider
-  appName: string | null
+  appName: string
   activePopupWindow: null | Window
   popupCheckInterval: NodeJS.Timer | null
   loginSuccessCallback: LoginSuccessCallback | null
@@ -125,7 +125,7 @@ export class Oauth {
       )
     }
     this.discoveryProvider = discoveryProvider
-    this.appName = appName ?? null
+    this.appName = appName
     this.activePopupWindow = null
     this.loginSuccessCallback = null
     this.loginErrorCallback = null

package/src/sdk/sdk.ts

@@ -34,14 +34,14 @@ type SdkConfig = {
 /**
  * The Audius SDK
  */
-export const sdk = async (config?: SdkConfig) => {
+export const sdk = async (config: SdkConfig) => {
   const {
     appName,
     discoveryNodeConfig,
     ethContractsConfig,
     ethWeb3Config,
     identityServiceConfig
-  } = config ?? {}
+  } = config
 
   /** Initialize services */
 

package/src/services/ethWeb3Manager/EthWeb3Manager.ts

@@ -46,15 +46,13 @@ export class EthWeb3Manager {
     this.identityService = identityService
     this.hedgehog = hedgehog
 
-    // Hedgehog might not exist (in the case of @audius/sdk)
-    if (this.hedgehog) {
-      if (this.web3Config.ownerWallet) {
-        this.ownerWallet = this.web3Config.ownerWallet
-      } else {
-        const storedWallet = this.hedgehog.getWallet()
-        if (storedWallet) {
-          this.ownerWallet = storedWallet
-        }
+    if (this.web3Config.ownerWallet) {
+      this.ownerWallet = this.web3Config.ownerWallet
+    } else if (this.hedgehog) {
+      // Hedgehog might not exist (in the case of @audius/sdk)
+      const storedWallet = this.hedgehog.getWallet()
+      if (storedWallet) {
+        this.ownerWallet = storedWallet
       }
     }
   }

package/tests/governanceTest.js

@@ -5,7 +5,7 @@ const nock = require('nock')
 const { Vote } = require('../src/services/ethContracts/GovernanceClient')
 const time = require('@openzeppelin/test-helpers/src/time')
 const { initializeLibConfig } = require('./helpers')
-const AudiusLibs = require('../src')
+const AudiusLibs = require('../src/libs')
 
 const { audiusInstance: audius0, getRandomLocalhost } = helpers
 

package/tests/helpers.js

@@ -1,7 +1,7 @@
 const nock = require('nock')
 
 const Web3 = require('../src/web3')
-const AudiusLibs = require('../src/index')
+const AudiusLibs = require('../src/libs')
 const dataContractsConfig = require('../data-contracts/config.json')
 const ethContractsConfig = require('../eth-contracts/config.json')
 

package/tests/providerSelectionTest.js

@@ -211,7 +211,7 @@ function createContractClientWithInternalWeb3() {
       web3ProviderEndpoints: gateways
     }
   }
-  const web3Manager = new Web3Manager()
+  const web3Manager = new Web3Manager({})
   web3Manager.web3 = createWeb3Obj('https://audius.poa.network')
   web3Manager.web3Config = web3Config
   return createContractClient(web3Manager)
@@ -224,7 +224,7 @@ function createContractClientWithExternalWeb3() {
       web3ProviderEndpoints: gateways
     }
   }
-  const web3Manager = new Web3Manager()
+  const web3Manager = new Web3Manager({})
   web3Manager.web3 = createWeb3Obj('https://audius.poa.network')
   web3Manager.web3Config = web3Config
   return createContractClient(web3Manager)
@@ -235,7 +235,7 @@ function createContractClientWithEthWeb3Manager() {
     providers: ['https://audius.eth.network'],
     ownerWallet: '0xwallet'
   }
-  const ethWeb3Manager = new EthWeb3Manager(web3Config)
+  const ethWeb3Manager = new EthWeb3Manager({ web3Config })
   ethWeb3Manager.web3 = createWeb3Obj('https://eth.network')
   return createContractClient(ethWeb3Manager)
 }

package/tests/stakingTest.js

@@ -7,7 +7,7 @@ const { time } = require('@openzeppelin/test-helpers')
 const { getRandomLocalhost, audiusInstance: audius0 } = helpers
 const initializeLibConfig = helpers.initializeLibConfig
 const ethContractsConfig = require('../eth-contracts/config.json')
-const AudiusLibs = require('../src/index');
+const AudiusLibs = require('../src/libs');
 const { convertAudsToWeiBN } = require('../initScripts/helpers/utils');
 const { initial } = require('lodash')
 const { deregisterSPEndpoint } = require('./helpers')