@audius/sdk 15.0.1 → 15.3.0

package/dist/sdk/services/AntiAbuseOracleSelector/AntiAbuseOracleSelector.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/sdk/services/AntiAbuseOracleSelector/getDefaultConfig.d.ts

@@ -1,3 +0,0 @@
-import type { SdkServicesConfig } from '../../config/types';
-import type { AntiAbuseOracleSelectorConfigInternal } from './types';
-export declare const getDefaultAntiAbuseOracleSelectorConfig: (config: SdkServicesConfig) => AntiAbuseOracleSelectorConfigInternal;

package/dist/sdk/services/AntiAbuseOracleSelector/index.d.ts

@@ -1,3 +0,0 @@
-export { AntiAbuseOracleSelector } from './AntiAbuseOracleSelector';
-export * from './types';
-export { getDefaultAntiAbuseOracleSelectorConfig } from './getDefaultConfig';

package/dist/sdk/services/AntiAbuseOracleSelector/types.d.ts

@@ -1,37 +0,0 @@
-import { Middleware } from '../../api/generated/default';
-import type { LoggerService } from '../Logger';
-export type AntiAbuseOracleNode = {
-    /** The wallet address of the Anti Abuse Oracle. */
-    wallet: string;
-    /** The URL of the Anti Abuse Oracle. */
-    endpoint: string;
-};
-/**
- * Service used to choose an Anti Abuse Oracle service.
- */
-export type AntiAbuseOracleSelectorService = {
-    /**
-     * Returns a middleware that prepends the Anti Abuse Oracle endpoint to each
-     * request and can reselect on certain responses or errors.
-     */
-    createMiddleware: () => Middleware;
-    /**
-     * Gets a registered, healthy Anti Abuse Oracle endpoint and wallet.
-     */
-    getSelectedService(): Promise<AntiAbuseOracleNode>;
-};
-/**
- * Note that for Anti Abuse Oracle, the wallet is the only information stored
- * on-chain. The URL endpoint is off-chain information. Thus, this configuration
- * must be complete as opposed to the "bootstrap" nodes of Discovery or Storage,
- * which are only used in initial selection.
- */
-export type AntiAbuseOracleSelectorConfigInternal = {
-    /** All possible endpoints for Anti Abuse Oracles. */
-    endpoints: string[];
-    /** All registered wallet addresses of Anti Abuse Oracles. */
-    registeredAddresses: string[];
-    /** The logging service. */
-    logger: LoggerService;
-};
-export type AntiAbuseOracleSelectorConfig = Partial<AntiAbuseOracleSelectorConfigInternal>;

package/dist/sdk/services/Archiver/Archiver.d.ts

@@ -1,21 +0,0 @@
-import { BaseAPI } from '../../api/generated/default';
-type GetStemsArchiveJobStatusResponse = {
-    id: string;
-    state: 'completed' | 'failed' | 'active' | 'waiting' | 'delayed' | 'prioritized';
-    progress?: number;
-    failedReason?: string;
-};
-export declare class ArchiverService extends BaseAPI {
-    createStemsArchive({ trackId, userId, includeParent }: {
-        trackId: string;
-        userId: string;
-        includeParent?: boolean;
-    }): Promise<GetStemsArchiveJobStatusResponse>;
-    getStemsArchiveJobStatus({ jobId }: {
-        jobId: string;
-    }): Promise<GetStemsArchiveJobStatusResponse>;
-    cancelStemsArchiveJob({ jobId }: {
-        jobId: string;
-    }): Promise<void>;
-}
-export {};

package/dist/sdk/services/Archiver/index.d.ts

@@ -1 +0,0 @@
-export { ArchiverService } from './Archiver';

package/dist/sdk/services/AudiusWalletClient/actions/getSharedSecret.d.ts

