@audius/sdk 1.0.10 → 1.0.12

package/dist/services/dataContracts/EntityManagerClient.d.ts

@@ -4,7 +4,8 @@ import type { Web3Manager } from '../web3Manager';
 export declare enum Action {
     CREATE = "Create",
     UPDATE = "Update",
-    DELETE = "Delete"
+    DELETE = "Delete",
+    VERIFY = "Verify"
 }
 export declare enum EntityType {
     PLAYLIST = "Playlist",
@@ -19,7 +20,17 @@ export declare class EntityManagerClient extends ContractClient {
     web3Manager: Web3Manager;
     static Action: typeof Action;
     static EntityType: typeof EntityType;
-    manageEntity(userId: number, entityType: EntityType, entityId: number, action: Action, metadataMultihash: string): Promise<{
+    getManageEntityParams(userId: number, entityType: EntityType, entityId: number, action: Action, metadataMultihash: string, privateKey?: string): Promise<[string, string]>;
+    /**
+     * Calls the manage entity method on chain
+     * @param {number} userId The numeric user id
+     * @param {EntityType} entityType The type of entity being modified
+     * @param {number} entityId The id of the entity
+     * @param {Action} action Action being performed on the entity
+     * @param {string} metadataMultihash CID multihash or metadata associated with action
+     * @param {string}privateKey The private key used to sign the transaction
+     */
+    manageEntity(userId: number, entityType: EntityType, entityId: number, action: Action, metadataMultihash: string, privateKey?: string): Promise<{
         txReceipt: TransactionReceipt;
     }>;
 }

package/dist/services/wormhole/ProxyWormhole.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="bn.js" />
+/// <reference types="node" />
+import type { Hedgehog } from '@audius/hedgehog';
+import type { EthContracts } from '../ethContracts';
+import type { EthWeb3Manager } from '../ethWeb3Manager';
+import type { IdentityService } from '../identity';
+import type { SolanaWeb3Manager } from '../solana';
+import { BN } from 'ethereumjs-util';
+import { Nullable } from '../../utils';
+export declare type ProxyWormholeConfig = {};
+/** Singleton state-manager for audius proxy wormhole interaction */
+export declare class ProxyWormhole {
+    hedgehog: Nullable<Hedgehog>;
+    ethWeb3Manager: EthWeb3Manager;
+    ethContracts: EthContracts;
+    identityService: Nullable<IdentityService>;
+    solanaWeb3Manager: SolanaWeb3Manager;
+    constructor(hedgehog: Hedgehog | null, ethWeb3Manager: EthWeb3Manager, ethContracts: EthContracts, identityService: IdentityService | null, solanaWeb3Manager: SolanaWeb3Manager);
+    /**
+     * Locks assets owned by `fromAccount` into the Solana wormhole with a target
+     * solanaAccount destination via the provided relayer wallet.
+     */
+    _getTransferTokensToEthWormholeParams(fromAccount: string, amount: BN, solanaAccount: string): Promise<{
+        chainId: number;
+        deadline: number;
+        recipient: Buffer;
+        arbiterFee: BN;
+        signedDigest: import("ethereumjs-util").ECDSASignature;
+    }>;
+    getTransferTokensToEthWormholeMethod(fromAccount: string, amount: BN, solanaAccount: string): Promise<any>;
+}

package/dist/services/wormhole/Wormhole.d.ts

@@ -17,7 +17,7 @@ export declare type WormholeConfig = {
     ethBridgeAddress: string;
     ethTokenBridgeAddress: string;
 };
-/** Singleton state-manager for Audius Eth Contracts */
+/** Singleton state-manager for audius wormhole interaction */
 export declare class Wormhole {
     hedgehog: Nullable<Hedgehog>;
     ethWeb3Manager: EthWeb3Manager;

package/dist/services/wormhole/index.d.ts

@@ -1 +1,2 @@
 export * from './Wormhole';
+export * from './ProxyWormhole';

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@audius/sdk",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "audius": {
-    "releaseSHA": "c3900f7771f89843401adefd86683fad8657e8f4"
+    "releaseSHA": "78388a5771c4a3dca52d6805824b8710b17bb280"
   },
   "description": "",
   "main": "dist/index.cjs.js",

package/src/NativeAudiusLibs.ts

@@ -38,6 +38,10 @@ import { ServiceProvider } from './api/ServiceProvider'
 import type { BaseConstructorArgs } from './api/base'
 import type { MonitoringCallbacks } from './services/types'
 import { EntityManager } from './api/entityManager'
+import {
+  ProxyWormhole,
+  ProxyWormholeConfig
+} from './services/wormhole/ProxyWormhole'
 
 type LibsIdentityServiceConfig = {
   url: string
@@ -71,6 +75,7 @@ type AudiusLibsConfig = {
   discoveryProviderConfig: LibsDiscoveryProviderConfig
   creatorNodeConfig: CreatorNodeConfig
   comstockConfig: LibsComstockConfig
+  wormholeConfig: ProxyWormholeConfig
   captchaConfig: CaptchaConfig
   hedgehogConfig: LibsHedgehogConfig
   isServer: boolean
@@ -224,8 +229,7 @@ export class AudiusLibs {
   }
 
   /**
-   * Configures wormhole
-   * This is a stubbed version for native
+   * Configures proxy-only wormhole
    */
   static configWormhole() {
     return {}
@@ -297,6 +301,7 @@ export class AudiusLibs {
   creatorNodeConfig: CreatorNodeConfig
   discoveryProviderConfig: LibsDiscoveryProviderConfig
   comstockConfig: LibsComstockConfig
+  wormholeConfig: ProxyWormholeConfig
   captchaConfig: CaptchaConfig
   hedgehogConfig: LibsHedgehogConfig
   isServer: boolean
@@ -313,6 +318,7 @@ export class AudiusLibs {
   web3Manager: Nullable<Web3Manager>
   solanaWeb3Manager: Nullable<SolanaWeb3Manager>
   contracts: Nullable<AudiusContracts>
+  wormholeClient: Nullable<ProxyWormhole>
   creatorNode: Nullable<CreatorNode>
   captcha: Nullable<Captcha>
   schemas?: Schemas
@@ -351,6 +357,7 @@ export class AudiusLibs {
     discoveryProviderConfig,
     creatorNodeConfig,
     comstockConfig,
+    wormholeConfig,
     captchaConfig,
     hedgehogConfig,
     isServer,
@@ -371,6 +378,7 @@ export class AudiusLibs {
     this.creatorNodeConfig = creatorNodeConfig
     this.discoveryProviderConfig = discoveryProviderConfig
     this.comstockConfig = comstockConfig
+    this.wormholeConfig = wormholeConfig
     this.captchaConfig = captchaConfig
     this.hedgehogConfig = hedgehogConfig
     this.isServer = isServer
@@ -386,12 +394,13 @@ export class AudiusLibs {
     this.ethContracts = null
     this.web3Manager = null
     this.solanaWeb3Manager = null
+    this.wormholeClient = null
     this.contracts = null
     this.creatorNode = null
     this.captcha = null
     this.comstock = null
 
-    // // API
+    // API
     this.ServiceProvider = null
     this.Account = null
     this.User = null
@@ -506,6 +515,20 @@ export class AudiusLibs {
       contractsToInit.push(this.contracts.init())
     }
     await Promise.all(contractsToInit)
+    if (
+      this.wormholeConfig &&
+      this.ethWeb3Manager &&
+      this.ethContracts &&
+      this.solanaWeb3Manager
+    ) {
+      this.wormholeClient = new ProxyWormhole(
+        this.hedgehog,
+        this.ethWeb3Manager,
+        this.ethContracts,
+        this.identityService,
+        this.solanaWeb3Manager
+      )
+    }
 
     /** Discovery Provider */
     if (this.discoveryProviderConfig) {
@@ -559,7 +582,7 @@ export class AudiusLibs {
       this.ethContracts,
       this.solanaWeb3Manager,
       null as any,
-      null as any,
+      this.wormholeClient,
       this.creatorNode,
       this.comstock,
       this.captcha,

package/src/api/Users.ts

@@ -724,13 +724,25 @@ export class Users extends Base {
   async updateIsVerified(
     userId: number,
     isVerified: boolean,
-    privateKey: string
+    privateKey: string,
+    useEntityManager?: boolean
   ) {
-    return await this.contracts.UserFactoryClient.updateIsVerified(
-      userId,
-      isVerified,
-      privateKey
-    )
+    if (useEntityManager) {
+      return await this.contracts.EntityManagerClient!.getManageEntityParams(
+        userId,
+        EntityManagerClient.EntityType.USER,
+        userId,
+        EntityManagerClient.Action.VERIFY,
+        '',
+        privateKey
+      )
+    } else {
+      return await this.contracts.UserFactoryClient.updateIsVerified(
+        userId,
+        isVerified,
+        privateKey
+      )
+    }
   }
 
   /**

package/src/services/dataContracts/AudiusContracts.ts

@@ -207,7 +207,10 @@ export class AudiusContracts {
    */
   async getRegistryAddressForContract(contractName: string) {
     // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer#Computed_property_names
-    this.contracts = this.contracts ?? { [this.registryAddress]: 'registry' }
+    this.contracts = this.contracts ?? {
+      [this.registryAddress]: 'registry',
+      [this.entityManagerAddress]: 'EntityManager'
+    }
     this.contractAddresses = this.contractAddresses ?? {
       registry: this.registryAddress
     }

package/src/services/dataContracts/EntityManagerClient.ts

@@ -1,4 +1,6 @@
 import type { TransactionReceipt } from 'web3-core'
+import sigUtil from 'eth-sig-util'
+import { Buffer as SafeBuffer } from 'safe-buffer'
 
 import { ContractClient } from '../contracts/ContractClient'
 import * as signatureSchemas from '../../data-contracts/signatureSchemas'
@@ -7,7 +9,8 @@ import type { Web3Manager } from '../web3Manager'
 export enum Action {
   CREATE = 'Create',
   UPDATE = 'Update',
-  DELETE = 'Delete'
+  DELETE = 'Delete',
+  VERIFY = 'Verify'
 }
 
 export enum EntityType {
@@ -26,12 +29,67 @@ export class EntityManagerClient extends ContractClient {
   static Action = Action
   static EntityType = EntityType
 
+  async getManageEntityParams(
+    userId: number,
+    entityType: EntityType,
+    entityId: number,
+    action: Action,
+    metadataMultihash: string,
+    privateKey?: string
+  ): Promise<[string, string]> {
+    const nonce = signatureSchemas.getNonce()
+    const chainId = await this.getEthNetId()
+    const contractAddress = await this.getAddress()
+    const signatureData = signatureSchemas.generators.getManageEntityData(
+      chainId,
+      contractAddress,
+      userId,
+      entityType,
+      entityId,
+      action,
+      metadataMultihash,
+      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)
+    }
+    const method = await this.getMethod(
+      'manageEntity',
+      userId,
+      entityType,
+      entityId,
+      action,
+      metadataMultihash,
+      nonce,
+      sig
+    )
+    return [method.encodeABI(), contractAddress]
+  }
+
+  /**
+   * Calls the manage entity method on chain
+   * @param {number} userId The numeric user id
+   * @param {EntityType} entityType The type of entity being modified
+   * @param {number} entityId The id of the entity
+   * @param {Action} action Action being performed on the entity
+   * @param {string} metadataMultihash CID multihash or metadata associated with action
+   * @param {string}privateKey The private key used to sign the transaction
+   */
   async manageEntity(
     userId: number,
     entityType: EntityType,
     entityId: number,
     action: Action,
-    metadataMultihash: string
+    metadataMultihash: string,
+    privateKey?: string
   ): Promise<{ txReceipt: TransactionReceipt }> {
     const nonce = signatureSchemas.getNonce()
     const chainId = await this.getEthNetId()
@@ -46,7 +104,17 @@ export class EntityManagerClient extends ContractClient {
       metadataMultihash,
       nonce
     )
-    const sig = await this.web3Manager.signTypedData(signatureData)
+    let sig
+    if (privateKey) {
+      sig = sigUtil.signTypedData(
+        SafeBuffer.from(privateKey, 'hex') as unknown as Buffer,
+        {
+          data: signatureData
+        }
+      )
+    } else {
+      sig = await this.web3Manager.signTypedData(signatureData)
+    }
     const method = await this.getMethod(
       'manageEntity',
       userId,

package/src/services/wormhole/ProxyWormhole.ts

@@ -0,0 +1,118 @@
+import type { Hedgehog } from '@audius/hedgehog'
+import type { EthContracts } from '../ethContracts'
+import type { EthWeb3Manager } from '../ethWeb3Manager'
+import type { IdentityService } from '../identity'
+import type { SolanaWeb3Manager } from '../solana'
+
+import bs58 from 'bs58'
+import { BN, toBuffer } from 'ethereumjs-util'
+
+import { Utils, sign, getTransferTokensDigest, Nullable } from '../../utils'
+
+export type ProxyWormholeConfig = {}
+
+/** Singleton state-manager for audius proxy wormhole interaction */
+export class ProxyWormhole {
+  hedgehog: Nullable<Hedgehog>
+  ethWeb3Manager: EthWeb3Manager
+  ethContracts: EthContracts
+  identityService: Nullable<IdentityService>
+  solanaWeb3Manager: SolanaWeb3Manager
+
+  constructor(
+    hedgehog: Hedgehog | null,
+    ethWeb3Manager: EthWeb3Manager,
+    ethContracts: EthContracts,
+    identityService: IdentityService | null,
+    solanaWeb3Manager: SolanaWeb3Manager
+  ) {
+    // Wormhole service dependecies
+    this.hedgehog = hedgehog
+    this.ethWeb3Manager = ethWeb3Manager
+    this.ethContracts = ethContracts
+    this.identityService = identityService
+    this.solanaWeb3Manager = solanaWeb3Manager
+  }
+
+  /**
+   * Locks assets owned by `fromAccount` into the Solana wormhole with a target
+   * solanaAccount destination via the provided relayer wallet.
+   */
+  async _getTransferTokensToEthWormholeParams(
+    fromAccount: string,
+    amount: BN,
+    solanaAccount: string
+  ) {
+    if (!this.hedgehog) {
+      throw new Error(
+        'Hedgehog required for _getTransferTokensToEthWormholeParams'
+      )
+    }
+    const web3 = this.ethWeb3Manager.getWeb3()
+    const wormholeClientAddress =
+      this.ethContracts.WormholeClient.contractAddress
+
+    const chainId = await web3.eth.getChainId()
+
+    const currentBlockNumber = await web3.eth.getBlockNumber()
+    const currentBlock = await web3.eth.getBlock(currentBlockNumber)
+
+    // 1 hour, sufficiently far in future
+    const deadline = (currentBlock.timestamp as unknown as number) + 60 * 60 * 1
+    const solanaB58 = bs58.decode(solanaAccount).toString('hex')
+    const recipient = toBuffer(`0x${solanaB58}`)
+    const nonce = await this.ethContracts.WormholeClient.nonces(fromAccount)
+    const arbiterFee = Utils.toBN('0')
+
+    const digest = getTransferTokensDigest(
+      web3,
+      'AudiusWormholeClient',
+      wormholeClientAddress,
+      chainId,
+      {
+        from: fromAccount,
+        amount,
+        recipientChain: chainId,
+        recipient,
+        arbiterFee
+      },
+      nonce,
+      deadline
+    )
+    const privateKey = this.hedgehog.getWallet()?.getPrivateKey()
+    const signedDigest = sign(digest, privateKey!)
+    return {
+      chainId,
+      deadline,
+      recipient,
+      arbiterFee,
+      signedDigest
+    }
+  }
+
+  async getTransferTokensToEthWormholeMethod(
+    fromAccount: string,
+    amount: BN,
+    solanaAccount: string
+  ) {
+    const { chainId, deadline, recipient, arbiterFee, signedDigest } =
+      await this._getTransferTokensToEthWormholeParams(
+        fromAccount,
+        amount,
+        solanaAccount
+      )
+    const method =
+      await this.ethContracts.WormholeClient.WormholeContract.methods.transferTokens(
+        fromAccount,
+        amount,
+        chainId,
+        recipient,
+        arbiterFee,
+        deadline,
+        signedDigest.v,
+        signedDigest.r,
+        signedDigest.s
+      )
+    return method
+  }
+}

package/src/services/wormhole/Wormhole.ts

@@ -28,7 +28,7 @@ export type WormholeConfig = {
   ethTokenBridgeAddress: string
 }
 
-/** Singleton state-manager for Audius Eth Contracts */
+/** Singleton state-manager for audius wormhole interaction */
 export class Wormhole {
   hedgehog: Nullable<Hedgehog>
   ethWeb3Manager: EthWeb3Manager

package/src/services/wormhole/index.ts

@@ -1 +1,2 @@
 export * from './Wormhole'
+export * from './ProxyWormhole'