@audius/sdk 0.0.0

package/src/services/dataContracts/UserFactoryClient.ts

@@ -0,0 +1,351 @@
+import { ContractClient } from '../contracts/ContractClient'
+import * as signatureSchemas from '../../../data-contracts/signatureSchemas'
+import type { UserUpdateRequestFn } from '../../../data-contracts/signatureSchemas'
+import { Utils } from '../../utils'
+import sigUtil from 'eth-sig-util'
+import { Buffer as SafeBuffer } from 'safe-buffer'
+import type { Web3Manager } from '../web3Manager'
+
+export class UserFactoryClient extends ContractClient {
+  override web3Manager!: Web3Manager
+  /* ------- GETTERS ------- */
+
+  async getUser(userId: number) {
+    const method = await this.getMethod('getUser', userId)
+    return method.call()
+  }
+
+  /** valid = does not exist and meets handle requirements (defined on chain) */
+  async handleIsValid(handle: string) {
+    const method = await this.getMethod(
+      'handleIsValid',
+      Utils.utf8ToHex(handle)
+    )
+    return method.call()
+  }
+
+  /* ------- SETTERS ------- */
+
+  async addUser(handle: string) {
+    Utils.checkStrLen(handle, 16)
+
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData = signatureSchemas.generators.getAddUserRequestData(
+      chainId,
+      contractAddress,
+      handle,
+      nonce
+    )
+
+    const sig = await this.web3Manager.signTypedData(signatureData)
+    const method = await this.getMethod(
+      'addUser',
+      this.web3Manager.getWalletAddress(),
+      Utils.utf8ToHex(handle),
+      nonce,
+      sig
+    )
+
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return {
+      txReceipt: tx,
+      userId: parseInt(tx.events?.['AddUser']?.returnValues._userId, 10)
+    }
+  }
+
+  async updateMultihash(userId: number, multihashDigest: string) {
+    const [nonce, sig] = await this.getUpdateNonceAndSig(
+      signatureSchemas.generators.getUpdateUserMultihashRequestData,
+      userId,
+      multihashDigest
+    )
+    const method = await this.getMethod(
+      'updateMultihash',
+      userId,
+      multihashDigest,
+      nonce,
+      sig
+    )
+    const contractAddress = await this.getAddress()
+
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return {
+      txReceipt: tx,
+      multihashDigest:
+        tx.events?.['UpdateMultihash']?.returnValues._multihashDigest
+    }
+  }
+
+  async updateName(userId: number, name: string) {
+    Utils.checkStrLen(name, 32)
+
+    const [nonce, sig] = await this.getUpdateNonceAndSig(
+      signatureSchemas.generators.getUpdateUserNameRequestData,
+      userId,
+      name
+    )
+    const method = await this.getMethod(
+      'updateName',
+      userId,
+      Utils.utf8ToHex(name),
+      nonce,
+      sig
+    )
+    const contractAddress = await this.getAddress()
+
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return {
+      txReceipt: tx,
+      name: Utils.hexToUtf8(tx.events?.['UpdateName']?.returnValues._name)
+    }
+  }
+
+  async updateLocation(userId: number, location: string) {
+    const maxLength = 32
+    Utils.checkStrLen(location, maxLength, /* minLen */ 0)
+
+    const [nonce, sig] = await this.getUpdateNonceAndSig(
+      signatureSchemas.generators.getUpdateUserLocationRequestData,
+      userId,
+      location
+    )
+    const method = await this.getMethod(
+      'updateLocation',
+      userId,
+      Utils.padRight(Utils.utf8ToHex(location), maxLength * 2),
+      nonce,
+      sig
+    )
+    const contractAddress = await this.getAddress()
+
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return {
+      txReceipt: tx,
+      location: Utils.hexToUtf8(
+        tx.events?.['UpdateLocation']?.returnValues._location
+      )
+    }
+  }
+
+  async updateBio(userId: number, bio: string) {
+    const [nonce, sig] = await this.getUpdateNonceAndSig(
+      signatureSchemas.generators.getUpdateUserBioRequestData,
+      userId,
+      bio
+    )
+    const method = await this.getMethod('updateBio', userId, bio, nonce, sig)
+    const contractAddress = await this.getAddress()
+
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return {
+      txReceipt: tx,
+      bio: tx.events?.['UpdateBio']?.returnValues._bio
+    }
+  }
+
+  async updateProfilePhoto(
+    userId: number,
+    profilePhotoMultihashDigest: string
+  ) {
+    const [nonce, sig] = await this.getUpdateNonceAndSig(
+      signatureSchemas.generators.getUpdateUserProfilePhotoRequestData,
+      userId,
+      profilePhotoMultihashDigest
+    )
+    const method = await this.getMethod(
+      'updateProfilePhoto',
+      userId,
+      profilePhotoMultihashDigest,
+      nonce,
+      sig
+    )
+    const contractAddress = await this.getAddress()
+
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return {
+      txReceipt: tx,
+      profilePhotoMultihashDigest:
+        tx.events?.['UpdateProfilePhoto']?.returnValues._profilePhotoDigest
+    }
+  }
+
+  async updateCoverPhoto(userId: number, coverPhotoMultihashDigest: string) {
+    const [nonce, sig] = await this.getUpdateNonceAndSig(
+      signatureSchemas.generators.getUpdateUserCoverPhotoRequestData,
+      userId,
+      coverPhotoMultihashDigest
+    )
+    const method = await this.getMethod(
+      'updateCoverPhoto',
+      userId,
+      coverPhotoMultihashDigest,
+      nonce,
+      sig
+    )
+    const contractAddress = await this.getAddress()
+
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return {
+      txReceipt: tx,
+      coverPhotoMultihashDigest:
+        tx.events?.['UpdateCoverPhoto']?.returnValues._coverPhotoDigest
+    }
+  }
+
+  async updateIsCreator(userId: number, isCreator: boolean) {
+    const [nonce, sig] = await this.getUpdateNonceAndSig(
+      signatureSchemas.generators.getUpdateUserCreatorRequestData,
+      userId,
+      isCreator
+    )
+    const method = await this.getMethod(
+      'updateIsCreator',
+      userId,
+      isCreator,
+      nonce,
+      sig
+    )
+    const contractAddress = await this.getAddress()
+
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return {
+      txReceipt: tx,
+      isCreator: tx.events?.['UpdateIsCreator']?.returnValues._isCreator
+    }
+  }
+
+  /**
+   * This function is called from the identity service, not from the client. As a result,
+   * the return properties are different. The web3 sendTransaction() function isn't called, rather
+   * the encodedABI and contract address are returned, and the identity service can relay it
+   * to the chain on behalf of the user
+   * @param userId blockchain userId
+   * @param isVerified
+   * @param privateKey 64 character hex string
+   */
+  async updateIsVerified(
+    userId: number,
+    isVerified: boolean,
+    privateKey: string
+  ) {
+    const contractAddress = await this.getAddress()
+    const [nonce, sig] = await this.getUpdateNonceAndSig(
+      signatureSchemas.generators.getUpdateUserVerifiedRequestData,
+      userId,
+      isVerified,
+      privateKey
+    )
+    const method = await this.getMethod(
+      'updateIsVerified',
+      userId,
+      isVerified,
+      nonce,
+      sig
+    )
+
+    return [method.encodeABI(), contractAddress]
+  }
+
+  async updateCreatorNodeEndpoint(userId: number, creatorNodeEndpoint: string) {
+    const [nonce, sig] = await this.getUpdateNonceAndSig(
+      signatureSchemas.generators.getUpdateUserCreatorNodeRequestData,
+      userId,
+      creatorNodeEndpoint
+    )
+    const method = await this.getMethod(
+      'updateCreatorNodeEndpoint',
+      userId,
+      creatorNodeEndpoint,
+      nonce,
+      sig
+    )
+    const contractAddress = await this.getAddress()
+
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return {
+      txReceipt: tx,
+      creatorNodeEndpoint:
+        tx.events?.['UpdateCreatorNodeEndpoint']?.returnValues
+          ._creatorNodeEndpoint
+    }
+  }
+
+  /* ------- HELPERS ------- */
+
+  /**
+   * Gets a nonce and generates a signature for the given function. Private key is optional and
+   * will use that private key to create the signature. Otherwise the web3Manager private key
+   * will be used.
+   * @param generatorFn signature scheme object function
+   * @param userId blockchain userId
+   * @param newValue new value to set
+   * @param privateKey 64 character hex string
+   */
+  async getUpdateNonceAndSig(
+    generatorFn: UserUpdateRequestFn,
+    userId: number,
+    newValue: unknown,
+    privateKey?: string
+  ) {
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData = generatorFn(
+      chainId,
+      contractAddress,
+      userId,
+      newValue,
+      nonce
+    )
+    let sig
+    if (privateKey) {
+      sig = sigUtil.signTypedData(
+        SafeBuffer.from(privateKey, 'hex') as unknown as Buffer,
+        {
+          data: signatureData
+        }
+      )
+    } else {
+      sig = await this.web3Manager.signTypedData(signatureData)
+    }
+    return [nonce, sig]
+  }
+}