@@ -1,7 +0,0 @@
-import type { Chain, Client, Transport } from 'viem';
-import type { AudiusAccount } from '../types';
-export type GetSharedSecretParameters<TAccount extends AudiusAccount | undefined = AudiusAccount | undefined> = {
-    account?: TAccount;
-    publicKey: string | Uint8Array;
-};
-export declare function getSharedSecret<TChain extends Chain | undefined, TAccount extends AudiusAccount | undefined>(client: Client<Transport, TChain, TAccount>, { account: account_, publicKey }: GetSharedSecretParameters<TAccount>): Promise<Uint8Array>;

package/dist/sdk/services/AudiusWalletClient/actions/sign.d.ts

@@ -1,7 +0,0 @@
-import type { Chain, Client, SignableMessage, Transport } from 'viem';
-import type { AudiusAccount } from '../types';
-export type SignParameters<TAccount extends AudiusAccount | undefined = AudiusAccount | undefined> = {
-    account?: TAccount;
-    message: SignableMessage;
-};
-export declare function sign<TChain extends Chain | undefined, TAccount extends AudiusAccount | undefined>(client: Client<Transport, TChain, TAccount>, { account: account_, message: message_ }: SignParameters): Promise<[Uint8Array, number]>;

package/dist/sdk/services/AudiusWalletClient/createAppWalletClient.d.ts

@@ -1,5 +0,0 @@
-import type { AudiusWalletClient } from './types';
-export declare const createAppWalletClient: ({ apiKey, apiSecret }: {
-    apiKey: string;
-    apiSecret?: string | undefined;
-}) => AudiusWalletClient;

package/dist/sdk/services/AudiusWalletClient/createHedgehogWalletClient.d.ts

@@ -1,9 +0,0 @@
-import type { Hedgehog } from '@audius/hedgehog';
-import type { AudiusWalletClient } from './types';
-export declare class HedgehogWalletNotFoundError extends Error {
-    constructor();
-}
-/**
- * Creates a Viem client that uses a local Hedgehog instance to do all the wallet methods.
- */
-export declare function createHedgehogWalletClient(hedgehog: Hedgehog): AudiusWalletClient;

package/dist/sdk/services/AudiusWalletClient/decorators/audiusWallet.d.ts

