@audius/sdk 2.0.3-beta.6 → 2.0.3-beta.7

package/dist/services/solanaAudiusData/SolanaAudiusData.d.ts

@@ -0,0 +1,408 @@
+/// <reference types="bn.js" />
+/// <reference types="node" />
+import * as AudiusData from '@audius/anchor-audius-data';
+import type { AudiusDataProgram } from '@audius/anchor-audius-data';
+import anchor, { BN } from '@project-serum/anchor';
+import type { SolanaWeb3Manager } from '../solana';
+import type { Web3Manager } from '../web3Manager';
+import { PublicKey, Transaction } from '@solana/web3.js';
+import { Nullable } from '../../utils';
+export declare type AnchorAudiusDataConfig = {
+    programId: string;
+    adminAccount: string;
+};
+declare type SeedAddress = {
+    bumpSeed: number;
+    derivedAddress: anchor.web3.PublicKey;
+};
+declare type OmitAndRequire<T, K extends keyof T, L extends keyof T> = Partial<Omit<T, K>> & Required<Pick<T, L>>;
+/**
+ * SolanaAudiusData acts as the interface to solana audius data programs from a client.
+ * It wraps methods to create transactions.
+ */
+export declare class SolanaAudiusData {
+    anchorAudiusDataConfig: AnchorAudiusDataConfig;
+    solanaWeb3Manager: SolanaWeb3Manager;
+    program: AudiusDataProgram;
+    programId: PublicKey;
+    adminAccount: PublicKey;
+    provider: anchor.Provider;
+    web3Manager: Nullable<Web3Manager>;
+    AudiusData: any;
+    constructor(anchorAudiusDataConfig: AnchorAudiusDataConfig, solanaWeb3Manager: SolanaWeb3Manager, web3Manager: Nullable<Web3Manager>);
+    init(): Promise<void>;
+    setAdminAccount(AdminAccount: PublicKey): void;
+    /**
+     * Validate that the program, provider and base variables were initted
+     * @returns {boolean} True if the class was initted
+     */
+    didInit(): boolean;
+    /**
+     * Encodes and derives the user account, bump seed, and base authority
+     */
+    getUserIdSeed(userId: BN): Promise<{
+        userId: anchor.BN;
+        userIdSeed: Buffer & any[];
+        userAccount: anchor.web3.PublicKey;
+        bumpSeed: number;
+        baseAuthorityAccount: anchor.web3.PublicKey;
+    }>;
+    /**
+     * Derives the user solana keypair using the user's eth private key
+     */
+    getUserKeyPair(): anchor.web3.Keypair;
+    /**
+     * Encodes and derives the content node account and bump seed
+     */
+    getContentNodeSeedAddress(spId: number): Promise<SeedAddress>;
+    /**
+     * Signs a transaction using the user's key pair
+     * NOTE: The blockhash and feepayer must be set when signing and passed along
+     * with the transaction for further signatures for consitency or the signature
+     * will be invalide
+     */
+    signTransaction(tx: anchor.web3.Transaction, userKeyPair: anchor.web3.Keypair): Promise<anchor.web3.Transaction>;
+    /**
+     * Submits a transaction via the solanaWeb3Manager transactionHandler passing along
+     * the signtures.
+     * This base method is used to send all transactions in this class
+     */
+    sendTx(tx: Transaction): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    }>;
+    /**
+     * Creates an admin account
+     * @memberof SolanaWeb3Manager
+     */
+    initAdmin(params: Omit<AudiusData.InitAdminParams, 'payer' | 'program'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a user account to be claimed.
+     * NOTE: This transaction needs to be signed by the admin account
+     * @memberof SolanaWeb3Manager
+     */
+    initUser(params: OmitAndRequire<AudiusData.InitUserParams, 'program' | 'payer', 'userId' | 'metadata' | 'ethAddress' | 'bumpSeed' | 'userAccount' | 'baseAuthorityAccount' | 'cn1' | 'cn2' | 'cn3' | 'replicaSet' | 'replicaSetBumps' | 'adminAuthorityPublicKey'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Claims a user account that is created via init user using secp
+     * @memberof SolanaWeb3Manager
+     */
+    initUserSolPubkey(params: Omit<AudiusData.InitUserSolPubkeyParams, 'program' | 'ethPrivateKey' | 'message'> & {
+        userId: BN;
+    }): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a content node account
+     * NOTE: This transaction must be signed by the admin account
+     * @memberof SolanaWeb3Manager
+     */
+    createContentNode(params: OmitAndRequire<AudiusData.CreateContentNodeParams, 'program', 'spID' | 'payer' | 'adminAccount' | 'adminAuthorityPublicKey' | 'baseAuthorityAccount' | 'spID' | 'contentNodeAuthority' | 'contentNodeAccount' | 'ownerEthAddress'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Updates the user replica set in the user account
+     * NOTE: This transaction must be signed by a replica or the user's authority
+     * @memberof SolanaWeb3Manager
+     */
+    updateUserReplicaSet(params: Omit<AudiusData.UpdateUserReplicaSetParams, 'program' | 'payer'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Create or update a content node using attestations from multiple content nodes
+     * @memberof SolanaWeb3Manager
+     */
+    publicCreateOrUpdateContentNode(params: Omit<AudiusData.PublicCreateOrUpdateContentNodeParams, 'program' | 'payer'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    }>;
+    /**
+     * Deletes a content node using attestations from multiple content nodes
+     * @memberof SolanaWeb3Manager
+     */
+    publicDeleteContentNode(params: Omit<AudiusData.PublicDeleteContentNodeParams, 'program' | 'payer'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    }>;
+    /**
+     * Creates a user account
+     * NOTE: This method can only we called after the admin account is write enabled false
+     * @memberof SolanaWeb3Manager
+     */
+    createUser(params: OmitAndRequire<AudiusData.CreateUserParams, 'program' | 'payer', 'userId' | 'metadata'> & {
+        cn1SpId: number;
+        cn2SpId: number;
+        cn3SpId: number;
+    }): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Updates a user account
+     * @memberof SolanaWeb3Manager
+     */
+    updateUser(params: OmitAndRequire<AudiusData.UpdateUserParams, 'program', 'metadata'> & {
+        userId: anchor.BN;
+    }): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Updates the admin account, used for write enabled
+     * @memberof SolanaWeb3Manager
+     */
+    updateAdmin(params: Omit<AudiusData.UpdateAdminParams, 'program'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    initAuthorityDelegationStatus(params: Omit<AudiusData.InitAuthorityDelegationStatusParams, 'program' | 'payer'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    }>;
+    revokeAuthorityDelegation(params: Omit<AudiusData.RevokeAuthorityDelegationParams, 'program' | 'payer'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    }>;
+    addUserAuthorityDelegate(params: Omit<AudiusData.AddUserAuthorityDelegateParams, 'program' | 'payer'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    }>;
+    removeUserAuthorityDelegate(params: Omit<AudiusData.RemoveUserAuthorityDelegateParams, 'program' | 'payer'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    }>;
+    /**
+     * Updates a user to be verified
+     * NOTE: This tx must be signed by the admin verifier
+     * @memberof SolanaWeb3Manager
+     */
+    updateIsVerified(params: OmitAndRequire<AudiusData.UpdateIsVerifiedParams, 'program' | 'verifierPublicKey', 'userId'> & {
+        verifierKeyPair: anchor.web3.Keypair;
+    }): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a track
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    createTrack(params: OmitAndRequire<AudiusData.CreateEntityParams, 'program', 'id' | 'userId' | 'metadata'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Updates a track
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    updateTrack(params: OmitAndRequire<AudiusData.UpdateEntityParams, 'program', 'id' | 'userId' | 'metadata'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Deletes a track
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    deleteTrack(params: OmitAndRequire<AudiusData.DeleteEntityParams, 'program', 'id' | 'userId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for createPlaylist
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    createPlaylist(params: OmitAndRequire<AudiusData.CreateEntityParams, 'program', 'id' | 'userId' | 'metadata'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for updatePlaylist
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    updatePlaylist(params: OmitAndRequire<AudiusData.UpdateEntityParams, 'program', 'id' | 'userId' | 'metadata'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for deletePlaylist
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    deletePlaylist(params: OmitAndRequire<AudiusData.DeleteEntityParams, 'program', 'id' | 'userId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for addTrackRepost
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    addTrackSave(params: OmitAndRequire<AudiusData.EntitySocialActionParams, 'program', 'id' | 'userId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for deleteTrackSave
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    deleteTrackSave(params: OmitAndRequire<AudiusData.EntitySocialActionParams, 'program', 'id' | 'userId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for addTrackRepost
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    addTrackRepost(params: OmitAndRequire<AudiusData.EntitySocialActionParams, 'program', 'id' | 'userId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for deleteTrackRepost
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    deleteTrackRepost(params: OmitAndRequire<AudiusData.EntitySocialActionParams, 'program', 'id' | 'userId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for addPlaylistSave
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    addPlaylistSave(params: OmitAndRequire<AudiusData.EntitySocialActionParams, 'program', 'id' | 'userId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for deletePlaylistSave
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    deletePlaylistSave(params: OmitAndRequire<AudiusData.EntitySocialActionParams, 'program', 'id' | 'userId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for addPlaylistRepost
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    addPlaylistRepost(params: OmitAndRequire<AudiusData.EntitySocialActionParams, 'program', 'id' | 'userId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for deletePlaylistRepost
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    deletePlaylistRepost(params: OmitAndRequire<AudiusData.EntitySocialActionParams, 'program', 'id' | 'userId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for followUser
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    followUser(params: OmitAndRequire<AudiusData.UserSocialActionParams, 'program', 'sourceUserId' | 'targetUserId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for unfollowUser
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    unfollowUser(params: OmitAndRequire<AudiusData.UserSocialActionParams, 'program', 'sourceUserId' | 'targetUserId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for subscribeUser
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    subscribeUser(params: OmitAndRequire<AudiusData.UserSocialActionParams, 'program', 'sourceUserId' | 'targetUserId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+    /**
+     * Creates a solana transaction for unsubscribeUser
+     *
+     * @return {Promise<any>}
+     * @memberof SolanaWeb3Manager
+     */
+    unsubscribeUser(params: OmitAndRequire<AudiusData.UserSocialActionParams, 'program', 'sourceUserId' | 'targetUserId'>): Promise<{
+        res: string | null;
+        errorCode: string | number | null;
+        error: string | null;
+    } | undefined>;
+}
+export {};

package/dist/services/solanaAudiusData/errors.d.ts

@@ -0,0 +1,7 @@
+/**
+ * All errors returned by Anchor Audius Data
+ */
+export declare const CustomAudiusDataErrors: Map<number, string>;
+export declare const audiusDataErrorMapping: {
+    fromErrorCode: (errorCode: number) => string;
+};

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

@@ -0,0 +1,2 @@
+export * from './SolanaAudiusData';
+export * from './errors';

package/dist/utils/fileHasher.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import { ImportCandidate, UserImporterOptions } from 'ipfs-unixfs-importer';
+import { CID } from 'multiformats/cid';
 export declare type Content = ReadableStream | Buffer | string;
 export interface ImageHasher {
     options: UserImporterOptions;
@@ -35,7 +36,7 @@ export declare const fileHasher: {
      * Custom fn to generate the content-hashing logic
      * @param content a buffer of the content
      * @param options options for importer
-     * @returns the CID from content addressing logic
+     * @returns the V0 CID from content addressing logic
      */
     hashNonImages(content: Uint8Array, options?: UserImporterOptions): Promise<string>;
     /**
@@ -75,12 +76,18 @@ export declare const fileHasher: {
     */
     hashImages(content: ImportCandidate, options?: UserImporterOptions): Promise<HashedImage[]>;
     /**
-     * Generates CID for a non-image file (track segment, track transcode, metadata)
+     * Generates CID V0 (46-char string starting with "Qm") for a non-image file (track segment, track transcode, metadata)
      * @param {Buffer|ReadStream|string} content a single Buffer, a ReadStream, or path to an existing file
      * @param {Object?} logger
      * @returns {string} only hash response cid
      */
     generateNonImageCid(content: Content, logger?: any): Promise<string>;
+    /**
+     * Generates CID V1 for a JSON metadata object (NOT the string of the metadata - must be an object).
+     * CID<T, 512, SHA_256, 1> represents CID with json codec (512) and sha256 hash using CID V1.
+     * Call toString() on the result to get the CID V1 string.
+     */
+    generateMetadataCidV1(metadata: {}): Promise<CID>;
     /**
      * Wrapper that generates multihashes for image files
      * @param {Object[]} content an Object[] with the structure [{ path: string, content: buffer }, ...]

package/dist/utils/types.d.ts

@@ -38,6 +38,7 @@ export declare type UserMetadata = {
     handle_lc: string;
     is_deactivated: boolean;
     is_verified: boolean;
+    is_storage_v2: boolean;
     location: Nullable<string>;
     is_creator: boolean;
     name: string;

package/dist/utils/utils.d.ts

@@ -61,6 +61,7 @@ export declare class Utils {
         hashNonImages(content: Uint8Array, options?: import("ipfs-unixfs-importer/types/src/types").UserImporterOptions): Promise<string>;
         hashImages(content: import("ipfs-unixfs-importer/types/src/types").ImportCandidate, options?: import("ipfs-unixfs-importer/types/src/types").UserImporterOptions): Promise<HashedImage[]>;
         generateNonImageCid(content: import("./fileHasher").Content, logger?: any): Promise<string>;
+        generateMetadataCidV1(metadata: {}): Promise<import("multiformats").CID>;
         generateImageCids(content: import("ipfs-unixfs-importer/types/src/types").ImportCandidate, _?: any): Promise<HashedImage[]>;
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@audius/sdk",
-  "version": "2.0.3-beta.6",
+  "version": "2.0.3-beta.7",
   "audius": {
     "releaseSHA": "0a1b8fee5de228d48f2aab265720fbaf45bda661"
   },
@@ -90,6 +90,7 @@
     "keccak256": "1.0.2",
     "lodash": "4.17.21",
     "micro-aes-gcm": "0.3.3",
+    "multiformats": "9.9.0",
     "node-abort-controller": "3.1.1",
     "node-localstorage": "1.3.1",
     "proper-url-join": "1.2.0",

package/src/api/Account.ts

@@ -36,6 +36,7 @@ export class Account extends Base {
     this.sendTokensFromEthToSol = this.sendTokensFromEthToSol.bind(this)
     this.sendTokensFromSolToEth = this.sendTokensFromSolToEth.bind(this)
     this.userHasClaimedSolAccount = this.userHasClaimedSolAccount.bind(this)
+    this.signUpV2 = this.signUpV2.bind(this)
   }
 
   /**
@@ -151,10 +152,12 @@ export class Account extends Base {
       }
 
       // Add user to chain
+      phase = phases.ADD_USER
       const { newMetadata, blockHash, blockNumber } =
         await this.User.createEntityManagerUser({
           metadata
         })
+      phase = phases.UPLOAD_PROFILE_IMAGES
       await this.User.uploadProfileImages(
         profilePictureFile!,
         coverPhotoFile!,
@@ -170,6 +173,80 @@ export class Account extends Base {
     }
   }
 
+  /**
+   * Signs a user up for Audius
+   * @param email
+   * @param password
+   * @param metadata
+   * @param profilePictureFile an optional file to upload as the profile picture
+   * @param coverPhotoFile an optional file to upload as the cover phtoo
+   * @param hasWallet
+   * @param host The host url used for the recovery email
+   * @param generateRecoveryLink an optional flag to skip generating recovery link for testing purposes
+   */
+  async signUpV2(
+    email: string,
+    password: string,
+    metadata: UserMetadata,
+    profilePictureFile: Nullable<File> = null,
+    coverPhotoFile: Nullable<File> = null,
+    hasWallet = false,
+    host = (typeof window !== 'undefined' && window.location.origin) || null,
+    generateRecoveryLink = true
+  ) {
+    const phases = {
+      CREATE_USER_RECORD: 'CREATE_USER_RECORD',
+      HEDGEHOG_SIGNUP: 'HEDGEHOG_SIGNUP',
+      ADD_USER: 'ADD_USER',
+      UPLOAD_PROFILE_IMAGES: 'UPLOAD_PROFILE_IMAGES'
+    }
+    let phase = ''
+    try {
+      this.REQUIRES(Services.CREATOR_NODE, Services.IDENTITY_SERVICE)
+
+      if (this.web3Manager.web3IsExternal()) {
+        phase = phases.CREATE_USER_RECORD
+        await this.identityService.createUserRecord(
+          email,
+          this.web3Manager.getWalletAddress()
+        )
+      } else {
+        this.REQUIRES(Services.HEDGEHOG)
+        // If an owner wallet already exists, don't try to recreate it
+        if (!hasWallet) {
+          phase = phases.HEDGEHOG_SIGNUP
+          const ownerWallet = await this.hedgehog.signUp(email, password)
+          this.web3Manager.setOwnerWallet(ownerWallet)
+          if (generateRecoveryLink) {
+            await this.generateRecoveryLink({ handle: metadata.handle, host })
+          }
+        }
+      }
+
+      // Add user to chain
+      phase = phases.ADD_USER
+      const { newMetadata, blockHash, blockNumber } =
+        await this.User.createEntityManagerUserV2({
+          metadata
+        })
+
+      // Upload user's profile images, if any
+      phase = phases.UPLOAD_PROFILE_IMAGES
+      await this.User.uploadProfileImagesV2(
+        profilePictureFile!,
+        coverPhotoFile!,
+        newMetadata
+      )
+      return { blockHash, blockNumber, userId: newMetadata.user_id }
+    } catch (e: any) {
+      return {
+        error: e.message,
+        phase,
+        errorStatus: e.response ? e.response.status : null
+      }
+    }
+  }
+
   /**
    * Generates and sends a recovery email for a user
    */