@audius/sdk 0.0.0

package/src/services/dataContracts/RegistryClient.ts

@@ -0,0 +1,95 @@
+import { ContractABI, Utils } from '../../utils'
+import { Web3Manager } from '../web3Manager'
+import { ProviderSelection } from '../contracts/ProviderSelection'
+import type { HttpProvider } from 'web3-core'
+import type { Contract } from 'web3-eth-contract'
+
+export class RegistryClient {
+  web3Manager: Web3Manager
+  contractABI: ContractABI['abi']
+  contractAddress: string
+  Registry: Contract
+  providerSelector: ProviderSelection | null
+
+  constructor(
+    web3Manager: Web3Manager,
+    contractABI: ContractABI['abi'],
+    contractAddress: string
+  ) {
+    this.web3Manager = web3Manager
+    this.contractABI = contractABI
+    this.contractAddress = contractAddress
+
+    const web3 = this.web3Manager.getWeb3()
+    this.Registry = new web3.eth.Contract(contractABI, contractAddress)
+
+    if (
+      this.web3Manager instanceof Web3Manager &&
+      !this.web3Manager.web3Config.useExternalWeb3
+    ) {
+      const providerEndpoints =
+        this.web3Manager.web3Config.internalWeb3Config.web3ProviderEndpoints
+      this.providerSelector = new ProviderSelection(providerEndpoints)
+    } else {
+      this.providerSelector = null
+    }
+  }
+
+  async getContract(contractRegistryKey: string): Promise<string | undefined> {
+    try {
+      Utils.checkStrLen(contractRegistryKey, 32)
+      const contract = await this.Registry.methods
+        .getContract(Utils.utf8ToHex(contractRegistryKey))
+        .call()
+      return contract
+    } catch (e) {
+      // If using ethWeb3Manager or useExternalWeb3 is true, do not do reselect provider logic and fail
+      if (!this.providerSelector) {
+        console.error(
+          `Failed to initialize contract ${JSON.stringify(this.contractABI)}`,
+          e
+        )
+        return
+      }
+
+      return await this.retryInit(contractRegistryKey)
+    }
+  }
+
+  async retryInit(contractRegistryKey: string) {
+    try {
+      await this.selectNewEndpoint()
+      const web3 = this.web3Manager.getWeb3()
+      this.Registry = new web3.eth.Contract(
+        this.contractABI,
+        this.contractAddress
+      )
+      return await this.getContract(contractRegistryKey)
+    } catch (e) {
+      console.error((e as Error).message)
+      return undefined
+    }
+  }
+
+  async selectNewEndpoint() {
+    const currentHost = (
+      this.web3Manager.getWeb3().currentProvider as HttpProvider
+    ).host
+    if (this.providerSelector) {
+      this.providerSelector.addUnhealthy(currentHost)
+
+      if (
+        this.providerSelector.getUnhealthySize() ===
+        this.providerSelector.getServicesSize()
+      ) {
+        throw new Error(
+          `No available, healthy providers to get contract ${JSON.stringify(
+            this.contractABI
+          )}`
+        )
+      }
+
+      await this.providerSelector.select(this)
+    }
+  }
+}

package/src/services/dataContracts/SocialFeatureFactoryClient.ts

