Make contracts lazy-initted

libs/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@audius/libs",
- "version": "0.11.32",
+ "version": "0.11.33",
  "description": "",
  "main": "src/index.js",
  "browser": {

libs/src/index.js

@@ -89,11 +89,11 @@ class AudiusLibs {
  * Configures an eth web3
  * @param {string} tokenAddress
  * @param {string} registryAddress
- * @param {object} web3
+ * @param {object} url web3 provider endpoint
  * @param {string} ownerWallet
  */
- static configEthWeb3 (tokenAddress, registryAddress, web3, ownerWallet) {
- return { tokenAddress, registryAddress, web3, ownerWallet }
+ static configEthWeb3 (tokenAddress, registryAddress, url, ownerWallet) {
+ return { tokenAddress, registryAddress, url, ownerWallet }
  }
 
  /**
@@ -145,7 +145,6 @@ class AudiusLibs {
  /** Init services based on presence of a relevant config. */
  async init () {
  this.userStateManager = new UserStateManager()
- this.web3Config = await this.web3Config
 
  /** Identity Service */
  if (this.identityServiceConfig) {
@@ -171,27 +170,25 @@ class AudiusLibs {
  await this.web3Manager.init()
  }
 
- let toInit = []
-
  /** Contracts */
+ let contractsToInit = []
  if (this.ethWeb3Manager) {
  this.ethContracts = new EthContracts(
  this.ethWeb3Manager,
  this.ethWeb3Config ? this.ethWeb3Config.tokenAddress : null,
  this.ethWeb3Config ? this.ethWeb3Config.registryAddress : null,
  this.isServer
  )
-toInit.push(this.ethContracts.init())
+contractsToInit.push(this.ethContracts.init())
  }
-
  if (this.web3Manager) {
  this.contracts = new AudiusContracts(
  this.web3Manager,
- this.web3Config ? this.web3Config.registryAddress : null)
- toInit.push(this.contracts.init())
+ this.web3Config ? this.web3Config.registryAddress : null,
+ this.isServer)
+ contractsToInit.push(this.contracts.init())
  }
-
- await Promise.all(toInit)
+ await Promise.all(contractsToInit)
 
  /** Discovery Provider */
  if (this.discoveryProviderConfig) {

libs/src/services/contracts/ContractClient.js

@@ -0,0 +1,79 @@
+const CONTRACT_INITIALIZING_INTERVAL = 100
+const CONTRACT_INITIALIZING_TIMEOUT = 10000
+
+/*
+ * Base class for instantiating contracts.
+ * Performs a single init of the eth contract the first
+ * time a method on the contract is invoked.
+ */
+class ContractClient {
+ constructor (web3Manager, contractABI, contractRegistryKey, getRegistryAddress) {
+ this.web3Manager = web3Manager
+ this.web3 = web3Manager.getWeb3()
+ this.contractABI = contractABI
+ this.contractRegistryKey = contractRegistryKey
+ this.getRegistryAddress = getRegistryAddress
+
+ // Once initialized, contract address and contract are set up
+ this._contractAddress = null
+ this._contract = null
+
+ // Initialization setup
+ this._isInitialized = false
+ this._isInitializing = false
+ }
+
+ /** Inits the contract if necessary */
+ async init () {
+ // No-op if we are already initted
+ if (this._isInitialized) return
+
+ // If we are already initting, wait until we are initted and return
+ if (this._isInitializing) {
+ let interval
+ await new Promise((resolve, reject) => {
+ interval = setInterval(() => {
+ if (this._isInitialized) resolve()
+ }, CONTRACT_INITIALIZING_INTERVAL)
+ setTimeout(() => {
+ reject(new Error('Initialization timeout'))
+ }, CONTRACT_INITIALIZING_TIMEOUT)
+ })
+ clearInterval(interval)
+ return
+ }
+
+ // Perform init
+ this._isInitializing = true
+
+ this._contractAddress = await this.getRegistryAddress(this.contractRegistryKey)
+ this._contract = new this.web3.eth.Contract(
+ this.contractABI,
+ this._contractAddress
+ )
+
+ this._isInitialized = false
+ this._isInitialized = true
+ }
+
+ /** Gets the contract address and ensures that the contract has initted. */
+ async getAddress () {
+ await this.init()
+ return this._contractAddress
+ }
+
+ /**
+ * Gets a contract method and ensures that the contract has initted
+ * The contract can then be invoked with .call() or be passed to a sendTransaction.
+ * @param {string} methodName the name of the contract method
+ */
+ async getMethod (methodName, ...args) {
+ await this.init()
+ if (!(methodName in this._contract.methods)) {
+ throw new Error(`Contract method ${methodName} not found in ${Object.keys(this._contract.methods)}`)
+ }
+ return this._contract.methods[methodName](...args)
+ }
+}
+
+module.exports = ContractClient

libs/src/services/dataContracts/IPLDBlacklistFactoryClient.js

@@ -1,35 +1,22 @@
+const ContractClient = require('../contracts/ContractClient')
 const signatureSchemas = require('../../../data-contracts/signatureSchemas')
 const sigUtil = require('eth-sig-util')
 const BufferSafe = require('safe-buffer').Buffer
 
-class IPLDBlacklistFactoryClient {
- constructor (web3Manager, contractABI, contractRegistryKey, getRegistryAddress) {
- this.web3Manager = web3Manager
- this.contractABI = contractABI
- this.contractRegistryKey = contractRegistryKey
- this.getRegistryAddress = getRegistryAddress
-
- this.web3 = this.web3Manager.getWeb3()
- }
-
- async init () {
- this.contractAddress = await this.getRegistryAddress(this.contractRegistryKey)
- this.IPLDBlacklistFactory = new this.web3.eth.Contract(this.contractABI, this.contractAddress)
- }
-
+class IPLDBlacklistFactoryClient extends ContractClient {
  async addIPLDToBlacklist (multihashDigest, privateKey = null) {
  const [nonce, sig] = await this.getUpdateNonceAndSig(
  signatureSchemas.generators.addIPLDToBlacklistRequestData,
  multihashDigest,
  privateKey
  )
- const contractMethod = this.IPLDBlacklistFactory.methods.addIPLDToBlacklist(
+ const method = await this.getMethod('addIPLDToBlacklist',
  multihashDigest,
  nonce,
  sig
  )
 
- const receipt = await contractMethod.send({ from: this.web3Manager.getWalletAddress(), gas: 200000 })
+ const receipt = await method.send({ from: this.web3Manager.getWalletAddress(), gas: 200000 })
  return receipt
  }
 
@@ -47,7 +34,8 @@ class IPLDBlacklistFactoryClient {
  async getUpdateNonceAndSig (generatorFn, multihashDigest, privateKey) {
  const nonce = signatureSchemas.getNonce()
  const chainId = await this.web3.eth.net.getId()
- const signatureData = generatorFn(chainId, this.contractAddress, multihashDigest, nonce)
+ const contractAddress = await this.getAddress()
+ const signatureData = generatorFn(chainId, contractAddress, multihashDigest, nonce)
  let sig
  if (privateKey) {
  sig = sigUtil.signTypedData(BufferSafe.from(privateKey, 'hex'), { data: signatureData })

libs/src/services/dataContracts/index.js

@@ -28,72 +28,74 @@ const UserLibraryFactoryRegistryKey = 'UserLibraryFactory'
 const IPLDBlacklistFactoryRegistryKey = 'IPLDBlacklistFactory'
 
 class AudiusContracts {
- constructor (web3Manager, registryAddress) {
+ constructor (web3Manager, registryAddress, isServer) {
  this.web3Manager = web3Manager
  this.registryAddress = registryAddress
-
- this.clients = []
- this.getRegistryAddressForContract = this.getRegistryAddressForContract.bind(this)
- }
-
- async init () {
- if (!this.web3Manager || !this.registryAddress) throw new Error('Failed to initialize DataContracts')
+ this.isServer = isServer
 
  this.RegistryClient = new RegistryClient(
  this.web3Manager,
  RegistryABI,
  this.registryAddress
  )
+ this.getRegistryAddressForContract = this.getRegistryAddressForContract.bind(this)
 
  this.UserFactoryClient = new UserFactoryClient(
  this.web3Manager,
  UserFactoryABI,
  UserFactoryRegistryKey,
  this.getRegistryAddressForContract
  )
- this.clients.push(this.UserFactoryClient)
 
  this.TrackFactoryClient = new TrackFactoryClient(
  this.web3Manager,
  TrackFactoryABI,
  TrackFactoryRegistryKey,
  this.getRegistryAddressForContract
  )
- this.clients.push(this.TrackFactoryClient)
 
  this.SocialFeatureFactoryClient = new SocialFeatureFactoryClient(
  this.web3Manager,
  SocialFeatureFactoryABI,
  SocialFeatureFactoryRegistryKey,
  this.getRegistryAddressForContract
  )
- this.clients.push(this.SocialFeatureFactoryClient)
 
  this.PlaylistFactoryClient = new PlaylistFactoryClient(
  this.web3Manager,
  PlaylistFactoryABI,
  PlaylistFactoryRegistryKey,
  this.getRegistryAddressForContract
  )
- this.clients.push(this.PlaylistFactoryClient)
 
  this.UserLibraryFactoryClient = new UserLibraryFactoryClient(
  this.web3Manager,
  UserLibraryFactoryABI,
  UserLibraryFactoryRegistryKey,
  this.getRegistryAddressForContract
  )
- this.clients.push(this.UserLibraryFactoryClient)
 
  this.IPLDBlacklistFactoryClient = new IPLDBlacklistFactoryClient(
  this.web3Manager,
  IPLDBlacklistFactoryABI,
  IPLDBlacklistFactoryRegistryKey,
  this.getRegistryAddressForContract
  )
- this.clients.push(this.IPLDBlacklistFactoryClient)
 
- await Promise.all(this.clients.map(async c => c.init()))
+ this.contractClients = [
+ this.UserFactoryClient,
+ this.TrackFactoryClient,
+ this.SocialFeatureFactoryClient,
+ this.PlaylistFactoryClient,
+ this.UserLibraryFactoryClient,
+ this.IPLDBlacklistFactoryClient
+ ]
+ }
+
+ async init () {
+ if (this.isServer) {
+ await Promise.all(this.contractClients.map(client => client.init()))
+ }
  }
 
  /* ------- CONTRACT META-FUNCTIONS ------- */