package/src/services/dataContracts/UserLibraryFactoryClient.ts

@@ -0,0 +1,115 @@
+import { ContractClient } from '../contracts/ContractClient'
+import * as signatureSchemas from '../../../data-contracts/signatureSchemas'
+import type { Web3Manager } from '../web3Manager'
+
+export class UserLibraryFactoryClient extends ContractClient {
+  override web3Manager!: Web3Manager
+  /* ------- SETTERS ------- */
+
+  async addTrackSave(userId: number, trackId: number) {
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData = signatureSchemas.generators.getTrackSaveRequestData(
+      chainId,
+      contractAddress,
+      userId,
+      trackId,
+      nonce
+    )
+    const sig = await this.web3Manager.signTypedData(signatureData)
+    const contractMethod = await this.getMethod(
+      'addTrackSave',
+      userId,
+      trackId,
+      nonce,
+      sig
+    )
+    return await this.web3Manager.sendTransaction(
+      contractMethod,
+      this.contractRegistryKey,
+      contractAddress
+    )
+  }
+
+  async deleteTrackSave(userId: number, trackId: number) {
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData =
+      signatureSchemas.generators.getDeleteTrackSaveRequestData(
+        chainId,
+        contractAddress,
+        userId,
+        trackId,
+        nonce
+      )
+    const sig = await this.web3Manager.signTypedData(signatureData)
+    const contractMethod = await this.getMethod(
+      'deleteTrackSave',
+      userId,
+      trackId,
+      nonce,
+      sig
+    )
+    return await this.web3Manager.sendTransaction(
+      contractMethod,
+      this.contractRegistryKey,
+      contractAddress
+    )
+  }
+
+  async addPlaylistSave(userId: number, playlistId: number) {
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData =
+      signatureSchemas.generators.getPlaylistSaveRequestData(
+        chainId,
+        contractAddress,
+        userId,
+        playlistId,
+        nonce
+      )
+    const sig = await this.web3Manager.signTypedData(signatureData)
+    const contractMethod = await this.getMethod(
+      'addPlaylistSave',
+      userId,
+      playlistId,
+      nonce,
+      sig
+    )
+    return await this.web3Manager.sendTransaction(
+      contractMethod,
+      this.contractRegistryKey,
+      contractAddress
+    )
+  }
+
+  async deletePlaylistSave(userId: number, playlistId: number) {
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData =
+      signatureSchemas.generators.getDeletePlaylistSaveRequestData(
+        chainId,
+        contractAddress,
+        userId,
+        playlistId,
+        nonce
+      )
+    const sig = await this.web3Manager.signTypedData(signatureData)
+    const contractMethod = await this.getMethod(
+      'deletePlaylistSave',
+      userId,
+      playlistId,
+      nonce,
+      sig
+    )
+    return await this.web3Manager.sendTransaction(
+      contractMethod,
+      this.contractRegistryKey,
+      contractAddress
+    )
+  }
+}