@@ -0,0 +1,196 @@
+import { ContractClient } from '../contracts/ContractClient'
+import * as signatureSchemas from '../../../data-contracts/signatureSchemas'
+import type { Web3Manager } from '../web3Manager'
+
+export class SocialFeatureFactoryClient extends ContractClient {
+  override web3Manager!: Web3Manager
+
+  async addTrackRepost(userId: number, trackId: number) {
+    // generate new track repost request
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData =
+      signatureSchemas.generators.getAddTrackRepostRequestData(
+        chainId,
+        contractAddress,
+        userId,
+        trackId,
+        nonce
+      )
+    const sig = await this.web3Manager.signTypedData(signatureData)
+
+    // add new trackRepost to chain
+    const method = await this.getMethod(
+      'addTrackRepost',
+      userId,
+      trackId,
+      nonce,
+      sig
+    )
+    return await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+  }
+
+  async deleteTrackRepost(userId: number, trackId: number) {
+    // generate new delete track repost request
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData =
+      signatureSchemas.generators.getDeleteTrackRepostRequestData(
+        chainId,
+        contractAddress,
+        userId,
+        trackId,
+        nonce
+      )
+    const sig = await this.web3Manager.signTypedData(signatureData)
+
+    // delete trackRepost from chain
+    const method = await this.getMethod(
+      'deleteTrackRepost',
+      userId,
+      trackId,
+      nonce,
+      sig
+    )
+    return await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+  }
+
+  async addPlaylistRepost(userId: number, playlistId: number) {
+    // generate new playlist repost request
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData =
+      signatureSchemas.generators.getAddPlaylistRepostRequestData(
+        chainId,
+        contractAddress,
+        userId,
+        playlistId,
+        nonce
+      )
+    const sig = await this.web3Manager.signTypedData(signatureData)
+
+    // add new playlistRepost to chain
+    const method = await this.getMethod(
+      'addPlaylistRepost',
+      userId,
+      playlistId,
+      nonce,
+      sig
+    )
+    return await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+  }
+
+  async deletePlaylistRepost(userId: number, playlistId: number) {
+    // generate new delete playlist repost request
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData =
+      signatureSchemas.generators.getDeletePlaylistRepostRequestData(
+        chainId,
+        contractAddress,
+        userId,
+        playlistId,
+        nonce
+      )
+    const sig = await this.web3Manager.signTypedData(signatureData)
+
+    // delete playlistRepost from chain
+    const method = await this.getMethod(
+      'deletePlaylistRepost',
+      userId,
+      playlistId,
+      nonce,
+      sig
+    )
+    return await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+  }
+
+  async addUserFollow(followerUserId: number, followeeUserId: number) {
+    if (followerUserId === followeeUserId) {
+      throw new Error(
+        `addUserFollow -  identical value provided for follower and followee ${followerUserId}`
+      )
+    }
+    // generate new UserFollow request
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData = signatureSchemas.generators.getUserFollowRequestData(
+      chainId,
+      contractAddress,
+      followerUserId,
+      followeeUserId,
+      nonce
+    )
+    const sig = await this.web3Manager.signTypedData(signatureData)
+
+    // add new UserFollow to chain
+    const method = await this.getMethod(
+      'addUserFollow',
+      followerUserId,
+      followeeUserId,
+      nonce,
+      sig
+    )
+    return await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+  }
+
+  async deleteUserFollow(followerUserId: number, followeeUserId: number) {
+    if (followerUserId === followeeUserId) {
+      throw new Error(
+        `deleteUserFollow - Invalid identical value provided for follower and followee ${followerUserId}`
+      )
+    }
+    // generate new deleteUserFollow request
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData =
+      signatureSchemas.generators.getDeleteUserFollowRequestData(
+        chainId,
+        contractAddress,
+        followerUserId,
+        followeeUserId,
+        nonce
+      )
+    const sig = await this.web3Manager.signTypedData(signatureData)
+
+    // delete UserFollow from chain
+    const method = await this.getMethod(
+      'deleteUserFollow',
+      followerUserId,
+      followeeUserId,
+      nonce,
+      sig
+    )
+    return await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+  }
+}

package/src/services/dataContracts/TrackFactoryClient.ts

@@ -0,0 +1,131 @@
+import { ContractClient } from '../contracts/ContractClient'
+import * as signatureSchemas from '../../../data-contracts/signatureSchemas'
+import type { Web3Manager } from '../web3Manager'
+
+export class TrackFactoryClient extends ContractClient {
+  override web3Manager!: Web3Manager
+  /* -------  GETTERS ------- */
+
+  async getTrack(trackId: string) {
+    const method = await this.getMethod('getTrack', trackId)
+    return method.call()
+  }
+
+  /* -------  SETTERS ------- */
+
+  /** uint _userId, bytes32 _multihashDigest, uint8 _multihashHashFn, uint8 _multihashSize */
+  async addTrack(
+    userId: number,
+    multihashDigest: string,
+    multihashHashFn: number,
+    multihashSize: number
+  ) {
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData = signatureSchemas.generators.getAddTrackRequestData(
+      chainId,
+      contractAddress,
+      userId,
+      multihashDigest,
+      multihashHashFn,
+      multihashSize,
+      nonce
+    )
+
+    const sig = await this.web3Manager.signTypedData(signatureData)
+    const method = await this.getMethod(
+      'addTrack',
+      userId,
+      multihashDigest,
+      multihashHashFn,
+      multihashSize,
+      nonce,
+      sig
+    )
+
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return {
+      trackId: parseInt(tx.events?.['NewTrack']?.returnValues._id, 10),
+      txReceipt: tx
+    }
+  }
+
+  /** uint _trackId, uint _trackOwnerId, bytes32 _multihashDigest, uint8 _multihashHashFn, uint8 _multihashSize */
+  async updateTrack(
+    trackId: number,
+    trackOwnerId: number,
+    multihashDigest: string,
+    multihashHashFn: number,
+    multihashSize: number
+  ) {
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData = signatureSchemas.generators.getUpdateTrackRequestData(
+      chainId,
+      contractAddress,
+      trackId,
+      trackOwnerId,
+      multihashDigest,
+      multihashHashFn,
+      multihashSize,
+      nonce
+    )
+
+    const sig = await this.web3Manager.signTypedData(signatureData)
+    const method = await this.getMethod(
+      'updateTrack',
+      trackId,
+      trackOwnerId,
+      multihashDigest,
+      multihashHashFn,
+      multihashSize,
+      nonce,
+      sig
+    )
+
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+
+    return {
+      trackId: parseInt(tx.events?.['UpdateTrack']?.returnValues._trackId, 10),
+      txReceipt: tx
+    }
+  }
+
+  /**
+   * @return deleted trackId from on-chain event log
+   */
+  async deleteTrack(trackId: number) {
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData = signatureSchemas.generators.getDeleteTrackRequestData(
+      chainId,
+      contractAddress,
+      trackId,
+      nonce
+    )
+
+    const sig = await this.web3Manager.signTypedData(signatureData)
+    const method = await this.getMethod('deleteTrack', trackId, nonce, sig)
+
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return {
+      trackId: parseInt(tx.events?.['TrackDeleted']?.returnValues._trackId, 10),
+      txReceipt: tx
+    }
+  }
+}