@audius/sdk 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser.js +70 -27
- package/dist/browser.js.map +1 -1
- package/dist/index.d.ts +62 -1804
- package/dist/index.js +179 -36
- package/dist/index.js.map +1 -1
- package/dist/legacy.d.ts +13 -1
- package/dist/legacy.js +179 -36
- package/dist/legacy.js.map +1 -1
- package/dist/sdk.js +10 -0
- package/dist/sdk.js.map +1 -0
- package/dist/types.d.ts +13 -1
- package/examples/initAudiusLibs.js +1 -0
- package/examples/initializeVersions.js +1 -0
- package/initScripts/mainnet.js +1 -0
- package/package.json +7 -2
- package/rollup.config.js +49 -0
- package/src/api/base.d.ts +4 -0
- package/src/api/reactions.ts +39 -0
- package/src/libs.js +13 -7
- package/src/sdk/sdkBrowserDist.ts +3 -0
- package/src/services/discoveryProvider/DiscoveryProvider.ts +7 -4
- package/src/services/identity/IdentityService.ts +19 -0
- package/src/services/solanaWeb3Manager/transfer.js +1 -1
- package/src/utils/utils.ts +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,22 +1,17 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
3
|
-
import { PathArg } from 'proper-url-join';
|
|
4
|
-
import * as BN from 'bn.js';
|
|
5
|
-
import BN__default from 'bn.js';
|
|
1
|
+
import { UserImporterOptions, ImportCandidate } from 'ipfs-unixfs-importer';
|
|
2
|
+
import * as ipfs_unixfs_importer_types_src_types from 'ipfs-unixfs-importer/types/src/types';
|
|
6
3
|
import * as Web3 from 'web3';
|
|
7
4
|
import Web3__default from 'web3';
|
|
5
|
+
import * as BN from 'bn.js';
|
|
8
6
|
import { AbiItem } from 'web3-utils';
|
|
9
|
-
import * as
|
|
10
|
-
import {
|
|
7
|
+
import * as axios from 'axios';
|
|
8
|
+
import { AxiosResponse, AxiosRequestConfig, AxiosError } from 'axios';
|
|
9
|
+
import FormData from 'form-data';
|
|
11
10
|
import Wallet from 'ethereumjs-wallet';
|
|
11
|
+
import { HttpProvider, AbstractProvider, Log, TransactionReceipt } from 'web3-core';
|
|
12
12
|
import abiDecoder from 'abi-decoder';
|
|
13
13
|
import { Hedgehog } from '@audius/hedgehog';
|
|
14
14
|
import { EIP712TypedData } from 'eth-sig-util';
|
|
15
|
-
import * as web3_eth_contract from 'web3-eth-contract';
|
|
16
|
-
import { Contract } from 'web3-eth-contract';
|
|
17
|
-
import { UserImporterOptions, ImportCandidate } from 'ipfs-unixfs-importer';
|
|
18
|
-
import * as ipfs_unixfs_importer_types_src_types from 'ipfs-unixfs-importer/types/src/types';
|
|
19
|
-
import FormData from 'form-data';
|
|
20
15
|
|
|
21
16
|
declare type Content = ReadableStream | Buffer | string;
|
|
22
17
|
interface ImageHasher {
|
|
@@ -149,218 +144,43 @@ interface ContractMethod {
|
|
|
149
144
|
};
|
|
150
145
|
encodeABI: () => string;
|
|
151
146
|
send: <Tx>(config: {
|
|
152
|
-
from: Wallet |
|
|
147
|
+
from: Wallet | undefined;
|
|
153
148
|
gas: number;
|
|
154
149
|
gasPrice?: number;
|
|
155
150
|
}) => Tx;
|
|
156
151
|
}
|
|
157
152
|
|
|
158
|
-
declare type
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
}
|
|
163
|
-
declare type Service = ServiceName | ServiceWithEndpoint;
|
|
164
|
-
|
|
165
|
-
declare type Maybe<T> = T | undefined;
|
|
166
|
-
declare type Nullable<T> = T | null;
|
|
167
|
-
interface Logger {
|
|
168
|
-
/**
|
|
169
|
-
* Write a 'log' level log.
|
|
170
|
-
*/
|
|
171
|
-
log: (message: any, ...optionalParams: any[]) => any;
|
|
172
|
-
/**
|
|
173
|
-
* Write a 'info' level log.
|
|
174
|
-
*/
|
|
175
|
-
info: (message: any, ...optionalParams: any[]) => any;
|
|
176
|
-
/**
|
|
177
|
-
* Write an 'error' level log.
|
|
178
|
-
*/
|
|
179
|
-
error: (message: any, ...optionalParams: any[]) => any;
|
|
180
|
-
/**
|
|
181
|
-
* Write a 'warn' level log.
|
|
182
|
-
*/
|
|
183
|
-
warn: (message: any, ...optionalParams: any[]) => any;
|
|
184
|
-
/**
|
|
185
|
-
* Write a 'debug' level log.
|
|
186
|
-
*/
|
|
187
|
-
debug?: (message: any, ...optionalParams: any[]) => any;
|
|
188
|
-
/**
|
|
189
|
-
* Write a 'verbose' level log.
|
|
190
|
-
*/
|
|
191
|
-
verbose?: (message: any, ...optionalParams: any[]) => any;
|
|
192
|
-
}
|
|
153
|
+
declare type Providers = [
|
|
154
|
+
HttpProvider,
|
|
155
|
+
...Array<HttpProvider | AbstractProvider>
|
|
156
|
+
];
|
|
193
157
|
|
|
194
|
-
declare type
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
}
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
(config: {
|
|
210
|
-
verbose: boolean;
|
|
211
|
-
}): Promise<Service[]>;
|
|
212
|
-
}
|
|
213
|
-
interface Decision {
|
|
214
|
-
stage: string;
|
|
215
|
-
val?: unknown;
|
|
216
|
-
}
|
|
217
|
-
declare type Backup = {
|
|
218
|
-
block_difference: number;
|
|
219
|
-
version: string;
|
|
158
|
+
declare type SchemaConfig = {
|
|
159
|
+
schema: {
|
|
160
|
+
definitions: Record<string, {
|
|
161
|
+
required: string[];
|
|
162
|
+
properties: Record<string, {
|
|
163
|
+
default: unknown;
|
|
164
|
+
}>;
|
|
165
|
+
} | {}>;
|
|
166
|
+
};
|
|
167
|
+
baseDefinition: string;
|
|
168
|
+
validate?: (obj: Record<string, unknown>) => void;
|
|
169
|
+
};
|
|
170
|
+
declare type Schemas = {
|
|
171
|
+
TrackSchema: SchemaConfig;
|
|
172
|
+
UserSchema: SchemaConfig;
|
|
220
173
|
};
|
|
221
|
-
interface ServiceSelectionConfig {
|
|
222
|
-
blacklist?: Set<string> | undefined | null;
|
|
223
|
-
whitelist?: Set<string> | undefined | null;
|
|
224
|
-
getServices: GetServicesInput;
|
|
225
|
-
maxConcurrentRequests?: number;
|
|
226
|
-
requestTimeout?: Maybe<number>;
|
|
227
|
-
unhealthyTTL?: number;
|
|
228
|
-
backupsTTL?: number;
|
|
229
|
-
}
|
|
230
|
-
/**
|
|
231
|
-
* A class that assists with autoselecting services.
|
|
232
|
-
* `ServiceSelection` is intended to be overridden with further
|
|
233
|
-
* business logic that a particular sevice might preference.
|
|
234
|
-
*
|
|
235
|
-
* The general use case is as follows:
|
|
236
|
-
*
|
|
237
|
-
* ```
|
|
238
|
-
*
|
|
239
|
-
* const selector = new ServiceSelection({
|
|
240
|
-
* getServices: ethContracts.getDiscoveryProviders()
|
|
241
|
-
* })
|
|
242
|
-
*
|
|
243
|
-
* const service = await selector.select()
|
|
244
|
-
*
|
|
245
|
-
* ```
|
|
246
|
-
*
|
|
247
|
-
* This class operates by taking a list of services and
|
|
248
|
-
* round-robin makes requests at them until a suitable one is found.
|
|
249
|
-
*
|
|
250
|
-
* Two types of "bad" services are defined below:
|
|
251
|
-
* - Unhealthy: this service is bad and should not be used
|
|
252
|
-
* - Backup: this service is bad, but if we can't find anything better, maybe use it
|
|
253
|
-
*
|
|
254
|
-
* Classes that extend `ServiceSelection` can choose to implement custom logic on top
|
|
255
|
-
* of them and is generally how this class is intended to be used.
|
|
256
|
-
*/
|
|
257
|
-
declare class ServiceSelection {
|
|
258
|
-
blacklist: Set<string> | undefined | null;
|
|
259
|
-
whitelist: Set<string> | undefined | null;
|
|
260
|
-
getServices: GetServices;
|
|
261
|
-
maxConcurrentRequests: number;
|
|
262
|
-
requestTimeout: number;
|
|
263
|
-
unhealthyTTL: number;
|
|
264
|
-
backupsTTL: number;
|
|
265
|
-
unhealthy: Set<string>;
|
|
266
|
-
backups: Record<string, Backup>;
|
|
267
|
-
totalAttempts: number;
|
|
268
|
-
decisionTree: Decision[];
|
|
269
|
-
unhealthyCleanupTimeout: NodeJS.Timeout | null;
|
|
270
|
-
backupCleanupTimeout: NodeJS.Timeout | null;
|
|
271
|
-
constructor({ blacklist, whitelist, getServices, maxConcurrentRequests, requestTimeout, // 30s
|
|
272
|
-
unhealthyTTL, // 1 hour
|
|
273
|
-
backupsTTL }: ServiceSelectionConfig);
|
|
274
|
-
/**
|
|
275
|
-
* Selects a service
|
|
276
|
-
* @param reset if reset is true, clear the decision tree
|
|
277
|
-
*/
|
|
278
|
-
select(reset?: any): Promise<any>;
|
|
279
|
-
/**
|
|
280
|
-
* Finds all selectable services (respecting whitelist, health checks & timeouts).
|
|
281
|
-
* Note: this method is potentially slow.
|
|
282
|
-
* If you need just a single service, prefer calling `.select()`
|
|
283
|
-
* @param {boolean} verbose whether or not to return full services metadata
|
|
284
|
-
* @param {Set} whitelist a whitelist to override the set of endpoints
|
|
285
|
-
*/
|
|
286
|
-
findAll({ verbose, whitelist }?: {
|
|
287
|
-
verbose?: boolean | undefined;
|
|
288
|
-
whitelist?: Set<string> | null | undefined;
|
|
289
|
-
}): Promise<(Service | null)[]>;
|
|
290
|
-
/** Triggers a clean up of unhealthy and backup services so they can be retried later */
|
|
291
|
-
triggerCleanup(): void;
|
|
292
|
-
clearUnhealthy(): void;
|
|
293
|
-
clearBackups(): void;
|
|
294
|
-
/** A short-circuit. If overriden, can be used to skip selection (which could be slow) */
|
|
295
|
-
shortcircuit(): null | string;
|
|
296
|
-
/**
|
|
297
|
-
* Filter out services that are in the blacklist
|
|
298
|
-
* @param services endpoints
|
|
299
|
-
*/
|
|
300
|
-
filterFromBlacklist(services: string[]): string[];
|
|
301
|
-
/** Filter down services to those in the whitelist */
|
|
302
|
-
filterToWhitelist(services: string[]): string[];
|
|
303
|
-
/** Filter out known unhealthy services from the provided */
|
|
304
|
-
filterOutKnownUnhealthy(services: string[]): string[];
|
|
305
|
-
/** Given a list of services, samples maxConcurrentRequests from them */
|
|
306
|
-
getSelectionRound(services: string[]): string[];
|
|
307
|
-
/** Gets the total number of attempts we've made this instantiation */
|
|
308
|
-
getTotalAttempts(): number;
|
|
309
|
-
/** Where does the health check for this type of service live */
|
|
310
|
-
static getHealthCheckEndpoint(service: string): string;
|
|
311
|
-
/**
|
|
312
|
-
* What the criteria is for a healthy service
|
|
313
|
-
* @param response axios response
|
|
314
|
-
* @param {{ [key: string]: string}} urlMap health check urls mapped to their cannonical url
|
|
315
|
-
* e.g. https://discoveryprovider.audius.co/health_check => https://discoveryprovider.audius.co
|
|
316
|
-
*/
|
|
317
|
-
isHealthy(response: AxiosResponse, _urlMap: Record<string, Service>): boolean;
|
|
318
|
-
/** Races requests against each other with provided timeouts and health checks */
|
|
319
|
-
race(services: string[]): Promise<{
|
|
320
|
-
best: null;
|
|
321
|
-
errored: (string | undefined)[];
|
|
322
|
-
}>;
|
|
323
|
-
/** Adds a service to the unhealthy set */
|
|
324
|
-
addUnhealthy(service: ServiceName): void;
|
|
325
|
-
/** Gets unhealthy set size */
|
|
326
|
-
getUnhealthySize(): number;
|
|
327
|
-
/**
|
|
328
|
-
* Removes from unhealthy set
|
|
329
|
-
* @param key service endpoint
|
|
330
|
-
*/
|
|
331
|
-
removeFromUnhealthy(key: string): void;
|
|
332
|
-
/**
|
|
333
|
-
* Adds a service to the list of backups
|
|
334
|
-
* @param service the service to add
|
|
335
|
-
* @param response the services response. This can be used to weigh various
|
|
336
|
-
* backups against eachother
|
|
337
|
-
*/
|
|
338
|
-
addBackup(service: string, response: Backup): void;
|
|
339
|
-
/**
|
|
340
|
-
* Controls how a backup is picked. Overriding methods may choose to use the backup's response.
|
|
341
|
-
* e.g. pick a backup that's the fewest versions behind
|
|
342
|
-
*/
|
|
343
|
-
selectFromBackups(): Promise<string | undefined>;
|
|
344
|
-
/**
|
|
345
|
-
* Removes from backups
|
|
346
|
-
* @param key service endpoint
|
|
347
|
-
*/
|
|
348
|
-
removeFromBackups(key: string): void;
|
|
349
|
-
/**
|
|
350
|
-
* Returns the size of backups
|
|
351
|
-
*/
|
|
352
|
-
getBackupsSize(): number;
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
declare type TimeFrame = 'day' | 'week' | 'month' | 'year' | 'millennium';
|
|
356
174
|
|
|
357
|
-
declare type Web3Config
|
|
175
|
+
declare type Web3Config = {
|
|
176
|
+
ownerWallet: Wallet;
|
|
177
|
+
providers: Providers;
|
|
358
178
|
useExternalWeb3: boolean;
|
|
359
179
|
internalWeb3Config: {
|
|
360
180
|
web3ProviderEndpoints: string[];
|
|
361
|
-
privateKey
|
|
181
|
+
privateKey: string;
|
|
362
182
|
};
|
|
363
|
-
externalWeb3Config
|
|
183
|
+
externalWeb3Config: {
|
|
364
184
|
web3: Web3__default;
|
|
365
185
|
ownerWallet: Wallet;
|
|
366
186
|
};
|
|
@@ -371,47 +191,7 @@ declare class AudiusABIDecoder {
|
|
|
371
191
|
static decodeLogs(_: string, logs: Log[]): abiDecoder.DecodedLog;
|
|
372
192
|
}
|
|
373
193
|
|
|
374
|
-
declare type
|
|
375
|
-
web3Config: Web3Config$1;
|
|
376
|
-
identityService: IdentityService;
|
|
377
|
-
hedgehog: Hedgehog;
|
|
378
|
-
isServer?: boolean;
|
|
379
|
-
};
|
|
380
|
-
/** singleton class to be instantiated and persisted with every AudiusLibs */
|
|
381
|
-
declare class Web3Manager {
|
|
382
|
-
web3Config: Web3Config$1;
|
|
383
|
-
isServer: boolean;
|
|
384
|
-
identityService: IdentityService;
|
|
385
|
-
hedgehog: Hedgehog;
|
|
386
|
-
AudiusABIDecoder: typeof AudiusABIDecoder;
|
|
387
|
-
web3: Web3__default | undefined;
|
|
388
|
-
useExternalWeb3: boolean | undefined;
|
|
389
|
-
ownerWallet: Wallet;
|
|
390
|
-
constructor({ web3Config, identityService, hedgehog, isServer }: Web3ManagerConfig);
|
|
391
|
-
init(): Promise<void>;
|
|
392
|
-
getWeb3(): Web3__default;
|
|
393
|
-
setWeb3(web3: Web3__default): void;
|
|
394
|
-
getWalletAddress(): any;
|
|
395
|
-
setOwnerWallet(ownerWallet: Wallet): void;
|
|
396
|
-
web3IsExternal(): boolean | undefined;
|
|
397
|
-
getOwnerWalletPrivateKey(): Buffer;
|
|
398
|
-
/**
|
|
399
|
-
* Signs provided string data (should be timestamped).
|
|
400
|
-
* @param data
|
|
401
|
-
*/
|
|
402
|
-
sign(data: string): Promise<string | undefined>;
|
|
403
|
-
/**
|
|
404
|
-
* Given a data payload and signature, verifies that signature is valid, and returns
|
|
405
|
-
* Ethereum wallet address used to sign data.
|
|
406
|
-
* @param data information that was signed
|
|
407
|
-
* @param signature hex-formatted signature of data generated by web3 personalSign method
|
|
408
|
-
*/
|
|
409
|
-
verifySignature(data: string, signature: string): Promise<string>;
|
|
410
|
-
signTypedData(signatureData: EIP712TypedData): Promise<unknown>;
|
|
411
|
-
sendTransaction(contractMethod: ContractMethod, contractRegistryKey?: string | null, contractAddress?: string | null, txRetries?: number, txGasLimit?: number): Promise<TransactionReceipt>;
|
|
412
|
-
provider(url: string, timeout: number): HttpProvider;
|
|
413
|
-
monkeyPatchProvider(httpProvider: HttpProvider): HttpProvider;
|
|
414
|
-
}
|
|
194
|
+
declare type TimeFrame = 'day' | 'week' | 'month' | 'year' | 'millennium';
|
|
415
195
|
|
|
416
196
|
declare type Data = Record<string, unknown>;
|
|
417
197
|
declare type RelayTransaction = {
|
|
@@ -456,15 +236,11 @@ declare type AttestationResult = {
|
|
|
456
236
|
phase?: string;
|
|
457
237
|
reason?: string;
|
|
458
238
|
};
|
|
459
|
-
declare type IdentityServiceConfig = {
|
|
460
|
-
identityServiceEndpoint: string;
|
|
461
|
-
captcha?: Captcha;
|
|
462
|
-
};
|
|
463
239
|
declare class IdentityService {
|
|
464
240
|
identityServiceEndpoint: string;
|
|
465
|
-
captcha: Captcha
|
|
241
|
+
captcha: Captcha;
|
|
466
242
|
web3Manager: Web3Manager | null;
|
|
467
|
-
constructor(
|
|
243
|
+
constructor(identityServiceEndpoint: string, captcha: Captcha);
|
|
468
244
|
setWeb3Manager(web3Manager: Web3Manager): void;
|
|
469
245
|
getFn(params: {
|
|
470
246
|
lookupKey: string;
|
|
@@ -589,1041 +365,40 @@ declare class IdentityService {
|
|
|
589
365
|
}>;
|
|
590
366
|
}
|
|
591
367
|
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
declare type EthWeb3ManagerConfig = {
|
|
597
|
-
web3Config: EthWeb3Config;
|
|
598
|
-
identityService: IdentityService;
|
|
599
|
-
hedgehog?: Hedgehog;
|
|
600
|
-
};
|
|
601
|
-
/** Singleton state-manager for Audius Eth Contracts */
|
|
602
|
-
declare class EthWeb3Manager {
|
|
603
|
-
web3Config: EthWeb3Config;
|
|
604
|
-
web3: Web3__default;
|
|
368
|
+
/** singleton class to be instantiated and persisted with every AudiusLibs */
|
|
369
|
+
declare class Web3Manager {
|
|
370
|
+
web3Config: Web3Config;
|
|
371
|
+
isServer: boolean;
|
|
605
372
|
identityService: IdentityService;
|
|
606
|
-
hedgehog
|
|
607
|
-
|
|
608
|
-
|
|
373
|
+
hedgehog: Hedgehog;
|
|
374
|
+
AudiusABIDecoder: typeof AudiusABIDecoder;
|
|
375
|
+
web3: Web3__default | undefined;
|
|
376
|
+
useExternalWeb3: boolean | undefined;
|
|
377
|
+
ownerWallet: Wallet;
|
|
378
|
+
constructor(web3Config: Web3Config, identityService: IdentityService, hedgehog: Hedgehog, isServer: boolean);
|
|
379
|
+
init(): Promise<void>;
|
|
609
380
|
getWeb3(): Web3__default;
|
|
381
|
+
setWeb3(web3: Web3__default): void;
|
|
610
382
|
getWalletAddress(): any;
|
|
383
|
+
setOwnerWallet(ownerWallet: Wallet): void;
|
|
384
|
+
web3IsExternal(): boolean | undefined;
|
|
385
|
+
getOwnerWalletPrivateKey(): Buffer;
|
|
611
386
|
/**
|
|
612
387
|
* Signs provided string data (should be timestamped).
|
|
388
|
+
* @param data
|
|
613
389
|
*/
|
|
614
|
-
sign(data: string): Promise<string>;
|
|
615
|
-
sendTransaction(contractMethod: ContractMethod, contractAddress?: string | null, privateKey?: string | null, txRetries?: number, txGasLimit?: number | null): Promise<TransactionReceipt>;
|
|
616
|
-
/**
|
|
617
|
-
* Relays an eth transaction via the identity service with retries
|
|
618
|
-
* The relay pays for the transaction fee on behalf of the user
|
|
619
|
-
* The gas Limit is estimated if not provided
|
|
620
|
-
*/
|
|
621
|
-
relayTransaction(contractMethod: ContractMethod, contractAddress: string, ownerWallet: Wallet | string, relayerWallet?: Wallet | string, txRetries?: number, txGasLimit?: number | null): Promise<Maybe<RelayTransaction['resp']>>;
|
|
622
|
-
getRelayMethodParams(contractAddress: string, contractMethod: ContractMethod, relayerWallet: Wallet): Promise<{
|
|
623
|
-
contractAddress: string;
|
|
624
|
-
encodedABI: string;
|
|
625
|
-
gasLimit: number;
|
|
626
|
-
}>;
|
|
627
|
-
}
|
|
628
|
-
|
|
629
|
-
declare class AudiusTokenClient {
|
|
630
|
-
ethWeb3Manager: EthWeb3Manager;
|
|
631
|
-
contractABI: AbiItem[];
|
|
632
|
-
contractAddress: string;
|
|
633
|
-
web3: Web3__default;
|
|
634
|
-
AudiusTokenContract: Contract;
|
|
635
|
-
bustCacheNonce: number;
|
|
636
|
-
constructor(ethWeb3Manager: EthWeb3Manager, contractABI: AbiItem[], contractAddress: string);
|
|
637
|
-
bustCache(): Promise<void>;
|
|
638
|
-
balanceOf(account: string): Promise<BN__default>;
|
|
639
|
-
name(): Promise<any>;
|
|
640
|
-
nonces(wallet: string): Promise<number>;
|
|
641
|
-
transfer(recipient: string, amount: BN__default): Promise<{
|
|
642
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
643
|
-
}>;
|
|
644
|
-
transferFrom(owner: string, recipient: string, relayer: string, amount: BN__default): Promise<{
|
|
645
|
-
txReceipt: Maybe<{
|
|
646
|
-
txHash: string;
|
|
647
|
-
txParams: {
|
|
648
|
-
data: string;
|
|
649
|
-
gasLimit: string;
|
|
650
|
-
gasPrice: number;
|
|
651
|
-
nonce: string;
|
|
652
|
-
to: string;
|
|
653
|
-
value: string;
|
|
654
|
-
};
|
|
655
|
-
}>;
|
|
656
|
-
}>;
|
|
657
|
-
permit(owner: string, // address
|
|
658
|
-
spender: string, // address
|
|
659
|
-
value: BN__default, // uint
|
|
660
|
-
deadline: number, // uint
|
|
661
|
-
v: number, // uint8
|
|
662
|
-
r: Uint8Array | Buffer, // bytes32
|
|
663
|
-
s: Uint8Array | Buffer): Promise<Maybe<{
|
|
664
|
-
txHash: string;
|
|
665
|
-
txParams: {
|
|
666
|
-
data: string;
|
|
667
|
-
gasLimit: string;
|
|
668
|
-
gasPrice: number;
|
|
669
|
-
nonce: string;
|
|
670
|
-
to: string;
|
|
671
|
-
value: string;
|
|
672
|
-
};
|
|
673
|
-
}>>;
|
|
674
|
-
approve(spender: string, value: BN__default, privateKey?: null): Promise<{
|
|
675
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
676
|
-
}>;
|
|
677
|
-
approveProxyTokens(owner: string, spender: string, value: BN__default, relayer: string): Promise<{
|
|
678
|
-
txReceipt: Maybe<{
|
|
679
|
-
txHash: string;
|
|
680
|
-
txParams: {
|
|
681
|
-
data: string;
|
|
682
|
-
gasLimit: string;
|
|
683
|
-
gasPrice: number;
|
|
684
|
-
nonce: string;
|
|
685
|
-
to: string;
|
|
686
|
-
value: string;
|
|
687
|
-
};
|
|
688
|
-
}>;
|
|
689
|
-
}>;
|
|
690
|
-
}
|
|
691
|
-
|
|
692
|
-
declare class RegistryClient {
|
|
693
|
-
web3Manager: EthWeb3Manager;
|
|
694
|
-
contractABI: AbiItem[];
|
|
695
|
-
contractAddress: string;
|
|
696
|
-
web3: Web3__default;
|
|
697
|
-
Registry: Contract;
|
|
698
|
-
constructor(web3Manager: EthWeb3Manager, contractABI: AbiItem[], contractAddress: string);
|
|
699
|
-
getContract(contractRegistryKey: string): Promise<string>;
|
|
700
|
-
}
|
|
701
|
-
|
|
702
|
-
/**
|
|
703
|
-
* This class provides the logic to select a healthy gateway
|
|
704
|
-
*/
|
|
705
|
-
declare class ProviderSelection extends ServiceSelection {
|
|
706
|
-
services: string[];
|
|
707
|
-
constructor(services?: string[]);
|
|
708
|
-
/**
|
|
709
|
-
* Filters out previously tried providers, and then initializes the client
|
|
710
|
-
* (ContractClient, RegistryClient) with a healthy POA provider.
|
|
711
|
-
*
|
|
712
|
-
* @param client object used for making transaction calls
|
|
713
|
-
*/
|
|
714
|
-
select(client: {
|
|
715
|
-
web3Manager: Web3Manager | EthWeb3Manager;
|
|
716
|
-
}): Promise<void>;
|
|
717
|
-
getServicesSize(): number;
|
|
718
|
-
}
|
|
719
|
-
|
|
720
|
-
declare type GetRegistryAddress = (key: string) => Promise<string>;
|
|
721
|
-
declare class ContractClient {
|
|
722
|
-
web3Manager: Web3Manager | EthWeb3Manager;
|
|
723
|
-
contractABI: ContractABI['abi'];
|
|
724
|
-
contractRegistryKey: string;
|
|
725
|
-
getRegistryAddress: GetRegistryAddress;
|
|
726
|
-
_contractAddress: Nullable<string>;
|
|
727
|
-
_contract: Nullable<Contract>;
|
|
728
|
-
_isInitialized: boolean;
|
|
729
|
-
_isInitializing: boolean;
|
|
730
|
-
_initAttempts: number;
|
|
731
|
-
providerSelector: Nullable<ProviderSelection>;
|
|
732
|
-
logger: Logger;
|
|
733
|
-
constructor(web3Manager: Web3Manager | EthWeb3Manager, contractABI: ContractABI['abi'], contractRegistryKey: string, getRegistryAddress: GetRegistryAddress, logger?: Logger, contractAddress?: Nullable<string>);
|
|
734
|
-
/** Inits the contract if necessary */
|
|
735
|
-
init(): Promise<void>;
|
|
736
|
-
retryInit(selectNewEndpoint?: boolean): Promise<void>;
|
|
737
|
-
/**
|
|
738
|
-
* Adds current provider into unhealthy set and selects the next healthy provider
|
|
739
|
-
*/
|
|
740
|
-
selectNewEndpoint(): Promise<void>;
|
|
741
|
-
/** Gets the contract address and ensures that the contract has initted. */
|
|
742
|
-
getAddress(): Promise<string>;
|
|
743
|
-
/**
|
|
744
|
-
* Gets a contract method and ensures that the contract has initted
|
|
745
|
-
* The contract can then be invoked with .call() or be passed to a sendTransaction.
|
|
746
|
-
* @param methodName the name of the contract method
|
|
747
|
-
*/
|
|
748
|
-
getMethod(methodName: string, ...args: any[]): Promise<any>;
|
|
749
|
-
getEthNetId(): Promise<number>;
|
|
750
|
-
getContract(): Promise<Contract>;
|
|
751
|
-
}
|
|
752
|
-
|
|
753
|
-
declare class StakingProxyClient extends ContractClient {
|
|
754
|
-
audiusTokenClient: AudiusTokenClient;
|
|
755
|
-
toBN: (value: string | number) => BN__default;
|
|
756
|
-
constructor(ethWeb3Manager: EthWeb3Manager, contractABI: ContractABI['abi'], contractRegistryKey: string, getRegistryAddress: GetRegistryAddress, audiusTokenClient: AudiusTokenClient, logger?: Logger);
|
|
757
|
-
token(): Promise<any>;
|
|
758
|
-
totalStaked(): Promise<BN__default>;
|
|
759
|
-
supportsHistory(): Promise<any>;
|
|
760
|
-
totalStakedFor(account: string): Promise<BN__default>;
|
|
761
|
-
totalStakedForAt(account: string, blockNumber: string): Promise<BN__default>;
|
|
762
|
-
totalStakedAt(blockNumber: number): Promise<BN__default>;
|
|
763
|
-
isStaker(account: string): Promise<any>;
|
|
764
|
-
getDelegateManagerAddress(): Promise<any>;
|
|
765
|
-
getClaimsManagerAddress(): Promise<any>;
|
|
766
|
-
getServiceProviderFactoryAddress(): Promise<any>;
|
|
767
|
-
getGovernanceAddress(): Promise<any>;
|
|
768
|
-
getLastClaimedBlockForUser(): Promise<any>;
|
|
769
|
-
}
|
|
770
|
-
|
|
771
|
-
declare type ProposalTxn = {
|
|
772
|
-
proposalId: string;
|
|
773
|
-
proposer: string;
|
|
774
|
-
submissionBlockNumber: string;
|
|
775
|
-
targetContractRegistryKey: string;
|
|
776
|
-
targetContractAddress: string;
|
|
777
|
-
callValue: string;
|
|
778
|
-
functionSignature: string;
|
|
779
|
-
callData: string;
|
|
780
|
-
outcome: string;
|
|
781
|
-
numVotes: string;
|
|
782
|
-
voteMagnitudeYes: string;
|
|
783
|
-
voteMagnitudeNo: string;
|
|
784
|
-
};
|
|
785
|
-
declare class GovernanceClient extends ContractClient {
|
|
786
|
-
audiusTokenClient: AudiusTokenClient;
|
|
787
|
-
stakingProxyClient: StakingProxyClient;
|
|
788
|
-
isDebug: boolean;
|
|
789
|
-
constructor(ethWeb3Manager: EthWeb3Manager, contractABI: ContractABI['abi'], contractRegistryKey: string, getRegistryAddress: GetRegistryAddress, audiusTokenClient: AudiusTokenClient, stakingProxyClient: StakingProxyClient, logger?: Logger, isDebug?: boolean);
|
|
790
|
-
/**
|
|
791
|
-
* Gets the function signature and call data for a contract method.
|
|
792
|
-
* The signature and call data are passed to other contracts (like governance)
|
|
793
|
-
* as arguments.
|
|
794
|
-
* @param methodName
|
|
795
|
-
* @param contractMethod
|
|
796
|
-
*/
|
|
797
|
-
getSignatureAndCallData(methodName: string, contractMethod: ContractMethod): {
|
|
798
|
-
signature: string;
|
|
799
|
-
callData: string;
|
|
800
|
-
};
|
|
801
|
-
guardianExecuteTransaction(contractRegistryKey: string, functionSignature: string, callData: string): Promise<ContractMethod>;
|
|
802
|
-
getVotingPeriod(): Promise<number>;
|
|
803
|
-
setVotingPeriod(period: string): Promise<web3_core.TransactionReceipt>;
|
|
804
|
-
getVotingQuorumPercent(): Promise<number>;
|
|
805
|
-
getExecutionDelay(): Promise<number>;
|
|
806
|
-
setExecutionDelay(delay: number): Promise<web3_core.TransactionReceipt>;
|
|
807
|
-
getProposalById(id: number): Promise<{
|
|
808
|
-
proposalId: number;
|
|
809
|
-
proposer: string;
|
|
810
|
-
submissionBlockNumber: number;
|
|
811
|
-
targetContractRegistryKey: string;
|
|
812
|
-
targetContractAddress: string;
|
|
813
|
-
callValue: number;
|
|
814
|
-
functionSignature: string;
|
|
815
|
-
callData: string;
|
|
816
|
-
outcome: number;
|
|
817
|
-
numVotes: number;
|
|
818
|
-
voteMagnitudeYes: BN;
|
|
819
|
-
voteMagnitudeNo: BN;
|
|
820
|
-
}>;
|
|
821
|
-
getProposalTargetContractHash(id: string): Promise<any>;
|
|
822
|
-
getProposals(queryStartBlock?: number): Promise<{
|
|
823
|
-
proposalId: number;
|
|
824
|
-
proposer: any;
|
|
825
|
-
description: any;
|
|
826
|
-
name: any;
|
|
827
|
-
blockNumber: number;
|
|
828
|
-
}[]>;
|
|
829
|
-
getProposalsForAddresses(addresses: string[], queryStartBlock?: number): Promise<{
|
|
830
|
-
proposalId: number;
|
|
831
|
-
proposer: any;
|
|
832
|
-
description: any;
|
|
833
|
-
name: any;
|
|
834
|
-
blockNumber: number;
|
|
835
|
-
}[]>;
|
|
836
|
-
getProposalSubmission(proposalId: number, queryStartBlock?: number): Promise<{
|
|
837
|
-
proposalId: number;
|
|
838
|
-
proposer: any;
|
|
839
|
-
description: any;
|
|
840
|
-
name: any;
|
|
841
|
-
blockNumber: number;
|
|
842
|
-
}>;
|
|
843
|
-
getInProgressProposals(): Promise<any>;
|
|
844
|
-
submitProposal({ targetContractRegistryKey, callValue, functionSignature, callData, // array of args, e.g. [slashAmount, targetAddress]
|
|
845
|
-
name, description }: {
|
|
846
|
-
targetContractRegistryKey: string;
|
|
847
|
-
callValue: string;
|
|
848
|
-
functionSignature: string;
|
|
849
|
-
callData: string[];
|
|
850
|
-
name: string;
|
|
851
|
-
description: string;
|
|
852
|
-
}): Promise<any>;
|
|
853
|
-
submitVote({ proposalId, vote }: {
|
|
854
|
-
proposalId: number;
|
|
855
|
-
vote: string;
|
|
856
|
-
}): Promise<void>;
|
|
857
|
-
updateVote({ proposalId, vote }: {
|
|
858
|
-
proposalId: number;
|
|
859
|
-
vote: string;
|
|
860
|
-
}): Promise<void>;
|
|
861
|
-
evaluateProposalOutcome(proposalId: number): Promise<web3_core.TransactionReceipt>;
|
|
862
|
-
getProposalEvaluation(proposalId: number, queryStartBlock?: number): Promise<web3_eth_contract.EventData[]>;
|
|
863
|
-
getVotes({ proposalId, queryStartBlock }: {
|
|
864
|
-
proposalId: number;
|
|
865
|
-
queryStartBlock: number;
|
|
866
|
-
}): Promise<{
|
|
867
|
-
proposalId: number;
|
|
868
|
-
voter: any;
|
|
869
|
-
vote: number;
|
|
870
|
-
voterStake: BN;
|
|
871
|
-
blockNumber: number;
|
|
872
|
-
}[]>;
|
|
873
|
-
getVoteUpdates({ proposalId, queryStartBlock }: {
|
|
874
|
-
proposalId: number;
|
|
875
|
-
queryStartBlock: number;
|
|
876
|
-
}): Promise<{
|
|
877
|
-
proposalId: number;
|
|
878
|
-
voter: any;
|
|
879
|
-
vote: number;
|
|
880
|
-
voterStake: BN;
|
|
881
|
-
blockNumber: number;
|
|
882
|
-
}[]>;
|
|
883
|
-
getVoteSubmissionsByAddress({ addresses, queryStartBlock }: {
|
|
884
|
-
addresses: string[];
|
|
885
|
-
queryStartBlock: number;
|
|
886
|
-
}): Promise<{
|
|
887
|
-
proposalId: number;
|
|
888
|
-
voter: any;
|
|
889
|
-
vote: number;
|
|
890
|
-
voterStake: BN;
|
|
891
|
-
blockNumber: number;
|
|
892
|
-
}[]>;
|
|
893
|
-
getVoteUpdatesByAddress({ addresses, queryStartBlock }: {
|
|
894
|
-
addresses: string[];
|
|
895
|
-
queryStartBlock: number;
|
|
896
|
-
}): Promise<{
|
|
897
|
-
proposalId: number;
|
|
898
|
-
voter: any;
|
|
899
|
-
vote: number;
|
|
900
|
-
voterStake: BN;
|
|
901
|
-
blockNumber: number;
|
|
902
|
-
}[]>;
|
|
903
|
-
getVoteByProposalAndVoter({ proposalId, voterAddress }: {
|
|
904
|
-
proposalId: number[];
|
|
905
|
-
voterAddress: number;
|
|
906
|
-
}): Promise<number>;
|
|
907
|
-
/**
|
|
908
|
-
* ABI encodes argument types and values together into one encoded string
|
|
909
|
-
*/
|
|
910
|
-
abiEncode(types: string[], values: string[]): string;
|
|
911
|
-
toBN(val: string): BN;
|
|
912
|
-
/**
|
|
913
|
-
* Prune off extraneous fields from proposal returned by txn
|
|
914
|
-
*/
|
|
915
|
-
formatProposal(proposal: ProposalTxn): {
|
|
916
|
-
proposalId: number;
|
|
917
|
-
proposer: string;
|
|
918
|
-
submissionBlockNumber: number;
|
|
919
|
-
targetContractRegistryKey: string;
|
|
920
|
-
targetContractAddress: string;
|
|
921
|
-
callValue: number;
|
|
922
|
-
functionSignature: string;
|
|
923
|
-
callData: string;
|
|
924
|
-
outcome: number;
|
|
925
|
-
numVotes: number;
|
|
926
|
-
voteMagnitudeYes: BN;
|
|
927
|
-
voteMagnitudeNo: BN;
|
|
928
|
-
};
|
|
929
|
-
/**
|
|
930
|
-
* Formats a proposal event
|
|
931
|
-
*/
|
|
932
|
-
formatProposalEvent(proposalEvent: EventLog): {
|
|
933
|
-
proposalId: number;
|
|
934
|
-
proposer: any;
|
|
935
|
-
description: any;
|
|
936
|
-
name: any;
|
|
937
|
-
blockNumber: number;
|
|
938
|
-
};
|
|
939
|
-
/**
|
|
940
|
-
* Prune off extraneous fields from vote event
|
|
941
|
-
*/
|
|
942
|
-
formatVote(voteEvent: EventLog): {
|
|
943
|
-
proposalId: number;
|
|
944
|
-
voter: any;
|
|
945
|
-
vote: number;
|
|
946
|
-
voterStake: BN;
|
|
947
|
-
blockNumber: number;
|
|
948
|
-
};
|
|
949
|
-
/**
|
|
950
|
-
*
|
|
951
|
-
* @param {Number} proposalId id of the governance proposal
|
|
952
|
-
* @returns {BN} amount of tokens in wei required to reach quorum
|
|
953
|
-
*/
|
|
954
|
-
calculateQuorum(proposalId: number): Promise<any>;
|
|
955
|
-
}
|
|
956
|
-
|
|
957
|
-
/**
|
|
958
|
-
* Contract class that extends a ContractClient and provides an interface
|
|
959
|
-
* to retrieve governed methods that cannot be executed directly.
|
|
960
|
-
*/
|
|
961
|
-
declare class GovernedContractClient extends ContractClient {
|
|
962
|
-
governanceClient: GovernanceClient;
|
|
963
|
-
constructor(web3Manager: Web3Manager | EthWeb3Manager, contractABI: ContractABI['abi'], contractRegistryKey: string, getRegistryAddress: GetRegistryAddress, governanceClient: GovernanceClient, logger?: Logger);
|
|
964
|
-
/**
|
|
965
|
-
* Gets a governed version of a method and allows a single transaction
|
|
966
|
-
* to be sent to the governance client with the appropriate payload.
|
|
967
|
-
* Similar to `getMethod`
|
|
968
|
-
*/
|
|
969
|
-
getGovernedMethod(methodName: string, ...args: unknown[]): Promise<ContractMethod>;
|
|
970
|
-
}
|
|
971
|
-
|
|
972
|
-
declare class ServiceTypeManagerClient extends GovernedContractClient {
|
|
973
|
-
/**
|
|
974
|
-
*
|
|
975
|
-
* @param serviceType Type of service to set the version, either `discovery-node` or `content-node`
|
|
976
|
-
* @param serviceVersion Version string to set on chain
|
|
977
|
-
* @param privateKey Optional privateKey to pass along to web3Manager sendTransaction
|
|
978
|
-
* @param dryRun Optional parameter to return the generated parameters without sending tx
|
|
979
|
-
* @returns comma-separated String of serviceType and serviceVersion if dryRun; else response from web3Manager.sendTransaction
|
|
980
|
-
*/
|
|
981
|
-
setServiceVersion(serviceType: string, serviceVersion: string, privateKey?: string | null, dryRun?: boolean): Promise<string | web3_core.TransactionReceipt>;
|
|
982
|
-
addServiceType(serviceType: string, serviceTypeMin: string, serviceTypeMax: string, privateKey?: string | null): Promise<web3_core.TransactionReceipt>;
|
|
983
|
-
getValidServiceTypes(): Promise<string[]>;
|
|
984
|
-
getCurrentVersion(serviceType: string): Promise<string>;
|
|
985
|
-
getVersion(serviceType: string, serviceTypeIndex: number): Promise<string>;
|
|
986
|
-
getNumberOfVersions(serviceType: string): Promise<number>;
|
|
987
|
-
/**
|
|
988
|
-
* @notice Add a new service type
|
|
989
|
-
* @returns {
|
|
990
|
-
* isValid: Is the types type is isValid
|
|
991
|
-
* minStake: minimum stake for service type
|
|
992
|
-
* maxStake: minimum stake for service type
|
|
993
|
-
* }
|
|
994
|
-
*/
|
|
995
|
-
getServiceTypeInfo(serviceType: string): Promise<{
|
|
996
|
-
isValid: any;
|
|
997
|
-
minStake: BN;
|
|
998
|
-
maxStake: BN;
|
|
999
|
-
}>;
|
|
1000
|
-
}
|
|
1001
|
-
|
|
1002
|
-
declare type GetEvent$1 = {
|
|
1003
|
-
serviceType: string;
|
|
1004
|
-
owner: string;
|
|
1005
|
-
queryStartBlock: number;
|
|
1006
|
-
};
|
|
1007
|
-
declare class ServiceProviderFactoryClient extends GovernedContractClient {
|
|
1008
|
-
audiusTokenClient: AudiusTokenClient;
|
|
1009
|
-
stakingProxyClient: StakingProxyClient;
|
|
1010
|
-
isDebug: boolean;
|
|
1011
|
-
constructor(ethWeb3Manager: EthWeb3Manager, contractABI: ContractABI['abi'], contractRegistryKey: string, getRegistryAddress: GetRegistryAddress, audiusTokenClient: AudiusTokenClient, stakingProxyClient: StakingProxyClient, governanceClient: GovernanceClient, logger?: Logger, isDebug?: boolean);
|
|
1012
|
-
registerWithDelegate(serviceType: string, endpoint: string, amount: number | string | BN__default, delegateOwnerWallet: string): Promise<{
|
|
1013
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
1014
|
-
spID: number;
|
|
1015
|
-
serviceType: string;
|
|
1016
|
-
owner: any;
|
|
1017
|
-
endpoint: any;
|
|
1018
|
-
tokenApproveReceipt: {
|
|
1019
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
1020
|
-
};
|
|
1021
|
-
}>;
|
|
1022
|
-
register(serviceType: string, endpoint: string, amount: BN__default): Promise<{
|
|
1023
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
1024
|
-
spID: number;
|
|
1025
|
-
serviceType: string;
|
|
1026
|
-
owner: any;
|
|
1027
|
-
endpoint: any;
|
|
1028
|
-
tokenApproveReceipt: {
|
|
1029
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
1030
|
-
};
|
|
1031
|
-
}>;
|
|
1032
|
-
getRegisteredServiceProviderEvents({ serviceType, owner, queryStartBlock }: GetEvent$1): Promise<{
|
|
1033
|
-
blockNumber: number;
|
|
1034
|
-
spID: number;
|
|
1035
|
-
serviceType: string;
|
|
1036
|
-
owner: any;
|
|
1037
|
-
endpoint: any;
|
|
1038
|
-
stakeAmount: BN__default;
|
|
1039
|
-
}[]>;
|
|
1040
|
-
getDeregisteredServiceProviderEvents({ serviceType, owner, queryStartBlock }: GetEvent$1): Promise<{
|
|
1041
|
-
blockNumber: number;
|
|
1042
|
-
spID: number;
|
|
1043
|
-
serviceType: string;
|
|
1044
|
-
owner: any;
|
|
1045
|
-
endpoint: any;
|
|
1046
|
-
stakeAmount: BN__default;
|
|
1047
|
-
}[]>;
|
|
1048
|
-
getIncreasedStakeEvents({ owner, queryStartBlock }: {
|
|
1049
|
-
owner: string;
|
|
1050
|
-
queryStartBlock: number;
|
|
1051
|
-
}): Promise<{
|
|
1052
|
-
blockNumber: number;
|
|
1053
|
-
owner: any;
|
|
1054
|
-
increaseAmount: BN__default;
|
|
1055
|
-
newStakeAmount: BN__default;
|
|
1056
|
-
}[]>;
|
|
1057
|
-
getDecreasedStakeEvaluatedEvents({ owner, queryStartBlock }: {
|
|
1058
|
-
owner: string;
|
|
1059
|
-
queryStartBlock: number;
|
|
1060
|
-
}): Promise<{
|
|
1061
|
-
blockNumber: number;
|
|
1062
|
-
owner: any;
|
|
1063
|
-
decreaseAmount: BN__default;
|
|
1064
|
-
newStakeAmount: BN__default;
|
|
1065
|
-
}[]>;
|
|
1066
|
-
getDecreasedStakeRequestedEvents({ owner, queryStartBlock }: {
|
|
1067
|
-
owner: string;
|
|
1068
|
-
queryStartBlock: number;
|
|
1069
|
-
}): Promise<{
|
|
1070
|
-
blockNumber: number;
|
|
1071
|
-
owner: any;
|
|
1072
|
-
decreaseAmount: BN__default;
|
|
1073
|
-
lockupExpiryBlock: number;
|
|
1074
|
-
}[]>;
|
|
1075
|
-
getDecreasedStakeCancelledEvents({ owner, queryStartBlock }: {
|
|
1076
|
-
owner: string;
|
|
1077
|
-
queryStartBlock: number;
|
|
1078
|
-
}): Promise<{
|
|
1079
|
-
blockNumber: number;
|
|
1080
|
-
owner: any;
|
|
1081
|
-
decreaseAmount: BN__default;
|
|
1082
|
-
lockupExpiryBlock: number;
|
|
1083
|
-
}[]>;
|
|
1084
|
-
getDeregisteredService({ serviceType, spID, queryStartBlock }: {
|
|
1085
|
-
serviceType: string;
|
|
1086
|
-
spID: string;
|
|
1087
|
-
queryStartBlock: number;
|
|
1088
|
-
}): Promise<{
|
|
1089
|
-
endpoint: string;
|
|
1090
|
-
delegateOwnerWallet: string;
|
|
1091
|
-
owner?: string | undefined;
|
|
1092
|
-
}>;
|
|
1093
|
-
increaseStake(amount: BN__default): Promise<{
|
|
1094
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
1095
|
-
tokenApproveReceipt: {
|
|
1096
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
1097
|
-
};
|
|
1098
|
-
}>;
|
|
1099
|
-
/**
|
|
1100
|
-
* Makes a request to decrease stake
|
|
1101
|
-
* @param amount
|
|
1102
|
-
* @returns decrease stake lockup expiry block
|
|
1103
|
-
*/
|
|
1104
|
-
requestDecreaseStake(amount: BN__default): Promise<number>;
|
|
1105
|
-
/**
|
|
1106
|
-
* Gets the pending decrease stake request for a given account
|
|
1107
|
-
* @param account wallet address to fetch for
|
|
1108
|
-
*/
|
|
1109
|
-
getPendingDecreaseStakeRequest(account: string): Promise<{
|
|
1110
|
-
amount: BN__default;
|
|
1111
|
-
lockupExpiryBlock: number;
|
|
1112
|
-
}>;
|
|
1113
|
-
/**
|
|
1114
|
-
* Gets the pending decrease stake lockup duration
|
|
1115
|
-
*/
|
|
1116
|
-
getDecreaseStakeLockupDuration(): Promise<number>;
|
|
1117
|
-
/**
|
|
1118
|
-
* Gets the deployer cut lockup duration
|
|
1119
|
-
*/
|
|
1120
|
-
getDeployerCutLockupDuration(): Promise<number>;
|
|
1121
|
-
/**
|
|
1122
|
-
* Cancels the pending decrease stake request
|
|
1123
|
-
* @param account wallet address to cancel request for
|
|
1124
|
-
*/
|
|
1125
|
-
cancelDecreaseStakeRequest(account: string): Promise<void>;
|
|
1126
|
-
/**
|
|
1127
|
-
* Fetches the pending decrease stake lockup expiry block for a user
|
|
1128
|
-
* @param account wallet address to fetch for
|
|
1129
|
-
*/
|
|
1130
|
-
getLockupExpiry(account: string): Promise<number>;
|
|
1131
|
-
decreaseStake(): Promise<{
|
|
1132
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
1133
|
-
}>;
|
|
1134
|
-
/**
|
|
1135
|
-
* Deregisters a service
|
|
1136
|
-
* @param serviceType
|
|
1137
|
-
* @param endpoint
|
|
1138
|
-
*/
|
|
1139
|
-
deregister(serviceType: string, endpoint: string): Promise<{
|
|
1140
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
1141
|
-
spID: number;
|
|
1142
|
-
serviceType: string;
|
|
1143
|
-
owner: any;
|
|
1144
|
-
endpoint: any;
|
|
1145
|
-
}>;
|
|
1146
|
-
getTotalServiceTypeProviders(serviceType: string): Promise<number>;
|
|
1147
|
-
getServiceProviderIdFromEndpoint(endpoint: string): Promise<number>;
|
|
1148
|
-
getServiceProviderInfo(serviceType: string, serviceId: number): Promise<{
|
|
1149
|
-
owner: any;
|
|
1150
|
-
endpoint: any;
|
|
1151
|
-
spID: number;
|
|
1152
|
-
type: string;
|
|
1153
|
-
blockNumber: number;
|
|
1154
|
-
delegateOwnerWallet: any;
|
|
1155
|
-
}>;
|
|
1156
|
-
getServiceEndpointInfo(serviceType: string, serviceId: number): Promise<{
|
|
1157
|
-
owner: any;
|
|
1158
|
-
endpoint: any;
|
|
1159
|
-
spID: number;
|
|
1160
|
-
type: string;
|
|
1161
|
-
blockNumber: number;
|
|
1162
|
-
delegateOwnerWallet: any;
|
|
1163
|
-
}>;
|
|
1164
|
-
getServiceProviderInfoFromEndpoint(endpoint: string): Promise<{
|
|
1165
|
-
owner: any;
|
|
1166
|
-
endpoint: any;
|
|
1167
|
-
spID: number;
|
|
1168
|
-
type: string;
|
|
1169
|
-
blockNumber: number;
|
|
1170
|
-
delegateOwnerWallet: any;
|
|
1171
|
-
}>;
|
|
1172
|
-
getServiceProviderIdsFromAddress(ownerAddress: string, serviceType: string): Promise<number[]>;
|
|
1173
|
-
getServiceProviderIdFromAddress(ownerAddress: string, serviceType: string): Promise<number>;
|
|
1174
|
-
getServiceEndpointInfoFromAddress(ownerAddress: string, serviceType: string): Promise<{
|
|
1175
|
-
owner: any;
|
|
1176
|
-
endpoint: any;
|
|
1177
|
-
spID: number;
|
|
1178
|
-
type: string;
|
|
1179
|
-
blockNumber: number;
|
|
1180
|
-
delegateOwnerWallet: any;
|
|
1181
|
-
}[]>;
|
|
1182
|
-
/**
|
|
1183
|
-
* Returns all service providers of requested `serviceType`
|
|
1184
|
-
* Returns array of objects with schema { blockNumber, delegateOwnerWallet, endpoint, owner, spID, type }
|
|
1185
|
-
*/
|
|
1186
|
-
getServiceProviderList(serviceType: string): Promise<{
|
|
1187
|
-
owner: any;
|
|
1188
|
-
endpoint: any;
|
|
1189
|
-
spID: number;
|
|
1190
|
-
type: string;
|
|
1191
|
-
blockNumber: number;
|
|
1192
|
-
delegateOwnerWallet: any;
|
|
1193
|
-
}[]>;
|
|
1194
|
-
updateDecreaseStakeLockupDuration(duration: string): Promise<web3_core.TransactionReceipt>;
|
|
1195
|
-
getServiceProviderDetails(serviceProviderAddress: string): Promise<{
|
|
1196
|
-
deployerCut: number;
|
|
1197
|
-
deployerStake: BN__default;
|
|
1198
|
-
maxAccountStake: BN__default;
|
|
1199
|
-
minAccountStake: BN__default;
|
|
1200
|
-
numberOfEndpoints: number;
|
|
1201
|
-
validBounds: any;
|
|
1202
|
-
}>;
|
|
1203
|
-
updateDelegateOwnerWallet(serviceType: string, endpoint: string, updatedDelegateOwnerWallet: string): Promise<web3_core.TransactionReceipt>;
|
|
1204
|
-
updateEndpoint(serviceType: string, oldEndpoint: string, newEndpoint: string): Promise<web3_core.TransactionReceipt>;
|
|
1205
|
-
requestUpdateDeployerCut(ownerAddress: string, deployerCut: string): Promise<web3_core.TransactionReceipt>;
|
|
1206
|
-
getPendingUpdateDeployerCutRequest(ownerAddress: string): Promise<{
|
|
1207
|
-
lockupExpiryBlock: number;
|
|
1208
|
-
newDeployerCut: number;
|
|
1209
|
-
}>;
|
|
1210
|
-
cancelUpdateDeployerCut(ownerAddress: string): Promise<web3_core.TransactionReceipt>;
|
|
1211
|
-
updateDeployerCut(ownerAddress: string): Promise<web3_core.TransactionReceipt>;
|
|
1212
|
-
updateServiceProviderStake(ownerAddress: string, newAmount: string): Promise<web3_core.TransactionReceipt>;
|
|
1213
|
-
}
|
|
1214
|
-
|
|
1215
|
-
declare type GetEvent = {
|
|
1216
|
-
delegator: string;
|
|
1217
|
-
serviceProvider: string;
|
|
1218
|
-
queryStartBlock: number;
|
|
1219
|
-
};
|
|
1220
|
-
declare class DelegateManagerClient extends GovernedContractClient {
|
|
1221
|
-
audiusTokenClient: AudiusTokenClient;
|
|
1222
|
-
stakingProxyClient: StakingProxyClient;
|
|
1223
|
-
constructor(ethWeb3Manager: EthWeb3Manager, contractABI: ContractABI['abi'], contractRegistryKey: string, getRegistryAddress: GetRegistryAddress, audiusTokenClient: AudiusTokenClient, stakingProxyClient: StakingProxyClient, governanceClient: GovernanceClient, logger?: Logger);
|
|
1224
|
-
delegateStake(targetSP: string, amount: BN__default): Promise<{
|
|
1225
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
1226
|
-
tokenApproveReceipt: {
|
|
1227
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
1228
|
-
};
|
|
1229
|
-
delegator: any;
|
|
1230
|
-
serviceProvider: any;
|
|
1231
|
-
increaseAmount: BN__default;
|
|
1232
|
-
}>;
|
|
1233
|
-
getIncreaseDelegateStakeEvents({ delegator, serviceProvider, queryStartBlock }: GetEvent): Promise<{
|
|
1234
|
-
blockNumber: number;
|
|
1235
|
-
delegator: any;
|
|
1236
|
-
increaseAmount: BN__default;
|
|
1237
|
-
serviceProvider: any;
|
|
1238
|
-
}[]>;
|
|
1239
|
-
getDecreaseDelegateStakeEvents({ delegator, serviceProvider, queryStartBlock }: GetEvent): Promise<{
|
|
1240
|
-
blockNumber: number;
|
|
1241
|
-
delegator: any;
|
|
1242
|
-
amount: BN__default;
|
|
1243
|
-
serviceProvider: any;
|
|
1244
|
-
}[]>;
|
|
1245
|
-
getUndelegateStakeRequestedEvents({ delegator, serviceProvider, queryStartBlock }: GetEvent): Promise<{
|
|
1246
|
-
blockNumber: number;
|
|
1247
|
-
lockupExpiryBlock: number;
|
|
1248
|
-
delegator: any;
|
|
1249
|
-
amount: BN__default;
|
|
1250
|
-
serviceProvider: any;
|
|
1251
|
-
}[]>;
|
|
1252
|
-
getUndelegateStakeCancelledEvents({ delegator, serviceProvider, queryStartBlock }: GetEvent): Promise<{
|
|
1253
|
-
blockNumber: number;
|
|
1254
|
-
delegator: any;
|
|
1255
|
-
amount: BN__default;
|
|
1256
|
-
serviceProvider: any;
|
|
1257
|
-
}[]>;
|
|
1258
|
-
getClaimEvents({ claimer, queryStartBlock }: {
|
|
1259
|
-
claimer: string;
|
|
1260
|
-
queryStartBlock: number;
|
|
1261
|
-
}): Promise<{
|
|
1262
|
-
blockNumber: number;
|
|
1263
|
-
claimer: any;
|
|
1264
|
-
rewards: BN__default;
|
|
1265
|
-
newTotal: BN__default;
|
|
1266
|
-
}[]>;
|
|
1267
|
-
getSlashEvents({ target, queryStartBlock }: {
|
|
1268
|
-
target: string;
|
|
1269
|
-
queryStartBlock: number;
|
|
1270
|
-
}): Promise<{
|
|
1271
|
-
blockNumber: number;
|
|
1272
|
-
target: any;
|
|
1273
|
-
amount: BN__default;
|
|
1274
|
-
newTotal: BN__default;
|
|
1275
|
-
}[]>;
|
|
1276
|
-
getDelegatorRemovedEvents({ target, queryStartBlock }: {
|
|
1277
|
-
target: string;
|
|
1278
|
-
queryStartBlock: number;
|
|
1279
|
-
}): Promise<{
|
|
1280
|
-
blockNumber: number;
|
|
1281
|
-
serviceProvider: any;
|
|
1282
|
-
delegator: any;
|
|
1283
|
-
unstakedAmount: BN__default;
|
|
1284
|
-
}[]>;
|
|
1285
|
-
requestUndelegateStake(targetSP: string, amount: BN__default): Promise<web3_core.TransactionReceipt>;
|
|
1286
|
-
cancelUndelegateStakeRequest(): Promise<web3_core.TransactionReceipt>;
|
|
1287
|
-
undelegateStake(): Promise<{
|
|
1288
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
1289
|
-
delegator: any;
|
|
1290
|
-
serviceProvider: any;
|
|
1291
|
-
decreaseAmount: BN__default;
|
|
1292
|
-
}>;
|
|
1293
|
-
claimRewards(serviceProvider: string, txRetries?: number): Promise<web3_core.TransactionReceipt>;
|
|
1294
|
-
requestRemoveDelegator(serviceProvider: string, delegator: string): Promise<web3_core.TransactionReceipt>;
|
|
1295
|
-
cancelRemoveDelegatorRequest(serviceProvider: string, delegator: string): Promise<web3_core.TransactionReceipt>;
|
|
1296
|
-
removeDelegator(serviceProvider: string, delegator: string): Promise<{
|
|
1297
|
-
txReceipt: web3_core.TransactionReceipt;
|
|
1298
|
-
delegator: any;
|
|
1299
|
-
serviceProvider: any;
|
|
1300
|
-
unstakedAmount: BN__default;
|
|
1301
|
-
}>;
|
|
1302
|
-
getDelegatorsList(serviceProvider: string): Promise<any>;
|
|
1303
|
-
getTotalDelegatedToServiceProvider(serviceProvider: string): Promise<BN__default>;
|
|
1304
|
-
getTotalDelegatorStake(delegator: string): Promise<BN__default>;
|
|
1305
|
-
getTotalLockedDelegationForServiceProvider(serviceProvider: string): Promise<BN__default>;
|
|
1306
|
-
getDelegatorStakeForServiceProvider(delegator: string, serviceProvider: string): Promise<BN__default>;
|
|
1307
|
-
getPendingUndelegateRequest(delegator: string): Promise<{
|
|
1308
|
-
amount: BN__default;
|
|
1309
|
-
lockupExpiryBlock: number;
|
|
1310
|
-
target: any;
|
|
1311
|
-
}>;
|
|
1312
|
-
getPendingRemoveDelegatorRequest(serviceProvider: string, delegator: string): Promise<{
|
|
1313
|
-
lockupExpiryBlock: number;
|
|
1314
|
-
}>;
|
|
1315
|
-
getUndelegateLockupDuration(): Promise<number>;
|
|
1316
|
-
getMaxDelegators(): Promise<number>;
|
|
1317
|
-
getMinDelegationAmount(): Promise<BN__default>;
|
|
1318
|
-
getRemoveDelegatorLockupDuration(): Promise<number>;
|
|
1319
|
-
getRemoveDelegatorEvalDuration(): Promise<number>;
|
|
1320
|
-
getGovernanceAddress(): Promise<any>;
|
|
1321
|
-
getServiceProviderFactoryAddress(): Promise<any>;
|
|
1322
|
-
getClaimsManagerAddress(): Promise<any>;
|
|
1323
|
-
getStakingAddress(): Promise<any>;
|
|
1324
|
-
getSPMinDelegationAmount({ serviceProvider }: {
|
|
1325
|
-
serviceProvider: string;
|
|
1326
|
-
}): Promise<BN__default>;
|
|
1327
|
-
updateSPMinDelegationAmount({ serviceProvider, amount }: {
|
|
1328
|
-
serviceProvider: string;
|
|
1329
|
-
amount: BN__default;
|
|
1330
|
-
}): Promise<web3_core.TransactionReceipt>;
|
|
1331
|
-
updateRemoveDelegatorLockupDuration(duration: string): Promise<web3_core.TransactionReceipt>;
|
|
1332
|
-
updateUndelegateLockupDuration(duration: string): Promise<web3_core.TransactionReceipt>;
|
|
1333
|
-
}
|
|
1334
|
-
|
|
1335
|
-
declare class ClaimsManagerClient extends ContractClient {
|
|
1336
|
-
web3Manager: EthWeb3Manager;
|
|
1337
|
-
getFundingRoundBlockDiff(): Promise<number>;
|
|
1338
|
-
getLastFundedBlock(): Promise<number>;
|
|
1339
|
-
getFundsPerRound(): Promise<BN>;
|
|
1340
|
-
getTotalClaimedInRound(): Promise<BN>;
|
|
1341
|
-
getGovernanceAddress(): Promise<any>;
|
|
1342
|
-
getServiceProviderFactoryAddress(): Promise<any>;
|
|
1343
|
-
getDelegateManagerAddress(): Promise<any>;
|
|
1344
|
-
getStakingAddress(): Promise<any>;
|
|
1345
|
-
claimPending(address: string): Promise<any>;
|
|
1346
|
-
initiateRound(txRetries?: number): Promise<web3_core.TransactionReceipt>;
|
|
1347
|
-
getClaimProcessedEvents({ claimer, queryStartBlock }: {
|
|
1348
|
-
claimer: string;
|
|
1349
|
-
queryStartBlock: number;
|
|
1350
|
-
}): Promise<{
|
|
1351
|
-
blockNumber: number;
|
|
1352
|
-
claimer: any;
|
|
1353
|
-
rewards: BN;
|
|
1354
|
-
oldTotal: BN;
|
|
1355
|
-
newTotal: BN;
|
|
1356
|
-
}[]>;
|
|
1357
|
-
}
|
|
1358
|
-
|
|
1359
|
-
declare class ClaimDistributionClient extends ContractClient {
|
|
1360
|
-
/**
|
|
1361
|
-
* Calls the contract method to check if the claim index has been claimed
|
|
1362
|
-
*/
|
|
1363
|
-
isClaimed(index: number): Promise<any>;
|
|
1364
|
-
/**
|
|
1365
|
-
* Proxies the calls the contract method to make a claim
|
|
1366
|
-
* @param index
|
|
1367
|
-
* @param account
|
|
1368
|
-
* @param amount
|
|
1369
|
-
* @param merkleProof
|
|
1370
|
-
* @returns transaction
|
|
1371
|
-
*/
|
|
1372
|
-
claim(index: number, account: string, amount: BN__default, merkleProof: string[]): Promise<Maybe<{
|
|
1373
|
-
txHash: string;
|
|
1374
|
-
txParams: {
|
|
1375
|
-
/**
|
|
1376
|
-
* Proxies the calls the contract method to make a claim
|
|
1377
|
-
* @param index
|
|
1378
|
-
* @param account
|
|
1379
|
-
* @param amount
|
|
1380
|
-
* @param merkleProof
|
|
1381
|
-
* @returns transaction
|
|
1382
|
-
*/
|
|
1383
|
-
data: string;
|
|
1384
|
-
gasLimit: string;
|
|
1385
|
-
gasPrice: number;
|
|
1386
|
-
nonce: string;
|
|
1387
|
-
to: string;
|
|
1388
|
-
value: string;
|
|
1389
|
-
};
|
|
1390
|
-
}>>;
|
|
1391
|
-
}
|
|
1392
|
-
|
|
1393
|
-
declare class WormholeClient {
|
|
1394
|
-
ethWeb3Manager: EthWeb3Manager;
|
|
1395
|
-
contractABI: ContractABI['abi'];
|
|
1396
|
-
contractAddress: string;
|
|
1397
|
-
web3: Web3__default;
|
|
1398
|
-
audiusTokenClient: AudiusTokenClient;
|
|
1399
|
-
WormholeContract: Contract;
|
|
1400
|
-
constructor(ethWeb3Manager: EthWeb3Manager, contractABI: ContractABI['abi'], contractAddress: string, audiusTokenClient: AudiusTokenClient);
|
|
1401
|
-
nonces(wallet: string): Promise<number>;
|
|
1402
|
-
initialize(fromAcct: string, wormholeAddress: string, relayer: string): Promise<{
|
|
1403
|
-
txReceipt: Maybe<{
|
|
1404
|
-
txHash: string;
|
|
1405
|
-
txParams: {
|
|
1406
|
-
data: string;
|
|
1407
|
-
gasLimit: string;
|
|
1408
|
-
gasPrice: number;
|
|
1409
|
-
nonce: string;
|
|
1410
|
-
to: string;
|
|
1411
|
-
value: string;
|
|
1412
|
-
};
|
|
1413
|
-
}>;
|
|
1414
|
-
}>;
|
|
1415
|
-
/**
|
|
1416
|
-
* Transfers in eth from the user's wallet to the wormhole contract and
|
|
1417
|
-
* specifies a solana wallet to realized the tokens in SOL
|
|
1418
|
-
*/
|
|
1419
|
-
transferTokens(fromAcct: string, amount: BN__default, chainId: number, solanaAccount: string, arbiterFee: string, deadline: string, signedDigest: {
|
|
1420
|
-
v: string;
|
|
1421
|
-
r: string;
|
|
1422
|
-
s: string;
|
|
1423
|
-
}, relayer: string): Promise<Maybe<{
|
|
1424
|
-
txHash: string;
|
|
1425
|
-
txParams: {
|
|
1426
|
-
data: string;
|
|
1427
|
-
gasLimit: string;
|
|
1428
|
-
gasPrice: number;
|
|
1429
|
-
nonce: string;
|
|
1430
|
-
to: string;
|
|
1431
|
-
value: string;
|
|
1432
|
-
};
|
|
1433
|
-
}>>;
|
|
1434
|
-
}
|
|
1435
|
-
|
|
1436
|
-
declare class EthRewardsManagerClient extends ContractClient {
|
|
1437
|
-
token(): Promise<any>;
|
|
1438
|
-
getGovernanceAddress(): Promise<any>;
|
|
1439
|
-
getRecipientAddress(): Promise<any>;
|
|
1440
|
-
getAntiAbuseOracleAddresses(): Promise<any>;
|
|
1441
|
-
}
|
|
1442
|
-
|
|
1443
|
-
declare class TrustedNotifierManagerClient extends GovernedContractClient {
|
|
1444
|
-
/**
|
|
1445
|
-
* Register Trusted Notifier with specified fields (wallet, endpoint, email)
|
|
1446
|
-
* @notice Only callable by Governance contract
|
|
1447
|
-
* @notice All fields must be unique and non-falsey
|
|
1448
|
-
* @notice New Trusted Notifier is assigned an auto-incremented integer ID
|
|
1449
|
-
* @returns Newly assigned integer ID
|
|
1450
|
-
*/
|
|
1451
|
-
registerNotifier(wallet: string, endpoint: string, email: string, privateKey?: string | null): Promise<web3_core.TransactionReceipt>;
|
|
1452
|
-
/**
|
|
1453
|
-
* Deregister Trusted Notifier associated with wallet
|
|
1454
|
-
* @notice Only callable by Governance contract or wallet
|
|
1455
|
-
* @returns ID of deregistered Trusted Notifier
|
|
1456
|
-
*/
|
|
1457
|
-
deregisterNotifier(wallet: string, privateKey?: string | null): Promise<web3_core.TransactionReceipt>;
|
|
1458
|
-
getLatestNotifierID(): Promise<number>;
|
|
1459
|
-
/**
|
|
1460
|
-
* Returns all TrustedNotifier info associated with ID
|
|
1461
|
-
*/
|
|
1462
|
-
getNotifierForID(ID: string): Promise<{
|
|
1463
|
-
wallet: any;
|
|
1464
|
-
endpoint: any;
|
|
1465
|
-
email: any;
|
|
1466
|
-
}>;
|
|
1467
|
-
/**
|
|
1468
|
-
* Returns all TrustedNotifier info associated with wallet
|
|
1469
|
-
*/
|
|
1470
|
-
getNotifierForWallet(wallet: string): Promise<{
|
|
1471
|
-
ID: any;
|
|
1472
|
-
endpoint: any;
|
|
1473
|
-
email: any;
|
|
1474
|
-
}>;
|
|
1475
|
-
/**
|
|
1476
|
-
* Returns all TrustedNotifier info associated with endpoint
|
|
1477
|
-
*/
|
|
1478
|
-
getNotifierForEndpoint(endpoint: string): Promise<{
|
|
1479
|
-
ID: any;
|
|
1480
|
-
wallet: any;
|
|
1481
|
-
email: any;
|
|
1482
|
-
}>;
|
|
1483
|
-
/**
|
|
1484
|
-
* Returns all TrustedNotifier info associated with email
|
|
1485
|
-
*/
|
|
1486
|
-
getNotifierForEmail(email: string): Promise<{
|
|
1487
|
-
ID: any;
|
|
1488
|
-
wallet: any;
|
|
1489
|
-
endpoint: any;
|
|
1490
|
-
}>;
|
|
1491
|
-
}
|
|
1492
|
-
|
|
1493
|
-
declare type EthContractsConfig = {
|
|
1494
|
-
ethWeb3Manager: EthWeb3Manager;
|
|
1495
|
-
tokenContractAddress: string;
|
|
1496
|
-
registryAddress: string;
|
|
1497
|
-
claimDistributionContractAddress: string;
|
|
1498
|
-
wormholeContractAddress: string;
|
|
1499
|
-
isServer?: boolean;
|
|
1500
|
-
logger?: Logger;
|
|
1501
|
-
isDebug?: boolean;
|
|
1502
|
-
};
|
|
1503
|
-
declare class EthContracts {
|
|
1504
|
-
ethWeb3Manager: EthWeb3Manager;
|
|
1505
|
-
tokenContractAddress: string;
|
|
1506
|
-
claimDistributionContractAddress: string;
|
|
1507
|
-
wormholeContractAddress: string;
|
|
1508
|
-
registryAddress: string;
|
|
1509
|
-
isServer: boolean;
|
|
1510
|
-
logger: Logger;
|
|
1511
|
-
isDebug: boolean;
|
|
1512
|
-
expectedServiceVersions: null | string[];
|
|
1513
|
-
AudiusTokenClient: AudiusTokenClient;
|
|
1514
|
-
RegistryClient: RegistryClient;
|
|
1515
|
-
StakingProxyClient: StakingProxyClient;
|
|
1516
|
-
GovernanceClient: GovernanceClient;
|
|
1517
|
-
ClaimsManagerClient: ClaimsManagerClient;
|
|
1518
|
-
EthRewardsManagerClient: EthRewardsManagerClient;
|
|
1519
|
-
ServiceTypeManagerClient: ServiceTypeManagerClient;
|
|
1520
|
-
ServiceProviderFactoryClient: ServiceProviderFactoryClient;
|
|
1521
|
-
DelegateManagerClient: DelegateManagerClient;
|
|
1522
|
-
ClaimDistributionClient: ClaimDistributionClient | undefined;
|
|
1523
|
-
WormholeClient: WormholeClient;
|
|
1524
|
-
TrustedNotifierManagerClient: TrustedNotifierManagerClient;
|
|
1525
|
-
contractClients: ContractClient[];
|
|
1526
|
-
_regressedMode: boolean;
|
|
1527
|
-
contracts: Record<string, string> | undefined;
|
|
1528
|
-
contractAddresses: Record<string, string> | undefined;
|
|
1529
|
-
constructor({ ethWeb3Manager, tokenContractAddress, registryAddress, claimDistributionContractAddress, wormholeContractAddress, isServer, logger, isDebug }: EthContractsConfig);
|
|
1530
|
-
init(): Promise<void>;
|
|
1531
|
-
/**
|
|
1532
|
-
* Estabilishes that connection to discovery providers has regressed
|
|
1533
|
-
*/
|
|
1534
|
-
enterRegressedMode(): void;
|
|
1535
|
-
isInRegressedMode(): boolean;
|
|
1536
|
-
getRegistryAddressForContract(contractName: string): Promise<string>;
|
|
1537
|
-
getCurrentVersion(serviceType: string): Promise<string>;
|
|
1538
|
-
getExpectedServiceVersions(): Promise<Record<string, string | null | undefined>>;
|
|
1539
|
-
/**
|
|
1540
|
-
* Determine whether major and minor versions match for two version strings
|
|
1541
|
-
* Version string 2 must have equivalent major/minor versions and a patch >= version1
|
|
1542
|
-
* @param version1 string 1
|
|
1543
|
-
* @param version2 string 2
|
|
1544
|
-
*/
|
|
1545
|
-
isValidSPVersion(version1: string, version2: string): boolean;
|
|
1546
|
-
/**
|
|
1547
|
-
* Determines whether the major and minor versions are equal
|
|
1548
|
-
* @param version1 string 1
|
|
1549
|
-
* @param version2 string 2
|
|
1550
|
-
*/
|
|
1551
|
-
hasSameMajorAndMinorVersion(version1: string, version2: string): boolean;
|
|
1552
|
-
getServiceProviderList(spType: string): Promise<{
|
|
1553
|
-
owner: any;
|
|
1554
|
-
endpoint: any;
|
|
1555
|
-
spID: number;
|
|
1556
|
-
type: string;
|
|
1557
|
-
blockNumber: number;
|
|
1558
|
-
delegateOwnerWallet: any;
|
|
1559
|
-
}[]>;
|
|
1560
|
-
getNumberOfVersions(spType: string): Promise<number>;
|
|
1561
|
-
getVersion(spType: string, queryIndex: number): Promise<string>;
|
|
1562
|
-
getServiceTypeInfo(spType: string): Promise<{
|
|
1563
|
-
isValid: any;
|
|
1564
|
-
minStake: BN;
|
|
1565
|
-
maxStake: BN;
|
|
1566
|
-
}>;
|
|
1567
|
-
}
|
|
1568
|
-
|
|
1569
|
-
declare type DiscoveryProviderSelectionConfig = Omit<ServiceSelectionConfig, 'getServices'> & {
|
|
1570
|
-
reselectTimeout?: number;
|
|
1571
|
-
selectionCallback?: (endpoint: string, decisionTree: Decision[]) => void;
|
|
1572
|
-
monitoringCallbacks?: {
|
|
1573
|
-
healthCheck: (config: Record<string, unknown>) => void;
|
|
1574
|
-
request: (config: Record<string, unknown>) => void;
|
|
1575
|
-
};
|
|
1576
|
-
unhealthySlotDiffPlays?: number;
|
|
1577
|
-
unhealthyBlockDiff?: number;
|
|
1578
|
-
};
|
|
1579
|
-
declare class DiscoveryProviderSelection extends ServiceSelection {
|
|
1580
|
-
currentVersion: string;
|
|
1581
|
-
ethContracts: EthContracts;
|
|
1582
|
-
reselectTimeout: Maybe<number>;
|
|
1583
|
-
selectionCallback: Maybe<DiscoveryProviderSelectionConfig['selectionCallback']>;
|
|
1584
|
-
monitoringCallbacks: NonNullable<DiscoveryProviderSelectionConfig['monitoringCallbacks']> | {};
|
|
1585
|
-
unhealthySlotDiffPlays: Nullable<number>;
|
|
1586
|
-
unhealthyBlockDiff: number;
|
|
1587
|
-
_regressedMode: boolean;
|
|
1588
|
-
validVersions: Nullable<string[]>;
|
|
1589
|
-
constructor(config: DiscoveryProviderSelectionConfig, ethContracts: EthContracts);
|
|
1590
|
-
/** Retrieves a cached discovery provider from localstorage */
|
|
1591
|
-
getCached(): any;
|
|
1592
|
-
/** Clears any cached discovery provider from localstorage */
|
|
1593
|
-
clearCached(): void;
|
|
1594
|
-
/** Sets a cached discovery provider in localstorage */
|
|
1595
|
-
setCached(endpoint: string): void;
|
|
1596
|
-
/** Allows the selection take a shortcut if there's a cached provider */
|
|
1597
|
-
shortcircuit(): any;
|
|
1598
|
-
select(): Promise<any>;
|
|
1599
|
-
/**
|
|
1600
|
-
* Checks whether a given response is healthy:
|
|
1601
|
-
* - Not behind in blocks
|
|
1602
|
-
* - 200 response
|
|
1603
|
-
* - Current version
|
|
1604
|
-
*
|
|
1605
|
-
* Other responses are collected in `this.backups` if
|
|
1606
|
-
* - Behind by only a patch version
|
|
1607
|
-
*
|
|
1608
|
-
* @param response axios response
|
|
1609
|
-
* @param urlMap health check urls mapped to their cannonical url
|
|
1610
|
-
* e.g. https://discoveryprovider.audius.co/health_check => https://discoveryprovider.audius.co
|
|
1611
|
-
*/
|
|
1612
|
-
isHealthy(response: AxiosResponse, urlMap: Record<string, string>): boolean;
|
|
1613
|
-
/**
|
|
1614
|
-
* Estabilishes that connection to discovery providers has regressed
|
|
1615
|
-
*/
|
|
1616
|
-
enterRegressedMode(): void;
|
|
1617
|
-
setUnhealthyBlockDiff(updatedDiff?: number): void;
|
|
1618
|
-
setUnhealthySlotDiffPlays(updatedDiff: number): void;
|
|
1619
|
-
isInRegressedMode(): boolean;
|
|
390
|
+
sign(data: string): Promise<string | undefined>;
|
|
1620
391
|
/**
|
|
1621
|
-
*
|
|
1622
|
-
*
|
|
1623
|
-
*
|
|
1624
|
-
*
|
|
392
|
+
* Given a data payload and signature, verifies that signature is valid, and returns
|
|
393
|
+
* Ethereum wallet address used to sign data.
|
|
394
|
+
* @param data information that was signed
|
|
395
|
+
* @param signature hex-formatted signature of data generated by web3 personalSign method
|
|
1625
396
|
*/
|
|
1626
|
-
|
|
397
|
+
verifySignature(data: string, signature: string): Promise<string>;
|
|
398
|
+
signTypedData(signatureData: EIP712TypedData): Promise<unknown>;
|
|
399
|
+
sendTransaction(contractMethod: ContractMethod, contractRegistryKey?: string | null, contractAddress?: string | null, txRetries?: number, txGasLimit?: number): Promise<TransactionReceipt>;
|
|
400
|
+
provider(url: string, timeout: number): HttpProvider;
|
|
401
|
+
monkeyPatchProvider(httpProvider: HttpProvider): HttpProvider;
|
|
1627
402
|
}
|
|
1628
403
|
|
|
1629
404
|
declare type CurrentUser = {
|
|
@@ -1652,521 +427,6 @@ declare class UserStateManager {
|
|
|
1652
427
|
clearUser(): void;
|
|
1653
428
|
}
|
|
1654
429
|
|
|
1655
|
-
declare type RequestParams = {
|
|
1656
|
-
queryParams: Record<string, string>;
|
|
1657
|
-
endpoint: string;
|
|
1658
|
-
timeout?: number;
|
|
1659
|
-
method?: Method;
|
|
1660
|
-
urlParams?: PathArg;
|
|
1661
|
-
headers?: Record<string, string>;
|
|
1662
|
-
data?: Record<string, unknown>;
|
|
1663
|
-
};
|
|
1664
|
-
declare type DiscoveryProviderConfig = {
|
|
1665
|
-
whitelist?: Set<string>;
|
|
1666
|
-
blacklist?: Set<string>;
|
|
1667
|
-
userStateManager: UserStateManager;
|
|
1668
|
-
ethContracts: EthContracts;
|
|
1669
|
-
web3Manager?: Web3Manager;
|
|
1670
|
-
reselectTimeout?: number;
|
|
1671
|
-
selectionCallback?: DiscoveryProviderSelectionConfig['selectionCallback'];
|
|
1672
|
-
monitoringCallbacks?: DiscoveryProviderSelectionConfig['monitoringCallbacks'];
|
|
1673
|
-
selectionRequestTimeout?: number;
|
|
1674
|
-
selectionRequestRetries?: number;
|
|
1675
|
-
unhealthySlotDiffPlays?: number;
|
|
1676
|
-
unhealthyBlockDiff?: number;
|
|
1677
|
-
};
|
|
1678
|
-
declare type UserProfile = {
|
|
1679
|
-
userId: number;
|
|
1680
|
-
email: string;
|
|
1681
|
-
name: string;
|
|
1682
|
-
handle: string;
|
|
1683
|
-
verified: boolean;
|
|
1684
|
-
imageURL?: string;
|
|
1685
|
-
sub: number;
|
|
1686
|
-
iat: string;
|
|
1687
|
-
};
|
|
1688
|
-
/**
|
|
1689
|
-
* Constructs a service class for a discovery node
|
|
1690
|
-
* @param whitelist whether or not to only include specified nodes in selection
|
|
1691
|
-
* @param userStateManager singleton UserStateManager instance
|
|
1692
|
-
* @param ethContracts singleton EthContracts instance
|
|
1693
|
-
* @param web3Manager
|
|
1694
|
-
* @param reselectTimeout timeout to clear locally cached discovery providers
|
|
1695
|
-
* @param selectionCallback invoked when a discovery node is selected
|
|
1696
|
-
* @param monitoringCallbacks callbacks to be invoked with metrics from requests sent to a service
|
|
1697
|
-
* @param monitoringCallbacks.request
|
|
1698
|
-
* @param monitoringCallbacks.healthCheck
|
|
1699
|
-
* @param selectionRequestTimeout the amount of time (ms) an individual request should take before reselecting
|
|
1700
|
-
* @param selectionRequestRetries the number of retries to a given discovery node we make before reselecting
|
|
1701
|
-
* @param unhealthySlotDiffPlays the number of slots we would consider a discovery node unhealthy
|
|
1702
|
-
* @param unhealthyBlockDiff the number of missed blocks after which we would consider a discovery node unhealthy
|
|
1703
|
-
*/
|
|
1704
|
-
declare class DiscoveryProvider {
|
|
1705
|
-
whitelist: Set<string> | undefined;
|
|
1706
|
-
blacklist: Set<string> | undefined;
|
|
1707
|
-
userStateManager: UserStateManager;
|
|
1708
|
-
ethContracts: EthContracts;
|
|
1709
|
-
web3Manager: Web3Manager | undefined;
|
|
1710
|
-
unhealthyBlockDiff: number;
|
|
1711
|
-
serviceSelector: DiscoveryProviderSelection;
|
|
1712
|
-
selectionRequestTimeout: number;
|
|
1713
|
-
selectionRequestRetries: number;
|
|
1714
|
-
unhealthySlotDiffPlays: number | undefined;
|
|
1715
|
-
request404Count: number;
|
|
1716
|
-
maxRequestsForTrue404: number;
|
|
1717
|
-
monitoringCallbacks: DiscoveryProviderSelection['monitoringCallbacks'] | undefined;
|
|
1718
|
-
discoveryProviderEndpoint: string | undefined;
|
|
1719
|
-
constructor({ whitelist, blacklist, userStateManager, ethContracts, web3Manager, reselectTimeout, selectionCallback, monitoringCallbacks, selectionRequestTimeout, selectionRequestRetries, unhealthySlotDiffPlays, unhealthyBlockDiff }: DiscoveryProviderConfig);
|
|
1720
|
-
init(): Promise<void>;
|
|
1721
|
-
setEndpoint(endpoint: string): void;
|
|
1722
|
-
setUnhealthyBlockDiff(updatedBlockDiff?: number): void;
|
|
1723
|
-
setUnhealthySlotDiffPlays(updatedDiff: number): void;
|
|
1724
|
-
/**
|
|
1725
|
-
* Get users with all relevant user data
|
|
1726
|
-
* can be filtered by providing an integer array of ids
|
|
1727
|
-
* @param limit
|
|
1728
|
-
* @param offset
|
|
1729
|
-
* @param idsArray
|
|
1730
|
-
* @param walletAddress
|
|
1731
|
-
* @param handle
|
|
1732
|
-
* @param isCreator null returns all users, true returns creators only, false returns users only
|
|
1733
|
-
* @returns {Object} {Array of User metadata Objects}
|
|
1734
|
-
* additional metadata fields on user objects:
|
|
1735
|
-
* {Integer} track_count - track count for given user
|
|
1736
|
-
* {Integer} playlist_count - playlist count for given user
|
|
1737
|
-
* {Integer} album_count - album count for given user
|
|
1738
|
-
* {Integer} follower_count - follower count for given user
|
|
1739
|
-
* {Integer} followee_count - followee count for given user
|
|
1740
|
-
* {Integer} repost_count - repost count for given user
|
|
1741
|
-
* {Integer} track_blocknumber - blocknumber of latest track for user
|
|
1742
|
-
* {Boolean} does_current_user_follow - does current user follow given user
|
|
1743
|
-
* {Array} followee_follows - followees of current user that follow given user
|
|
1744
|
-
* @example
|
|
1745
|
-
* await getUsers()
|
|
1746
|
-
* await getUsers(100, 0, [3,2,6]) - Invalid user ids will not be accepted
|
|
1747
|
-
*/
|
|
1748
|
-
getUsers(limit?: number, offset?: number, idsArray?: string[], walletAddress?: string, handle?: string, isCreator?: null, minBlockNumber?: number): Promise<unknown>;
|
|
1749
|
-
/**
|
|
1750
|
-
* get tracks with all relevant track data
|
|
1751
|
-
* can be filtered by providing an integer array of ids
|
|
1752
|
-
* @param limit
|
|
1753
|
-
* @param offset
|
|
1754
|
-
* @param idsArray
|
|
1755
|
-
* @param targetUserId the owner of the tracks being queried
|
|
1756
|
-
* @param sort a string of form eg. blocknumber:asc,timestamp:desc describing a sort path
|
|
1757
|
-
* @param minBlockNumber The min block number
|
|
1758
|
-
* @param filterDeleted If set to true, filters the deleted tracks
|
|
1759
|
-
* @returns {Object} {Array of track metadata Objects}
|
|
1760
|
-
* additional metadata fields on track objects:
|
|
1761
|
-
* {Integer} repost_count - repost count for given track
|
|
1762
|
-
* {Integer} save_count - save count for given track
|
|
1763
|
-
* {Array} followee_reposts - followees of current user that have reposted given track
|
|
1764
|
-
* {Boolean} has_current_user_reposted - has current user reposted given track
|
|
1765
|
-
* {Boolean} has_current_user_saved - has current user saved given track
|
|
1766
|
-
* @example
|
|
1767
|
-
* await getTracks()
|
|
1768
|
-
* await getTracks(100, 0, [3,2,6]) - Invalid track ids will not be accepted
|
|
1769
|
-
*/
|
|
1770
|
-
getTracks(limit?: number, offset?: number, idsArray?: string[], targetUserId?: string, sort?: boolean, minBlockNumber?: number, filterDeleted?: boolean, withUsers?: boolean): Promise<unknown>;
|
|
1771
|
-
/**
|
|
1772
|
-
* Gets a particular track by its creator's handle and the track's URL slug
|
|
1773
|
-
* @param handle the handle of the owner of the track
|
|
1774
|
-
* @param slug the URL slug of the track, generally the title urlized
|
|
1775
|
-
* @returns {Object} the requested track's metadata
|
|
1776
|
-
*/
|
|
1777
|
-
getTracksByHandleAndSlug(handle: string, slug: string): Promise<unknown>;
|
|
1778
|
-
/**
|
|
1779
|
-
* @typedef {Object} getTracksIdentifier
|
|
1780
|
-
* @property {string} handle
|
|
1781
|
-
* @property {number} id
|
|
1782
|
-
* @property {string} url_title
|
|
1783
|
-
*/
|
|
1784
|
-
/**
|
|
1785
|
-
* gets all tracks matching identifiers, including unlisted.
|
|
1786
|
-
*
|
|
1787
|
-
* @param identifiers
|
|
1788
|
-
* @returns {(Array)} track
|
|
1789
|
-
*/
|
|
1790
|
-
getTracksIncludingUnlisted(identifiers: string[], withUsers?: boolean): Promise<unknown>;
|
|
1791
|
-
/**
|
|
1792
|
-
* Gets random tracks from trending tracks for a given genre.
|
|
1793
|
-
* If genre not given, will return trending tracks across all genres.
|
|
1794
|
-
* Excludes specified track ids.
|
|
1795
|
-
*
|
|
1796
|
-
* @param genre
|
|
1797
|
-
* @param limit
|
|
1798
|
-
* @param exclusionList
|
|
1799
|
-
* @param time
|
|
1800
|
-
* @returns {(Array)} track
|
|
1801
|
-
*/
|
|
1802
|
-
getRandomTracks(genre: string, limit: number, exclusionList: number[], time: string): Promise<unknown>;
|
|
1803
|
-
/**
|
|
1804
|
-
* Gets all stems for a given trackId as an array of tracks.
|
|
1805
|
-
* @param trackId
|
|
1806
|
-
* @returns {(Array)} track
|
|
1807
|
-
*/
|
|
1808
|
-
getStemsForTrack(trackId: number): Promise<unknown>;
|
|
1809
|
-
/**
|
|
1810
|
-
* Gets all the remixes of a given trackId as an array of tracks.
|
|
1811
|
-
* @param trackId
|
|
1812
|
-
* @param limit
|
|
1813
|
-
* @param offset
|
|
1814
|
-
* @returns {(Array)} track
|
|
1815
|
-
*/
|
|
1816
|
-
getRemixesOfTrack(trackId: number, limit?: number, offset?: number): Promise<unknown>;
|
|
1817
|
-
/**
|
|
1818
|
-
* Gets the remix parents of a given trackId as an array of tracks.
|
|
1819
|
-
* @param limit
|
|
1820
|
-
* @param offset
|
|
1821
|
-
* @returns {(Array)} track
|
|
1822
|
-
*/
|
|
1823
|
-
getRemixTrackParents(trackId: number, limit?: number, offset?: number): Promise<unknown>;
|
|
1824
|
-
/**
|
|
1825
|
-
* Gets tracks trending on Audius.
|
|
1826
|
-
* @param genre
|
|
1827
|
-
* @param timeFrame one of day, week, month, or year
|
|
1828
|
-
* @param idsArray track ids
|
|
1829
|
-
* @param limit
|
|
1830
|
-
* @param offset
|
|
1831
|
-
*/
|
|
1832
|
-
getTrendingTracks(genre?: string, timeFrame?: string, idsArray?: number[], limit?: number, offset?: number, withUsers?: boolean): Promise<{
|
|
1833
|
-
listenCounts: Array<{
|
|
1834
|
-
trackId: number;
|
|
1835
|
-
listens: number;
|
|
1836
|
-
}>;
|
|
1837
|
-
} | null | undefined>;
|
|
1838
|
-
/**
|
|
1839
|
-
* get full playlist objects, including tracks, for passed in array of playlistId
|
|
1840
|
-
* @returns {Array} array of playlist objects
|
|
1841
|
-
* additional metadata fields on playlist objects:
|
|
1842
|
-
* {Integer} repost_count - repost count for given playlist
|
|
1843
|
-
* {Integer} save_count - save count for given playlist
|
|
1844
|
-
* {Boolean} has_current_user_reposted - has current user reposted given playlist
|
|
1845
|
-
* {Array} followee_reposts - followees of current user that have reposted given playlist
|
|
1846
|
-
* {Boolean} has_current_user_reposted - has current user reposted given playlist
|
|
1847
|
-
* {Boolean} has_current_user_saved - has current user saved given playlist
|
|
1848
|
-
*/
|
|
1849
|
-
getPlaylists(limit?: number, offset?: number, idsArray?: null, targetUserId?: null, withUsers?: boolean): Promise<unknown>;
|
|
1850
|
-
/**
|
|
1851
|
-
* Return social feed for current user
|
|
1852
|
-
* @param filter - filter by "all", "original", or "repost"
|
|
1853
|
-
* @param limit - max # of items to return
|
|
1854
|
-
* @param offset - offset into list to return from (for pagination)
|
|
1855
|
-
* @returns {Object} {Array of track and playlist metadata objects}
|
|
1856
|
-
* additional metadata fields on track and playlist objects:
|
|
1857
|
-
* {String} activity_timestamp - timestamp of requested user's repost for given track or playlist,
|
|
1858
|
-
* used for sorting feed
|
|
1859
|
-
* {Integer} repost_count - repost count of given track/playlist
|
|
1860
|
-
* {Integer} save_count - save count of given track/playlist
|
|
1861
|
-
* {Boolean} has_current_user_reposted - has current user reposted given track/playlist
|
|
1862
|
-
* {Array} followee_reposts - followees of current user that have reposted given track/playlist
|
|
1863
|
-
*/
|
|
1864
|
-
getSocialFeed(filter: string, limit?: number, offset?: number, withUsers?: boolean, tracksOnly?: boolean): Promise<unknown>;
|
|
1865
|
-
/**
|
|
1866
|
-
* Return repost feed for requested user
|
|
1867
|
-
* @param userId - requested user id
|
|
1868
|
-
* @param limit - max # of items to return (for pagination)
|
|
1869
|
-
* @param offset - offset into list to return from (for pagination)
|
|
1870
|
-
* @returns {Object} {Array of track and playlist metadata objects}
|
|
1871
|
-
* additional metadata fields on track and playlist objects:
|
|
1872
|
-
* {String} activity_timestamp - timestamp of requested user's repost for given track or playlist,
|
|
1873
|
-
* used for sorting feed
|
|
1874
|
-
* {Integer} repost_count - repost count of given track/playlist
|
|
1875
|
-
* {Integer} save_count - save count of given track/playlist
|
|
1876
|
-
* {Boolean} has_current_user_reposted - has current user reposted given track/playlist
|
|
1877
|
-
* {Array} followee_reposts - followees of current user that have reposted given track/playlist
|
|
1878
|
-
*/
|
|
1879
|
-
getUserRepostFeed(userId: number, limit?: number, offset?: number, withUsers?: boolean): Promise<unknown>;
|
|
1880
|
-
/**
|
|
1881
|
-
* get intersection of users that follow followeeUserId and users that are followed by followerUserId
|
|
1882
|
-
* @param followeeUserId user that is followed
|
|
1883
|
-
* @param followerUserId user that follows
|
|
1884
|
-
* @example
|
|
1885
|
-
* getFollowIntersectionUsers(100, 0, 1, 1) - IDs must be valid
|
|
1886
|
-
*/
|
|
1887
|
-
getFollowIntersectionUsers(limit: number | undefined, offset: number | undefined, followeeUserId: number, followerUserId: number): Promise<unknown>;
|
|
1888
|
-
/**
|
|
1889
|
-
* get intersection of users that have reposted repostTrackId and users that are followed by followerUserId
|
|
1890
|
-
* followee = user that is followed; follower = user that follows
|
|
1891
|
-
* @param repostTrackId track that is reposted
|
|
1892
|
-
* @param followerUserId user that reposted track
|
|
1893
|
-
* @example
|
|
1894
|
-
* getTrackRepostIntersectionUsers(100, 0, 1, 1) - IDs must be valid
|
|
1895
|
-
*/
|
|
1896
|
-
getTrackRepostIntersectionUsers(limit: number | undefined, offset: number | undefined, repostTrackId: number, followerUserId: number): Promise<unknown>;
|
|
1897
|
-
/**
|
|
1898
|
-
* get intersection of users that have reposted repostPlaylistId and users that are followed by followerUserId
|
|
1899
|
-
* followee = user that is followed; follower = user that follows
|
|
1900
|
-
* @param repostPlaylistId playlist that is reposted
|
|
1901
|
-
* @param followerUserId user that reposted track
|
|
1902
|
-
* @example
|
|
1903
|
-
* getPlaylistRepostIntersectionUsers(100, 0, 1, 1) - IDs must be valid
|
|
1904
|
-
*/
|
|
1905
|
-
getPlaylistRepostIntersectionUsers(limit: number | undefined, offset: number | undefined, repostPlaylistId: number, followerUserId: number): Promise<unknown>;
|
|
1906
|
-
/**
|
|
1907
|
-
* get users that follow followeeUserId, sorted by follower count descending
|
|
1908
|
-
* @param followeeUserId user that is followed
|
|
1909
|
-
* @return {Array} array of user objects with standard user metadata
|
|
1910
|
-
*/
|
|
1911
|
-
getFollowersForUser(limit: number | undefined, offset: number | undefined, followeeUserId: number): Promise<unknown>;
|
|
1912
|
-
/**
|
|
1913
|
-
* get users that are followed by followerUserId, sorted by follower count descending
|
|
1914
|
-
* @param followerUserId user - i am the one who follows
|
|
1915
|
-
* @return {Array} array of user objects with standard user metadata
|
|
1916
|
-
*/
|
|
1917
|
-
getFolloweesForUser(limit: number | undefined, offset: number | undefined, followerUserId: number): Promise<unknown>;
|
|
1918
|
-
/**
|
|
1919
|
-
* get users that reposted repostTrackId, sorted by follower count descending
|
|
1920
|
-
* @param repostTrackId
|
|
1921
|
-
* @return {Array} array of user objects
|
|
1922
|
-
* additional metadata fields on user objects:
|
|
1923
|
-
* {Integer} follower_count - follower count of given user
|
|
1924
|
-
* @example
|
|
1925
|
-
* getRepostersForTrack(100, 0, 1) - ID must be valid
|
|
1926
|
-
*/
|
|
1927
|
-
getRepostersForTrack(limit: number | undefined, offset: number | undefined, repostTrackId: number): Promise<unknown>;
|
|
1928
|
-
/**
|
|
1929
|
-
* get users that reposted repostPlaylistId, sorted by follower count descending
|
|
1930
|
-
* @param repostPlaylistId
|
|
1931
|
-
* @return {Array} array of user objects
|
|
1932
|
-
* additional metadata fields on user objects:
|
|
1933
|
-
* {Integer} follower_count - follower count of given user
|
|
1934
|
-
* @example
|
|
1935
|
-
* getRepostersForPlaylist(100, 0, 1) - ID must be valid
|
|
1936
|
-
*/
|
|
1937
|
-
getRepostersForPlaylist(limit: number | undefined, offset: number | undefined, repostPlaylistId: number): Promise<unknown>;
|
|
1938
|
-
/**
|
|
1939
|
-
* get users that saved saveTrackId, sorted by follower count descending
|
|
1940
|
-
* @param saveTrackId
|
|
1941
|
-
* @return {Array} array of user objects
|
|
1942
|
-
* additional metadata fields on user objects:
|
|
1943
|
-
* {Integer} follower_count - follower count of given user
|
|
1944
|
-
* @example
|
|
1945
|
-
* getSaversForTrack(100, 0, 1) - ID must be valid
|
|
1946
|
-
*/
|
|
1947
|
-
getSaversForTrack(limit: number | undefined, offset: number | undefined, saveTrackId: number): Promise<unknown>;
|
|
1948
|
-
/**
|
|
1949
|
-
* get users that saved savePlaylistId, sorted by follower count descending
|
|
1950
|
-
* @param savePlaylistId
|
|
1951
|
-
* @return {Array} array of user objects
|
|
1952
|
-
* additional metadata fields on user objects:
|
|
1953
|
-
* {Integer} follower_count - follower count of given user
|
|
1954
|
-
* @example
|
|
1955
|
-
* getSaversForPlaylist(100, 0, 1) - ID must be valid
|
|
1956
|
-
*/
|
|
1957
|
-
getSaversForPlaylist(limit: number | undefined, offset: number | undefined, savePlaylistId: number): Promise<unknown>;
|
|
1958
|
-
/**
|
|
1959
|
-
* get whether a JWT given by Audius Oauth popup is valid
|
|
1960
|
-
* @param token - JWT
|
|
1961
|
-
* @return {UserProfile | false} profile info of user attached to JWT payload if the JWT is valid, else false
|
|
1962
|
-
*/
|
|
1963
|
-
verifyToken(token: string): Promise<UserProfile | false>;
|
|
1964
|
-
/**
|
|
1965
|
-
* Perform a full-text search. Returns tracks, users, playlists, albums
|
|
1966
|
-
* with optional user-specific results for each
|
|
1967
|
-
* - user, track, and playlist objects have all same data as returned from standalone endpoints
|
|
1968
|
-
* @param text search query
|
|
1969
|
-
* @param kind 'tracks', 'users', 'playlists', 'albums', 'all'
|
|
1970
|
-
* @param limit max # of items to return per list (for pagination)
|
|
1971
|
-
* @param offset offset into list to return from (for pagination)
|
|
1972
|
-
*/
|
|
1973
|
-
searchFull(text: string, kind: string, limit?: number, offset?: number): Promise<unknown>;
|
|
1974
|
-
/**
|
|
1975
|
-
* Perform a lighter-weight full-text search. Returns tracks, users, playlists, albums
|
|
1976
|
-
* with optional user-specific results for each
|
|
1977
|
-
* - user, track, and playlist objects have core data, and track & playlist objects
|
|
1978
|
-
* also return user object
|
|
1979
|
-
* @param text search query
|
|
1980
|
-
* @param limit max # of items to return per list (for pagination)
|
|
1981
|
-
* @param offset offset into list to return from (for pagination)
|
|
1982
|
-
*/
|
|
1983
|
-
searchAutocomplete(text: string, limit?: number, offset?: number): Promise<unknown>;
|
|
1984
|
-
/**
|
|
1985
|
-
* Perform a tags-only search. Returns tracks with required tag and users
|
|
1986
|
-
* that have used a tag greater than a specified number of times
|
|
1987
|
-
* @param text search query
|
|
1988
|
-
* @param userTagCount min # of times a user must have used a tag to be returned
|
|
1989
|
-
* @param kind 'tracks', 'users', 'playlists', 'albums', 'all'
|
|
1990
|
-
* @param limit max # of items to return per list (for pagination)
|
|
1991
|
-
* @param offset offset into list to return from (for pagination)
|
|
1992
|
-
*/
|
|
1993
|
-
searchTags(text: string, userTagCount?: number, kind?: string, limit?: number, offset?: number): Promise<unknown>;
|
|
1994
|
-
/**
|
|
1995
|
-
* Return saved playlists for current user
|
|
1996
|
-
* NOTE in returned JSON, SaveType string one of track, playlist, album
|
|
1997
|
-
* @param limit - max # of items to return
|
|
1998
|
-
* @param offset - offset into list to return from (for pagination)
|
|
1999
|
-
*/
|
|
2000
|
-
getSavedPlaylists(limit?: number, offset?: number, withUsers?: boolean): Promise<unknown>;
|
|
2001
|
-
/**
|
|
2002
|
-
* Return saved albums for current user
|
|
2003
|
-
* NOTE in returned JSON, SaveType string one of track, playlist, album
|
|
2004
|
-
* @param limit - max # of items to return
|
|
2005
|
-
* @param offset - offset into list to return from (for pagination)
|
|
2006
|
-
*/
|
|
2007
|
-
getSavedAlbums(limit?: number, offset?: number, withUsers?: boolean): Promise<unknown>;
|
|
2008
|
-
/**
|
|
2009
|
-
* Return saved tracks for current user
|
|
2010
|
-
* NOTE in returned JSON, SaveType string one of track, playlist, album
|
|
2011
|
-
* @param limit - max # of items to return
|
|
2012
|
-
* @param offset - offset into list to return from (for pagination)
|
|
2013
|
-
*/
|
|
2014
|
-
getSavedTracks(limit?: number, offset?: number, withUsers?: boolean): Promise<unknown>;
|
|
2015
|
-
/**
|
|
2016
|
-
* Return user collections (saved & uploaded) along w/ users for those collections
|
|
2017
|
-
*/
|
|
2018
|
-
getUserAccount(wallet: string): Promise<CurrentUser | null | undefined>;
|
|
2019
|
-
getTopPlaylists(type: string, limit: number, mood: string, filter: string, withUsers?: boolean): Promise<unknown>;
|
|
2020
|
-
getTopFolloweeWindowed(type: string, window: string, limit: string, withUsers?: boolean): Promise<unknown>;
|
|
2021
|
-
getTopFolloweeSaves(type: string, limit: string, withUsers?: boolean): Promise<unknown>;
|
|
2022
|
-
getLatest(type: string): Promise<unknown>;
|
|
2023
|
-
getTopCreatorsByGenres(genres: string[], limit?: number, offset?: number, withUsers?: boolean): Promise<unknown>;
|
|
2024
|
-
getURSMContentNodes(ownerWallet?: string | null): Promise<unknown>;
|
|
2025
|
-
getNotifications(minBlockNumber: string, trackIds: string[], timeout: number): Promise<unknown>;
|
|
2026
|
-
getSolanaNotifications(minSlotNumber: number, timeout: number): Promise<unknown>;
|
|
2027
|
-
getTrackListenMilestones(timeout: number): Promise<unknown>;
|
|
2028
|
-
getChallengeAttestation(challengeId: string, encodedUserId: string, specifier: string, oracleAddress: string, discoveryProviderEndpoint: string): Promise<any>;
|
|
2029
|
-
getCreateSenderAttestation(senderEthAddress: string, discoveryProviderEndpoint: string): Promise<any>;
|
|
2030
|
-
getUndisbursedChallenges(limit?: number | null, offset?: number | null, completedBlockNumber?: string | null, encodedUserId?: number | null): Promise<{
|
|
2031
|
-
amount: number;
|
|
2032
|
-
}[]>;
|
|
2033
|
-
/**
|
|
2034
|
-
* Performs a single request, defined in the request, via axios, calling any
|
|
2035
|
-
* monitoring callbacks as needed.
|
|
2036
|
-
*
|
|
2037
|
-
* @param {{
|
|
2038
|
-
endpoint: string,
|
|
2039
|
-
urlParams: string,
|
|
2040
|
-
queryParams: object,
|
|
2041
|
-
method: string,
|
|
2042
|
-
headers: object,
|
|
2043
|
-
}} requestObj
|
|
2044
|
-
* @param {string} discoveryProviderEndpoint
|
|
2045
|
-
* @returns
|
|
2046
|
-
* @memberof DiscoveryProvider
|
|
2047
|
-
*/
|
|
2048
|
-
_performRequestWithMonitoring(requestObj: RequestParams, discoveryProviderEndpoint: string): Promise<any>;
|
|
2049
|
-
/**
|
|
2050
|
-
* Gets how many blocks behind a discovery node is.
|
|
2051
|
-
* If this method throws (missing data in health check response),
|
|
2052
|
-
* return an unhealthy number of blocks
|
|
2053
|
-
* @param parsedResponse health check response object
|
|
2054
|
-
* @returns a number of blocks if behind or null if not behind
|
|
2055
|
-
*/
|
|
2056
|
-
_getBlocksBehind(parsedResponse: {
|
|
2057
|
-
latest_indexed_block: number;
|
|
2058
|
-
latest_chain_block: number;
|
|
2059
|
-
}): Promise<number | null>;
|
|
2060
|
-
/**
|
|
2061
|
-
* Gets how many plays slots behind a discovery node is.
|
|
2062
|
-
* If this method throws (missing data in health check response),
|
|
2063
|
-
* return an unhealthy number of slots
|
|
2064
|
-
* @param parsedResponse health check response object
|
|
2065
|
-
* @returns a number of slots if behind or null if not behind
|
|
2066
|
-
*/
|
|
2067
|
-
_getPlaysSlotsBehind(parsedResponse: {
|
|
2068
|
-
latest_indexed_slot_plays: number;
|
|
2069
|
-
latest_chain_slot_plays: number;
|
|
2070
|
-
}): Promise<number | null>;
|
|
2071
|
-
/**
|
|
2072
|
-
* Makes a request to a discovery node, reselecting if necessary
|
|
2073
|
-
* @param {{
|
|
2074
|
-
* endpoint: string
|
|
2075
|
-
* urlParams: object
|
|
2076
|
-
* queryParams: object
|
|
2077
|
-
* method: string
|
|
2078
|
-
* headers: object
|
|
2079
|
-
* }} {
|
|
2080
|
-
* endpoint: the base route
|
|
2081
|
-
* urlParams: string of URL params to be concatenated after base route
|
|
2082
|
-
* queryParams: URL query (search) params
|
|
2083
|
-
* method: string HTTP method
|
|
2084
|
-
* }
|
|
2085
|
-
* @param retry whether to retry on failure
|
|
2086
|
-
* @param attemptedRetries number of attempted retries (stops retrying at max)
|
|
2087
|
-
*/
|
|
2088
|
-
_makeRequest<Response>(requestObj: Record<string, unknown>, retry?: boolean, attemptedRetries?: number): Promise<Response | undefined | null>;
|
|
2089
|
-
/**
|
|
2090
|
-
* Gets the healthy discovery provider endpoint used in creating the axios request later.
|
|
2091
|
-
* If the number of retries is over the max count for retires, clear the cache and reselect
|
|
2092
|
-
* another healthy discovery provider. Else, return the current discovery provider endpoint
|
|
2093
|
-
* @param attemptedRetries the number of attempted requests made to the current disc prov endpoint
|
|
2094
|
-
*/
|
|
2095
|
-
getHealthyDiscoveryProviderEndpoint(attemptedRetries: number): Promise<string>;
|
|
2096
|
-
/**
|
|
2097
|
-
* Creates the discovery provider axios request object with necessary configs
|
|
2098
|
-
* @param requestObj
|
|
2099
|
-
* @param discoveryProviderEndpoint
|
|
2100
|
-
*/
|
|
2101
|
-
_createDiscProvRequest(requestObj: RequestParams, discoveryProviderEndpoint: string): AxiosRequestConfig;
|
|
2102
|
-
}
|
|
2103
|
-
|
|
2104
|
-
declare type LoginSuccessCallback = (profile: UserProfile) => void;
|
|
2105
|
-
declare type LoginErrorCallback = (errorMessage: string) => void;
|
|
2106
|
-
declare type ButtonOptions = {
|
|
2107
|
-
size: 'small' | 'medium' | 'large';
|
|
2108
|
-
corners: 'default' | 'pill';
|
|
2109
|
-
customText: string;
|
|
2110
|
-
disableHoverGrow: boolean;
|
|
2111
|
-
fullWidth: boolean;
|
|
2112
|
-
};
|
|
2113
|
-
declare type OauthConfig = {
|
|
2114
|
-
appName?: string;
|
|
2115
|
-
discoveryProvider: DiscoveryProvider;
|
|
2116
|
-
};
|
|
2117
|
-
declare class Oauth {
|
|
2118
|
-
discoveryProvider: DiscoveryProvider;
|
|
2119
|
-
appName: string | null;
|
|
2120
|
-
activePopupWindow: null | Window;
|
|
2121
|
-
popupCheckInterval: NodeJS.Timer | null;
|
|
2122
|
-
loginSuccessCallback: LoginSuccessCallback | null;
|
|
2123
|
-
loginErrorCallback: LoginErrorCallback | null;
|
|
2124
|
-
constructor({ discoveryProvider, appName }: OauthConfig);
|
|
2125
|
-
init(successCallback: LoginSuccessCallback, errorCallback?: LoginErrorCallback): void;
|
|
2126
|
-
login(): void;
|
|
2127
|
-
renderButton(element: HTMLElement, options?: ButtonOptions): void;
|
|
2128
|
-
verifyToken(token: string): Promise<false | UserProfile>;
|
|
2129
|
-
_surfaceError(errorMessage: string): void;
|
|
2130
|
-
_clearPopupCheckInterval(): void;
|
|
2131
|
-
_receiveMessage(event: MessageEvent): Promise<void>;
|
|
2132
|
-
}
|
|
2133
|
-
|
|
2134
|
-
declare type Web3Config = {
|
|
2135
|
-
providers: string[];
|
|
2136
|
-
};
|
|
2137
|
-
declare type SdkConfig = {
|
|
2138
|
-
appName: string;
|
|
2139
|
-
discoveryNodeConfig?: DiscoveryProviderConfig;
|
|
2140
|
-
ethContractsConfig?: EthContractsConfig;
|
|
2141
|
-
ethWeb3Config?: EthWeb3Config;
|
|
2142
|
-
identityServiceConfig?: IdentityService;
|
|
2143
|
-
web3Config?: Web3Config;
|
|
2144
|
-
};
|
|
2145
|
-
/**
|
|
2146
|
-
* The Audius SDK
|
|
2147
|
-
*/
|
|
2148
|
-
declare const sdk: (config?: SdkConfig | undefined) => Promise<{
|
|
2149
|
-
oauth: Oauth | undefined;
|
|
2150
|
-
discoveryNode: DiscoveryProvider;
|
|
2151
|
-
}>;
|
|
2152
|
-
|
|
2153
|
-
declare type SchemaConfig = {
|
|
2154
|
-
schema: {
|
|
2155
|
-
definitions: Record<string, {
|
|
2156
|
-
required: string[];
|
|
2157
|
-
properties: Record<string, {
|
|
2158
|
-
default: unknown;
|
|
2159
|
-
}>;
|
|
2160
|
-
} | {}>;
|
|
2161
|
-
};
|
|
2162
|
-
baseDefinition: string;
|
|
2163
|
-
validate?: (obj: Record<string, unknown>) => void;
|
|
2164
|
-
};
|
|
2165
|
-
declare type Schemas = {
|
|
2166
|
-
TrackSchema: SchemaConfig;
|
|
2167
|
-
UserSchema: SchemaConfig;
|
|
2168
|
-
};
|
|
2169
|
-
|
|
2170
430
|
declare type Metadata = {
|
|
2171
431
|
track_segments: unknown;
|
|
2172
432
|
download?: {
|
|
@@ -2426,6 +686,4 @@ declare class SanityChecks {
|
|
|
2426
686
|
async run(creatorNodeWhitelist: string[] | null): Promise<void>
|
|
2427
687
|
}
|
|
2428
688
|
|
|
2429
|
-
|
|
2430
|
-
|
|
2431
|
-
export { CreatorNode, SanityChecks, Utils, libs, sdk };
|
|
689
|
+
export { CreatorNode, SanityChecks, Utils };
|