package/src/services/dataContracts/UserReplicaSetManagerClient.ts

@@ -0,0 +1,206 @@
+import { ContractClient } from '../contracts/ContractClient'
+import * as signatureSchemas from '../../../data-contracts/signatureSchemas'
+import type { Web3Manager } from '../web3Manager'
+
+export class UserReplicaSetManagerClient extends ContractClient {
+  override web3Manager!: Web3Manager
+  /**
+   * Update a user's replica set on the UserReplicaSetManager contract
+   * Callable by user wallet, or any node within the user's replica set
+   * @param userId
+   * @param primary
+   * @param secondaries
+   */
+  async updateReplicaSet(
+    userId: number,
+    primary: number,
+    secondaries: number[]
+  ) {
+    const existingReplicaSetInfo = await this.getUserReplicaSet(userId)
+    return await this._updateReplicaSet(
+      userId,
+      primary,
+      secondaries,
+      existingReplicaSetInfo.primaryId,
+      existingReplicaSetInfo.secondaryIds
+    )
+  }
+
+  /**
+   * Add a new content node to the L2 layer of the protocol
+   * Requires signatures from 3 existing nodes on the UserReplicaSetManager contract
+   * @param cnodeId
+   * @param cnodeOwnerWallets - [0] = incoming delegateOwnerWallet, [1] = incoming ownerWallet
+   * @param proposerSpIds
+   * @param proposerNonces
+   * @param proposer1Sig
+   * @param proposer2Sig
+   * @param proposer3Sig
+   */
+  async addOrUpdateContentNode(
+    cnodeId: number,
+    cnodeOwnerWallets: string[],
+    proposerSpIds: number[],
+    proposerNonces: string[],
+    proposer1Sig: string,
+    proposer2Sig: string,
+    proposer3Sig: string
+  ) {
+    const contractAddress = await this.getAddress()
+    const method = await this.getMethod(
+      'addOrUpdateContentNode',
+      cnodeId,
+      cnodeOwnerWallets,
+      proposerSpIds,
+      proposerNonces,
+      proposer1Sig,
+      proposer2Sig,
+      proposer3Sig
+    )
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return tx
+  }
+
+  /**
+   * Generate the relevant data required to propose a new content node
+   * Each incoming node requires 3 distinct signatures in order to be added
+   * This function will be used by content nodes
+   */
+  async getProposeAddOrUpdateContentNodeRequestData(
+    cnodeId: number,
+    cnodeDelegateWallet: string,
+    cnodeOwnerWallet: string,
+    proposerSpId: number
+  ) {
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const nonce = signatureSchemas.getNonce()
+    const signatureData =
+      signatureSchemas.generators.getProposeAddOrUpdateContentNodeRequestData(
+        chainId,
+        contractAddress,
+        cnodeId,
+        cnodeDelegateWallet,
+        cnodeOwnerWallet,
+        proposerSpId,
+        nonce
+      )
+    const sig = await this.web3Manager.signTypedData(signatureData)
+    return {
+      nonce,
+      signatureData,
+      sig
+    }
+  }
+
+  /**
+   * Returns replica set for requested user at requested blocknumber
+   * @param userId
+   * @returns replica set info with schema { primaryId: int, secondaryIds: number[] }
+   */
+  async getUserReplicaSet(userId: number) {
+    const method = await this.getMethod('getUserReplicaSet', userId)
+    const currentWallet = this.web3Manager.getWalletAddress()
+    const resp: { primaryId: string; secondaryIds: string[] } =
+      await method.call({ from: currentWallet })
+    return {
+      primaryId: parseInt(resp.primaryId),
+      secondaryIds: resp.secondaryIds.map((x) => parseInt(x))
+    }
+  }
+
+  /**
+   * Returns replica set for requested user at requested blocknumber
+   * @notice will error if web3 cannot find data for requested blocknumber
+   * @returns replica set info with schema { primaryId: int, secondaryIds: int[] }
+   */
+  async getUserReplicaSetAtBlockNumber(userId: number, blockNumber: number) {
+    const method = await this.getMethod('getUserReplicaSet', userId)
+    const currentWallet = this.web3Manager.getWalletAddress()
+    const resp: { primaryId: string; secondaryIds: string[] } =
+      await method.call({ from: currentWallet }, blockNumber)
+    return {
+      primaryId: parseInt(resp.primaryId),
+      secondaryIds: resp.secondaryIds.map((x) => parseInt(x))
+    }
+  }
+
+  /**
+   * Return the current ownerWallet and delegateOwnerWallet for a given spID
+   */
+  async getContentNodeWallets(spId: number) {
+    const method = await this.getMethod('getContentNodeWallets', spId)
+    const currentWallet = this.web3Manager.getWalletAddress()
+    return method.call({ from: currentWallet })
+  }
+
+  /**
+   * Return boolean indicating status of URSM seed operation
+   * Prior to seed, no replica sets can be written
+   */
+  async getSeedComplete() {
+    const method = await this.getMethod('getSeedComplete')
+    const currentWallet = this.web3Manager.getWalletAddress()
+    return method.call({ from: currentWallet })
+  }
+
+  /**
+   * Submit update transaction to UserReplicaSetManager to modify a user's replica set
+   * Can be sent by user's wallet, or any content node in the replica set
+   * @param userId
+   * @param primary
+   * @param secondaries
+   * @param oldPrimary
+   * @param oldSecondaries
+   */
+  async _updateReplicaSet(
+    userId: number,
+    primary: number,
+    secondaries: number[],
+    oldPrimary: number,
+    oldSecondaries: number[]
+  ) {
+    const contractAddress = await this.getAddress()
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const web3 = this.web3Manager.getWeb3()
+    const secondariesHash = web3.utils.soliditySha3(
+      web3.eth.abi.encodeParameter('uint[]', secondaries)
+    )
+    const oldSecondariesHash = web3.utils.soliditySha3(
+      web3.eth.abi.encodeParameter('uint[]', oldSecondaries)
+    )
+    const signatureData =
+      signatureSchemas.generators.getUpdateReplicaSetRequestData(
+        chainId,
+        contractAddress,
+        userId,
+        primary,
+        secondariesHash,
+        oldPrimary,
+        oldSecondariesHash,
+        nonce
+      )
+    const sig = await this.web3Manager.signTypedData(signatureData)
+    const method = await this.getMethod(
+      'updateReplicaSet',
+      userId,
+      primary,
+      secondaries,
+      oldPrimary,
+      oldSecondaries,
+      nonce,
+      sig
+    )
+    const tx = await this.web3Manager.sendTransaction(
+      method,
+      this.contractRegistryKey,
+      contractAddress
+    )
+    return tx
+  }
+}

package/src/services/dataContracts/index.ts

@@ -0,0 +1 @@
+export * from './AudiusContracts'