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

package/dist/services/creatorNode/CreatorNode.d.ts

@@ -151,13 +151,7 @@ export declare class CreatorNode {
         mood: Nullable<string>;
         play_count: number;
         owner_id: number;
-        release_date: Nullable<string>; /**
-         * Pulls off the user's clock value from a creator node endpoint and the user's wallet address.
-         * @param endpoint content node endpoint
-         * @param wallet user wallet address
-         * @param timeout max time alloted for clock request
-         * @param params optional query string params
-         */
+        release_date: Nullable<string>;
         repost_count: number;
         save_count: number;
         tags: Nullable<string>;
@@ -182,6 +176,8 @@ export declare class CreatorNode {
     }>;
     uploadTrackAudioV2(file: File, onProgress: ProgressCB): Promise<any>;
     uploadTrackCoverArtV2(file: File, onProgress: ProgressCB): Promise<any>;
+    uploadProfilePictureV2(file: File, onProgress?: ProgressCB): Promise<any>;
+    uploadCoverPhotoV2(file: File, onProgress?: ProgressCB): Promise<any>;
     uploadFileV2(file: File, onProgress: ProgressCB, template: 'audio' | 'img_square' | 'img_backdrop'): Promise<any>;
     /**
      * Works for both track transcode and image resize jobs

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

@@ -0,0 +1,17 @@
+import { ContractClient } from '../contracts/ContractClient';
+import { EIP712TypedData } from 'eth-sig-util';
+declare type GeneratorFn = (chainId: number, contractAddress: string, multihashDigest: string, nonce: string) => EIP712TypedData;
+export declare class IPLDBlacklistFactoryClient extends ContractClient {
+    addIPLDToBlacklist(multihashDigest: string, privateKey?: null): Promise<any>;
+    /**
+     * 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 multihashDigest blockchain userId
+     * @param privateKey optional. if this is passed in, the signature will be from
+     * this private key. the type is a 64 character hex string
+     */
+    getUpdateNonceAndSig(generatorFn: GeneratorFn, multihashDigest: string, privateKey: string | null): Promise<unknown[]>;
+}
+export {};

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

@@ -0,0 +1,22 @@
+import { ContractClient } from '../contracts/ContractClient';
+import type { Web3Manager } from '../web3Manager';
+export declare class PlaylistFactoryClient extends ContractClient {
+    web3Manager: Web3Manager;
+    createPlaylist(userId: number, playlistName: string, isPrivate: boolean, isAlbum: boolean, trackIds: number[]): Promise<{
+        playlistId: number;
+        txReceipt: import("web3-core").TransactionReceipt;
+    }>;
+    deletePlaylist(playlistId: number): Promise<{
+        playlistId: number;
+        txReceipt: import("web3-core").TransactionReceipt;
+    }>;
+    addPlaylistTrack(playlistId: number, addedTrackId: number): Promise<import("web3-core").TransactionReceipt>;
+    deletePlaylistTrack(playlistId: number, deletedTrackId: number, deletedPlaylistTimestamp: number, retries?: number): Promise<import("web3-core").TransactionReceipt>;
+    orderPlaylistTracks(playlistId: number, trackIds: number[], retries?: number): Promise<import("web3-core").TransactionReceipt>;
+    updatePlaylistPrivacy(playlistId: number, updatedPlaylistPrivacy: boolean): Promise<import("web3-core").TransactionReceipt>;
+    updatePlaylistName(playlistId: number, updatedPlaylistName: string): Promise<import("web3-core").TransactionReceipt>;
+    updatePlaylistCoverPhoto(playlistId: number, updatedPlaylistImageMultihashDigest: string): Promise<import("web3-core").TransactionReceipt>;
+    updatePlaylistDescription(playlistId: number, updatedPlaylistDescription: string): Promise<import("web3-core").TransactionReceipt>;
+    updatePlaylistUPC(playlistId: number, updatedPlaylistUPC: string): Promise<import("web3-core").TransactionReceipt>;
+    isTrackInPlaylist(playlistId: number, trackId: number): Promise<any>;
+}

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

@@ -0,0 +1,15 @@
+import { ContractABI } from '../../utils';
+import { Web3Manager } from '../web3Manager';
+import { ProviderSelection } from '../contracts/ProviderSelection';
+import type { Contract } from 'web3-eth-contract';
+export declare class RegistryClient {
+    web3Manager: Web3Manager;
+    contractABI: ContractABI['abi'];
+    contractAddress: string;
+    Registry: Contract;
+    providerSelector: ProviderSelection | null;
+    constructor(web3Manager: Web3Manager, contractABI: ContractABI['abi'], contractAddress: string);
+    getContract(contractRegistryKey: string): Promise<string | undefined>;
+    retryInit(contractRegistryKey: string): Promise<string | undefined>;
+    selectNewEndpoint(): Promise<void>;
+}

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