@@ -1,184 +0,0 @@
-import type { Chain, Client, Transport, WalletActions } from 'viem';
-import { GetSharedSecretParameters } from '../actions/getSharedSecret';
-import { type SignParameters } from '../actions/sign';
-import type { AudiusAccount } from '../types';
-export type AudiusWalletActions<TChain extends Chain | undefined = Chain | undefined, TAccount extends AudiusAccount | undefined = AudiusAccount | undefined> = {
-    /**
-     * Returns a list of account addresses owned by the wallet or client.
-     *
-     * - Docs: https://viem.sh/docs/actions/wallet/getAddresses
-     * - JSON-RPC Methods: [`eth_accounts`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_accounts)
-     *
-     * @returns List of account addresses owned by the wallet or client. {@link GetAddressesReturnType}
-     *
-     * @example
-     * import { createWalletClient, custom } from 'viem'
-     * import { mainnet } from 'viem/chains'
-     *
-     * const client = createWalletClient({
-     *   chain: mainnet,
-     *   transport: custom(window.ethereum),
-     * })
-     * const accounts = await client.getAddresses()
-     */
-    getAddresses: WalletActions<TChain, TAccount>['getAddresses'];
-    /**
-     * Calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191): `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`.
-     *
-     * - Docs: https://viem.sh/docs/actions/wallet/signMessage
-     * - JSON-RPC Methods:
-     *   - JSON-RPC Accounts: [`personal_sign`](https://docs.metamask.io/guide/signing-data#personal-sign)
-     *   - Local Accounts: Signs locally. No JSON-RPC request.
-     *
-     * With the calculated signature, you can:
-     * - use [`verifyMessage`](https://viem.sh/docs/utilities/verifyMessage) to verify the signature,
-     * - use [`recoverMessageAddress`](https://viem.sh/docs/utilities/recoverMessageAddress) to recover the signing address from a signature.
-     *
-     * @param args - {@link SignMessageParameters}
-     * @returns The signed message. {@link SignMessageReturnType}
-     *
-     * @example
-     * import { createWalletClient, custom } from 'viem'
-     * import { mainnet } from 'viem/chains'
-     *
-     * const client = createWalletClient({
-     *   chain: mainnet,
-     *   transport: custom(window.ethereum),
-     * })
-     * const signature = await client.signMessage({
-     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
-     *   message: 'hello world',
-     * })
-     *
-     * @example
-     * // Account Hoisting
-     * import { createWalletClient, http } from 'viem'
-     * import { privateKeyToAccount } from 'viem/accounts'
-     * import { mainnet } from 'viem/chains'
-     *
-     * const client = createWalletClient({
-     *   account: privateKeyToAccount('0x…'),
-     *   chain: mainnet,
-     *   transport: http(),
-     * })
-     * const signature = await client.signMessage({
-     *   message: 'hello world',
-     * })
-     */
-    signMessage: WalletActions<TChain, TAccount>['signMessage'];
-    /**
-     * Signs typed data and calculates an Ethereum-specific signature in [EIP-191 format](https://eips.ethereum.org/EIPS/eip-191): `keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))`.
-     *
-     * - Docs: https://viem.sh/docs/actions/wallet/signTypedData
-     * - JSON-RPC Methods:
-     *   - JSON-RPC Accounts: [`eth_signTypedData_v4`](https://docs.metamask.io/guide/signing-data#signtypeddata-v4)
-     *   - Local Accounts: Signs locally. No JSON-RPC request.
-     *
-     * @param client - Client to use
-     * @param args - {@link SignTypedDataParameters}
-     * @returns The signed data. {@link SignTypedDataReturnType}
-     *
-     * @example
-     * import { createWalletClient, custom } from 'viem'
-     * import { mainnet } from 'viem/chains'
-     *
-     * const client = createWalletClient({
-     *   chain: mainnet,
-     *   transport: custom(window.ethereum),
-     * })
-     * const signature = await client.signTypedData({
-     *   account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
-     *   domain: {
-     *     name: 'Ether Mail',
-     *     version: '1',
-     *     chainId: 1,
-     *     verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
-     *   },
-     *   types: {
-     *     Person: [
-     *       { name: 'name', type: 'string' },
-     *       { name: 'wallet', type: 'address' },
-     *     ],
-     *     Mail: [
-     *       { name: 'from', type: 'Person' },
-     *       { name: 'to', type: 'Person' },
-     *       { name: 'contents', type: 'string' },
-     *     ],
-     *   },
-     *   primaryType: 'Mail',
-     *   message: {
-     *     from: {
-     *       name: 'Cow',
-     *       wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
-     *     },
-     *     to: {
-     *       name: 'Bob',
-     *       wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
-     *     },
-     *     contents: 'Hello, Bob!',
-     *   },
-     * })
-     *
-     * @example
-     * // Account Hoisting
-     * import { createWalletClient, http } from 'viem'
-     * import { privateKeyToAccount } from 'viem/accounts'
-     * import { mainnet } from 'viem/chains'
-     *
-     * const client = createWalletClient({
-     *   account: privateKeyToAccount('0x…'),
-     *   chain: mainnet,
-     *   transport: http(),
-     * })
-     * const signature = await client.signTypedData({
-     *   domain: {
-     *     name: 'Ether Mail',
-     *     version: '1',
-     *     chainId: 1,
-     *     verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
-     *   },
-     *   types: {
-     *     Person: [
-     *       { name: 'name', type: 'string' },
-     *       { name: 'wallet', type: 'address' },
-     *     ],
-     *     Mail: [
-     *       { name: 'from', type: 'Person' },
-     *       { name: 'to', type: 'Person' },
-     *       { name: 'contents', type: 'string' },
-     *     ],
-     *   },
-     *   primaryType: 'Mail',
-     *   message: {
-     *     from: {
-     *       name: 'Cow',
-     *       wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
-     *     },
-     *     to: {
-     *       name: 'Bob',
-     *       wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
-     *     },
-     *     contents: 'Hello, Bob!',
-     *   },
-     * })
-     */
-    signTypedData: WalletActions<TChain, TAccount>['signTypedData'];
-    /**
-     * Signs a raw keccak256 hash of some payload using secp256k1.
-     * Not supported by most wallets.
-     *
-     * @deprecated Use `signMessage` instead for maximal wallet compatibility.
-     *
-     * @returns the signature encoded as a hex string, with the 0x prefix
-     */
-    sign: (args: SignParameters) => Promise<[Uint8Array, number]>;
-    /**
-     * Gets a secret to be shared between this wallet and the target publicKey.
-     *
-     * WARNING: Not supported by most wallets!
-     *
-     * @returns the shared secret.
-     */
-    getSharedSecret: (args: GetSharedSecretParameters<TAccount>) => Promise<Uint8Array>;
-};
-export declare function audiusWalletActions<TTransport extends Transport, TChain extends Chain | undefined, TAccount extends AudiusAccount>(client: Client<TTransport, TChain, TAccount>): AudiusWalletActions<TChain, TAccount>;

package/dist/sdk/services/AudiusWalletClient/index.d.ts

@@ -1,4 +0,0 @@
-export * from './types';
-export * from './createHedgehogWalletClient';
-export * from './createAppWalletClient';
-export * from './decorators/audiusWallet';

package/dist/sdk/services/AudiusWalletClient/localTransport.d.ts

@@ -1,10 +0,0 @@
-/**
- * A stub of a Viem transport. Used in cases where making an RPC call is unwanted,
- * which is true of most AudiusWalletClient implementations.
- */
-export declare const localTransport: () => {
-    request: ({ method, params }: {
-        method: string;
-        params?: object | unknown[] | undefined;
-    }) => Promise<never>;
-};

package/dist/sdk/services/AudiusWalletClient/privateKeyToAudiusAccount.d.ts

@@ -1,6 +0,0 @@
-import { type Hex } from 'viem';
-import type { AudiusAccount } from './types';
-/**
- * Creates a Viem account that has sign and getSharedSecret capability from a private key.
- */
-export declare function privateKeyToAudiusAccount(privateKey: Hex): AudiusAccount;

package/dist/sdk/services/AudiusWalletClient/types.d.ts

@@ -1,24 +0,0 @@
-import type { Account, Chain, Client, Hex, RpcSchema, Transport } from 'viem';
-import type { Prettify } from '../../utils/prettify';
-import type { AudiusWalletActions } from './decorators/audiusWallet';
-/**
- * The AudiusAccount is like the LocalAccount from Viem, except it
- * has raw signing and sharedSecret capabilities for encryption purposes,
- * used for communications with comms to keep chats/DMs e2ee.
- */
-export type AudiusAccount = Account & {
-    /**
-     * Get a shared secret, used for Chats
-     */
-    getSharedSecret: (publicKey: string | Uint8Array) => Promise<Uint8Array>;
-    /**
-     * Signs the keccak hash of some data, used for Chats
-     * @deprecated use signMessage instead
-     */
-    signRaw: (data: Hex) => Promise<[Uint8Array, number]>;
-};
-/**
- * AudiusWalletClient is the combination of a subset of WalletClient from Viem
- * and some additional actions, `getSharedSecret` and `sign`.
- */
-export type AudiusWalletClient<TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends AudiusAccount = AudiusAccount, TRpcSchema extends RpcSchema | undefined = undefined> = Prettify<Client<TTransport, TChain, TAccount, TRpcSchema, AudiusWalletActions<TChain, TAccount>>>;

package/dist/sdk/services/AudiusWalletClient/utils.d.ts

@@ -1,7 +0,0 @@
-type ValueOrArray<T> = undefined | string | number | T | Array<ValueOrArray<T>>;
-type SortObject = ValueOrArray<Record<string, string | number>>;
-/**
- * Recursively sorts object keys alphabetically
- */
-export declare function sortObjectKeys(x: SortObject): SortObject;
-export {};