@@ -0,0 +1,11 @@
+import { ContractClient } from '../contracts/ContractClient';
+import type { Web3Manager } from '../web3Manager';
+export declare class SocialFeatureFactoryClient extends ContractClient {
+    web3Manager: Web3Manager;
+    addTrackRepost(userId: number, trackId: number): Promise<import("web3-core").TransactionReceipt>;
+    deleteTrackRepost(userId: number, trackId: number): Promise<import("web3-core").TransactionReceipt>;
+    addPlaylistRepost(userId: number, playlistId: number): Promise<import("web3-core").TransactionReceipt>;
+    deletePlaylistRepost(userId: number, playlistId: number): Promise<import("web3-core").TransactionReceipt>;
+    addUserFollow(followerUserId: number, followeeUserId: number): Promise<import("web3-core").TransactionReceipt>;
+    deleteUserFollow(followerUserId: number, followeeUserId: number): Promise<import("web3-core").TransactionReceipt>;
+}

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

@@ -0,0 +1,23 @@
+import { ContractClient } from '../contracts/ContractClient';
+import type { Web3Manager } from '../web3Manager';
+export declare class TrackFactoryClient extends ContractClient {
+    web3Manager: Web3Manager;
+    getTrack(trackId: string): Promise<any>;
+    /** uint _userId, bytes32 _multihashDigest, uint8 _multihashHashFn, uint8 _multihashSize */
+    addTrack(userId: number, multihashDigest: string, multihashHashFn: number, multihashSize: number): Promise<{
+        trackId: number;
+        txReceipt: import("web3-core").TransactionReceipt;
+    }>;
+    /** uint _trackId, uint _trackOwnerId, bytes32 _multihashDigest, uint8 _multihashHashFn, uint8 _multihashSize */
+    updateTrack(trackId: number, trackOwnerId: number, multihashDigest: string, multihashHashFn: number, multihashSize: number): Promise<{
+        trackId: number;
+        txReceipt: import("web3-core").TransactionReceipt;
+    }>;
+    /**
+     * @return deleted trackId from on-chain event log
+     */
+    deleteTrack(trackId: number): Promise<{
+        trackId: number;
+        txReceipt: import("web3-core").TransactionReceipt;
+    }>;
+}

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

@@ -0,0 +1,64 @@
+import { ContractClient } from '../contracts/ContractClient';
+import { Nullable } from '../../utils';
+import { EIP712TypedData } from 'eth-sig-util';
+import type { Web3Manager } from '../web3Manager';
+declare type GeneratorFn = (chainId: number, contractAddress: string, userId: number, newValue: unknown, nonce: string) => EIP712TypedData;
+export declare class UserFactoryClient extends ContractClient {
+    web3Manager: Web3Manager;
+    getUser(userId: number): Promise<any>;
+    /** valid = does not exist and meets handle requirements (defined on chain) */
+    handleIsValid(handle: string): Promise<any>;
+    addUser(handle: string): Promise<{
+        txReceipt: import("web3-core").TransactionReceipt;
+        userId: number;
+    }>;
+    updateMultihash(userId: number, multihashDigest: string): Promise<{
+        txReceipt: import("web3-core").TransactionReceipt;
+        multihashDigest: any;
+    }>;
+    updateName(userId: number, name: string): Promise<{
+        txReceipt: import("web3-core").TransactionReceipt;
+        name: string;
+    }>;
+    updateLocation(userId: number, location: string): Promise<{
+        txReceipt: import("web3-core").TransactionReceipt;
+        location: string;
+    }>;
+    updateBio(userId: number, bio: Nullable<string>): Promise<{
+        txReceipt: import("web3-core").TransactionReceipt;
+        bio: any;
+    }>;
+    updateProfilePhoto(userId: number, profilePhotoMultihashDigest: string): Promise<{
+        txReceipt: import("web3-core").TransactionReceipt;
+        profilePhotoMultihashDigest: any;
+    }>;
+    updateCoverPhoto(userId: number, coverPhotoMultihashDigest: string): Promise<{
+        txReceipt: import("web3-core").TransactionReceipt;
+        coverPhotoMultihashDigest: any;
+    }>;
+    /**
+     * 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
+     */
+    updateIsVerified(userId: number, isVerified: boolean, privateKey: string): Promise<any[]>;
+    updateCreatorNodeEndpoint(userId: number, creatorNodeEndpoint: string): Promise<{
+        txReceipt: import("web3-core").TransactionReceipt;
+        creatorNodeEndpoint: any;
+    }>;
+    /**
+     * 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
+     */
+    getUpdateNonceAndSig(generatorFn: GeneratorFn, userId: number, newValue: unknown, privateKey?: string): Promise<unknown[]>;
+}
+export {};

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

@@ -0,0 +1,9 @@
+import { ContractClient } from '../contracts/ContractClient';
+import type { Web3Manager } from '../web3Manager';
+export declare class UserLibraryFactoryClient extends ContractClient {
+    web3Manager: Web3Manager;
+    addTrackSave(userId: number, trackId: number): Promise<import("web3-core").TransactionReceipt>;
+    deleteTrackSave(userId: number, trackId: number): Promise<import("web3-core").TransactionReceipt>;
+    addPlaylistSave(userId: number, playlistId: number): Promise<import("web3-core").TransactionReceipt>;
+    deletePlaylistSave(userId: number, playlistId: number): Promise<import("web3-core").TransactionReceipt>;
+}

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

@@ -0,0 +1,82 @@
+import { ContractClient } from '../contracts/ContractClient';
+import type { Web3Manager } from '../web3Manager';
+export declare class UserReplicaSetManagerClient extends ContractClient {
+    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
+     */
+    updateReplicaSet(userId: number, primary: number, secondaries: number[]): Promise<import("web3-core").TransactionReceipt>;
+    /**
+     * 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
+     */
+    addOrUpdateContentNode(cnodeId: number, cnodeOwnerWallets: string[], proposerSpIds: number[], proposerNonces: string[], proposer1Sig: string, proposer2Sig: string, proposer3Sig: string): Promise<import("web3-core").TransactionReceipt>;
+    /**
+     * 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
+     */
+    getProposeAddOrUpdateContentNodeRequestData(cnodeId: number, cnodeDelegateWallet: string, cnodeOwnerWallet: string, proposerSpId: number): Promise<{
+        nonce: string;
+        signatureData: {
+            types: {
+                EIP712Domain: {
+                    name: string;
+                    type: string;
+                }[];
+            };
+            domain: any;
+            primaryType: any;
+            message: any;
+        };
+        sig: unknown;
+    }>;
+    /**
+     * Returns replica set for requested user at requested blocknumber
+     * @param userId
+     * @returns replica set info with schema { primaryId: int, secondaryIds: number[] }
+     */
+    getUserReplicaSet(userId: number): Promise<{
+        primaryId: number;
+        secondaryIds: number[];
+    }>;
+    /**
+     * 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[] }
+     */
+    getUserReplicaSetAtBlockNumber(userId: number, blockNumber: number): Promise<{
+        primaryId: number;
+        secondaryIds: number[];
+    }>;
+    /**
+     * Return the current ownerWallet and delegateOwnerWallet for a given spID
+     */
+    getContentNodeWallets(spId: number): Promise<any>;
+    /**
+     * Return boolean indicating status of URSM seed operation
+     * Prior to seed, no replica sets can be written
+     */
+    getSeedComplete(): Promise<any>;
+    /**
+     * 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
+     */
+    _updateReplicaSet(userId: number, primary: number, secondaries: number[], oldPrimary: number, oldSecondaries: number[]): Promise<import("web3-core").TransactionReceipt>;
+}

package/dist/services/discoveryProvider/DiscoveryProvider.d.ts

@@ -118,7 +118,7 @@ export declare class DiscoveryProvider {
      * await getUsers()
      * await getUsers(100, 0, [3,2,6]) - Invalid user ids will not be accepted
      */
-    getUsers(limit: number | undefined, offset: number | undefined, idsArray: Nullable<number[]>, walletAddress?: Nullable<string>, handle?: Nullable<string>, minBlockNumber?: Nullable<number>): Promise<Nullable<import("../../utils").UserMetadata[]> | undefined>;
+    getUsers(limit: number | undefined, offset: number | undefined, idsArray: Nullable<number[]>, walletAddress?: Nullable<string>, handle?: Nullable<string>, minBlockNumber?: Nullable<number>, includeIncomplete?: Nullable<boolean>): Promise<Nullable<import("../../utils").UserMetadata[]> | undefined>;
     /**
      * get tracks with all relevant track data
      * can be filtered by providing an integer array of ids

package/dist/services/discoveryProvider/requests.d.ts

@@ -1,6 +1,6 @@
 import type { Nullable } from '../../utils';
 import type { ResponseType } from 'axios';
-export declare const getUsers: (limit: number | undefined, offset: number | undefined, idsArray: Nullable<number[]>, walletAddress?: Nullable<string> | undefined, handle?: Nullable<string> | undefined, minBlockNumber?: Nullable<number> | undefined) => {
+export declare const getUsers: (limit: number | undefined, offset: number | undefined, idsArray: Nullable<number[]>, walletAddress?: Nullable<string> | undefined, handle?: Nullable<string> | undefined, minBlockNumber?: Nullable<number> | undefined, includeIncomplete?: Nullable<boolean> | undefined) => {
     endpoint: string;
     queryParams: {
         limit: number;
@@ -9,6 +9,7 @@ export declare const getUsers: (limit: number | undefined, offset: number | unde
         wallet?: string | undefined;
         min_block_number?: number | undefined;
         id?: string[] | undefined;
+        include_incomplete?: boolean | undefined;
     };
 };
 export declare const getTracks: (limit: number | undefined, offset: number | undefined, idsArray: Nullable<string[]>, targetUserId: Nullable<string>, sort: Nullable<boolean>, minBlockNumber: Nullable<number>, filterDeleted: Nullable<boolean>, withUsers?: boolean) => {