package/dist/sdk/services/Encryption/EmailEncryptionService.d.ts

@@ -1,107 +0,0 @@
-import type { Configuration } from '../..';
-import { BaseAPI } from '../../api/generated/default';
-import type { AudiusWalletClient } from '../AudiusWalletClient';
-import type { EncryptedEmailsResult, SharedSymmetricKey } from './types';
-export declare class EmailEncryptionService extends BaseAPI {
-    private readonly audiusWalletClient;
-    private readonly symmetricKeyCache;
-    private readonly sharedSecretCache;
-    private readonly cacheSize;
-    /**
-     * Constructs a new EmailEncryptionService instance
-     * @param config - SDK configuration object
-     * @param audiusWalletClient - Configured AudiusWalletClient instance for cryptographic operations
-     */
-    constructor(config: Configuration, audiusWalletClient: AudiusWalletClient);
-    /**
-     * Creates a new symmetric key for email encryption
-     * @returns The symmetric key as Uint8Array
-     */
-    createSymmetricKey(): Uint8Array;
-    /**
-     * Encrypts a symmetric key for a user using their public key and shared secret
-     * @param userId - The ID of the user to encrypt for
-     * @param symmetricKey - The symmetric key to encrypt
-     * @returns The encrypted key as a base64 string
-     */
-    encryptSymmetricKey(userId: string, symmetricKey: Uint8Array): Promise<string>;
-    /**
-     * Decrypts a symmetric key using cached shared secrets
-     * @param encryptedKey - The encrypted symmetric key as a base64 string
-     * @param userId - The ID of the user who encrypted the key
-     * @param pubkeyBase64 - Optional pre-provided public key to avoid API calls
-     * @returns The decrypted symmetric key from cache or new decryption
-     * @remarks Uses LRU caching for symmetric keys and shared secrets to improve performance
-     */
-    decryptSymmetricKey(encryptedKey: string, userId: string, pubkeyBase64?: string): Promise<Uint8Array>;
-    /**
-     * Encrypts an email using a symmetric key
-     * @param email - The email to encrypt
-     * @param symmetricKey - The symmetric key to use
-     * @returns The encrypted email as a base64 string
-     */
-    encryptEmail(email: string, symmetricKey: Uint8Array): Promise<string>;
-    /**
-     * Decrypts an email using a symmetric key
-     * @param encryptedEmail - The encrypted email as a base64 string
-     * @param symmetricKey - The symmetric key to use
-     * @returns The decrypted email
-     */
-    decryptEmail(encryptedEmail: string, symmetricKey: Uint8Array): Promise<string>;
-    /**
-     * Creates and distributes a symmetric key between an email owner and recipients
-     * @param emailOwnerId - The ID of the email owner
-     * @param receivingIds - List of user IDs who will receive access
-     * @param grantorId - The ID of the user granting access
-     * @returns The encrypted symmetric keys for storage
-     * @remarks Includes the email owner in the recipient list automatically
-     */
-    createSharedKey(emailOwnerId: string, receivingIds: string[], grantorId: string): Promise<SharedSymmetricKey>;
-    /**
-     * Encrypts emails for multiple recipients using a shared symmetric key
-     * @param emailOwnerId - The ID of the email owner
-     * @param receivingIds - List of user IDs who will receive access
-     * @param grantorId - The ID of the user granting access
-     * @param emails - List of emails to encrypt
-     * @returns Object containing encrypted emails and encrypted symmetric keys
-     */
-    encryptEmails(emailOwnerId: string, receivingIds: string[], grantorId: string, emails: string[]): Promise<EncryptedEmailsResult>;
-    /**
-     * Removes oldest entries from a cache map when size limit is reached
-     * @param map - The cache map to prune
-     * @remarks Implements LRU-like cache eviction by removing oldest 1/3 of entries
-     * @private Internal cache maintenance utility
-     */
-    private removeOldestEntries;
-    /**
-     * Direct decryption path using user ID to fetch public key
-     * @param encryptedKey - Base64 encoded encrypted symmetric key
-     * @param userId - ID of user who encrypted the key
-     * @returns Decrypted symmetric key bytes
-     * @private Internal decryption implementation
-     */
-    private decryptSymmetricKeyDirect;
-    /**
-     * Optimized decryption path using pre-provided public key
-     * @param encryptedKey - Base64 encoded encrypted symmetric key
-     * @param pubkeyBase64 - Base64 encoded public key of encrypting user
-     * @returns Decrypted symmetric key bytes
-     * @private Internal decryption implementation
-     * @remarks Bypasses public key API call when key is already known
-     */
-    private decryptSymmetricKeyWithPublicKey;
-    /**
-     * Gets the public key for a user from the comms API
-     * @param userId - The ID of the user to get the public key for
-     * @returns The user's public key as a Uint8Array
-     * @private Internal API call wrapper
-     */
-    private getPublicKey;
-    /**
-     * Retrieves shared secret with caching mechanism
-     * @param publicKey - Public key to derive shared secret from
-     * @returns Cached shared secret promise
-     * @private Manages LRU cache for shared secrets
-     */
-    private getSharedSecretWithCache;
-}

package/dist/sdk/services/Encryption/index.d.ts

@@ -1,2 +0,0 @@
-export { EmailEncryptionService } from './EmailEncryptionService';
-export type { EncryptedKey, SharedSymmetricKey, EncryptedEmailsResult } from './types';

package/dist/sdk/services/Encryption/types.d.ts

@@ -1,13 +0,0 @@
-export type EncryptedKey = {
-    receivingId: string;
-    encryptedKey: string;
-    grantorId: string;
-};
-export type SharedSymmetricKey = {
-    symmetricKey: Uint8Array;
-    receiverEncryptedKeys: EncryptedKey[];
-};
-export type EncryptedEmailsResult = {
-    encryptedEmails: string[];
-    receiverEncryptedKeys: EncryptedKey[];
-};

package/dist/sdk/services/EntityManager/EntityManager.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/sdk/services/EntityManager/EntityManagerClient.d.ts

@@ -1,48 +0,0 @@
-import { type Hex } from 'viem';
-import { Action, EntityManagerConfig, EntityManagerService, EntityManagerTransactionReceipt, EntityType, ManageEntityOptions } from './types';
-export declare class EntityManagerClient implements EntityManagerService {
-    private readonly audiusWalletClient;
-    private readonly logger;
-    private readonly chainId;
-    private readonly contractAddress;
-    private readonly endpoint;
-    constructor(config_: EntityManagerConfig);
-    /**
-     * Calls the manage entity method on chain to update some data
-     */
-    manageEntity({ userId, entityType, entityId, action, metadata, confirmationTimeout, skipConfirmation }: ManageEntityOptions): Promise<EntityManagerTransactionReceipt>;
-    /**
-     * Confirms a write by polling for the block to be indexed by API
-     */
-    confirmWrite({ blockHash, blockNumber, confirmationTimeout, confirmationPollingInterval }: {
-        blockHash: string;
-        blockNumber: number;
-        confirmationTimeout?: number;
-        confirmationPollingInterval?: number;
-    }): Promise<boolean>;
-    /**
-     * Decodes the manage entity function data
-     * @param data - The encoded function data
-     * @returns The decoded function data
-     */
-    decodeManageEntity(data: Hex): {
-        userId: bigint;
-        entityType: EntityType;
-        entityId: bigint;
-        action: Action;
-        metadata: string;
-        nonce: `0x${string}`;
-        subjectSig: `0x${string}`;
-    };
-    /**
-     * Gets the domain used for proxy signing for the entity manager
-     * @returns The domain object
-     */
-    private getDomain;
-    /**
-     * Recovers the signer address from the encoded ABI
-     * @param encodedABI - The encoded ABI
-     * @returns The recovered signer address
-     */
-    recoverSigner(encodedABI: Hex): Promise<`0x${string}`>;
-}