@0xsequence/metadata 1.9.37 → 1.10.1

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.
@@ -1,6 +1,6 @@
1
1
  export declare const WebRPCVersion = "v1";
2
2
  export declare const WebRPCSchemaVersion = "v0.4.0";
3
- export declare const WebRPCSchemaHash = "594e38ba9f35eba08aac88087660d5f424b6dbda";
3
+ export declare const WebRPCSchemaHash = "16b30ae85e42fc4c25342f7c43e04d7070597f21";
4
4
  export declare enum ContractType {
5
5
  UNKNOWN = "UNKNOWN",
6
6
  ERC20 = "ERC20",
@@ -226,11 +226,8 @@ export interface Metadata {
226
226
  searchContractInfo(args: SearchContractInfoArgs, headers?: object, signal?: AbortSignal): Promise<SearchContractInfoReturn>;
227
227
  searchContractInfoBatch(args: SearchContractInfoBatchArgs, headers?: object, signal?: AbortSignal): Promise<SearchContractInfoBatchReturn>;
228
228
  searchMetadata(args: SearchMetadataArgs, headers?: object, signal?: AbortSignal): Promise<SearchMetadataReturn>;
229
- addContractsToTokenDirectory(args: AddContractsToTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<AddContractsToTokenDirectoryReturn>;
230
- removeContractsFromTokenDirectory(args: RemoveContractsFromTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<RemoveContractsFromTokenDirectoryReturn>;
231
- modifyFeatureIndex(args: ModifyFeatureIndexArgs, headers?: object, signal?: AbortSignal): Promise<ModifyFeatureIndexReturn>;
232
- getFeatureIndex(args: GetFeatureIndexArgs, headers?: object, signal?: AbortSignal): Promise<GetFeatureIndexReturn>;
233
- listTokenDirectory(args: ListTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<ListTokenDirectoryReturn>;
229
+ searchTokens(args: SearchTokensArgs, headers?: object, signal?: AbortSignal): Promise<SearchTokensReturn>;
230
+ searchContracts(args: SearchContractsArgs, headers?: object, signal?: AbortSignal): Promise<SearchContractsReturn>;
234
231
  getNiftyswapTokenQuantity(args: GetNiftyswapTokenQuantityArgs, headers?: object, signal?: AbortSignal): Promise<GetNiftyswapTokenQuantityReturn>;
235
232
  getNiftyswapUnitPrices(args: GetNiftyswapUnitPricesArgs, headers?: object, signal?: AbortSignal): Promise<GetNiftyswapUnitPricesReturn>;
236
233
  getNiftyswapUnitPricesWithQuantities(args: GetNiftyswapUnitPricesWithQuantitiesArgs, headers?: object, signal?: AbortSignal): Promise<GetNiftyswapUnitPricesWithQuantitiesReturn>;
@@ -238,6 +235,12 @@ export interface Metadata {
238
235
  removeContractFromMintMonitor(args: RemoveContractFromMintMonitorArgs, headers?: object, signal?: AbortSignal): Promise<RemoveContractFromMintMonitorReturn>;
239
236
  mintMonitorJobStatus(args: MintMonitorJobStatusArgs, headers?: object, signal?: AbortSignal): Promise<MintMonitorJobStatusReturn>;
240
237
  mintMonitorTriggerJob(args: MintMonitorTriggerJobArgs, headers?: object, signal?: AbortSignal): Promise<MintMonitorTriggerJobReturn>;
238
+ syncContractTokens(args: SyncContractTokensArgs, headers?: object, signal?: AbortSignal): Promise<SyncContractTokensReturn>;
239
+ abortContractSync(args: AbortContractSyncArgs, headers?: object, signal?: AbortSignal): Promise<AbortContractSyncReturn>;
240
+ contractSyncJobStatus(args: ContractSyncJobStatusArgs, headers?: object, signal?: AbortSignal): Promise<ContractSyncJobStatusReturn>;
241
+ directoryGetNetworks(args: DirectoryGetNetworksArgs, headers?: object, signal?: AbortSignal): Promise<DirectoryGetNetworksReturn>;
242
+ directoryGetCollections(args: DirectoryGetCollectionsArgs, headers?: object, signal?: AbortSignal): Promise<DirectoryGetCollectionsReturn>;
243
+ directorySearchCollections(args: DirectorySearchCollectionsArgs, headers?: object, signal?: AbortSignal): Promise<DirectorySearchCollectionsReturn>;
241
244
  }
242
245
  export interface PingArgs {
243
246
  }
@@ -382,41 +385,24 @@ export interface SearchMetadataReturn {
382
385
  tokenMetadata: Array<TokenMetadata>;
383
386
  contractInfo: Array<ContractInfo>;
384
387
  }
385
- export interface AddContractsToTokenDirectoryArgs {
386
- contracts: Array<ContractInfo>;
387
- }
388
- export interface AddContractsToTokenDirectoryReturn {
389
- ok: boolean;
390
- }
391
- export interface RemoveContractsFromTokenDirectoryArgs {
392
- chainHandle: string;
393
- contracts: Array<string>;
394
- }
395
- export interface RemoveContractsFromTokenDirectoryReturn {
396
- ok: boolean;
397
- }
398
- export interface ModifyFeatureIndexArgs {
399
- chainHandle: string;
400
- contractAddress: string;
401
- featured: number;
402
- }
403
- export interface ModifyFeatureIndexReturn {
404
- ok: boolean;
405
- }
406
- export interface GetFeatureIndexArgs {
407
- chainHandle: string;
408
- contractAddress: string;
388
+ export interface SearchTokensArgs {
389
+ q: string;
390
+ chainID?: string;
391
+ page?: Page;
409
392
  }
410
- export interface GetFeatureIndexReturn {
411
- featured: number;
393
+ export interface SearchTokensReturn {
394
+ tokenMetadata: Array<TokenMetadata>;
395
+ nextPage: Page;
412
396
  }
413
- export interface ListTokenDirectoryArgs {
397
+ export interface SearchContractsArgs {
398
+ q: string;
414
399
  chainID?: string;
400
+ types?: Array<ContractType>;
415
401
  page?: Page;
416
402
  }
417
- export interface ListTokenDirectoryReturn {
418
- page: Page;
419
- contracts: Array<ContractInfo>;
403
+ export interface SearchContractsReturn {
404
+ contractInfo: Array<ContractInfo>;
405
+ nextPage: Page;
420
406
  }
421
407
  export interface GetNiftyswapTokenQuantityArgs {
422
408
  chainID: string;
@@ -478,6 +464,54 @@ export interface MintMonitorTriggerJobArgs {
478
464
  export interface MintMonitorTriggerJobReturn {
479
465
  ok: boolean;
480
466
  }
467
+ export interface SyncContractTokensArgs {
468
+ chainID: string;
469
+ contractAddress: string;
470
+ }
471
+ export interface SyncContractTokensReturn {
472
+ taskID: number;
473
+ }
474
+ export interface AbortContractSyncArgs {
475
+ taskID: number;
476
+ }
477
+ export interface AbortContractSyncReturn {
478
+ ok: boolean;
479
+ }
480
+ export interface ContractSyncJobStatusArgs {
481
+ taskID: number;
482
+ }
483
+ export interface ContractSyncJobStatusReturn {
484
+ refreshTask: Task;
485
+ syncTask: Task;
486
+ }
487
+ export interface DirectoryGetNetworksArgs {
488
+ includeTestnets?: boolean;
489
+ onlyFeatured?: boolean;
490
+ }
491
+ export interface DirectoryGetNetworksReturn {
492
+ networks: Array<number>;
493
+ }
494
+ export interface DirectoryGetCollectionsArgs {
495
+ chainId?: number;
496
+ includeTestnets?: boolean;
497
+ onlyFeatured?: boolean;
498
+ page?: Page;
499
+ }
500
+ export interface DirectoryGetCollectionsReturn {
501
+ collections: Array<ContractInfo>;
502
+ page: Page;
503
+ }
504
+ export interface DirectorySearchCollectionsArgs {
505
+ query: string;
506
+ chainId?: number;
507
+ includeTestnets?: boolean;
508
+ onlyFeatured?: boolean;
509
+ page?: Page;
510
+ }
511
+ export interface DirectorySearchCollectionsReturn {
512
+ collections: Array<ContractInfo>;
513
+ page: Page;
514
+ }
481
515
  export interface Collections {
482
516
  createCollection(args: CreateCollectionArgs, headers?: object, signal?: AbortSignal): Promise<CreateCollectionReturn>;
483
517
  getCollection(args: GetCollectionArgs, headers?: object, signal?: AbortSignal): Promise<GetCollectionReturn>;
@@ -554,6 +588,7 @@ export interface AddDeployedCollectionToTokenDirectoryArgs {
554
588
  chainHandle: string;
555
589
  contractAddress: string;
556
590
  contractType: ContractType;
591
+ featured: number;
557
592
  }
558
593
  export interface AddDeployedCollectionToTokenDirectoryReturn {
559
594
  ok: boolean;
@@ -632,6 +667,50 @@ export interface DeleteAssetArgs {
632
667
  export interface DeleteAssetReturn {
633
668
  status: boolean;
634
669
  }
670
+ export interface Admin {
671
+ addContractsToTokenDirectory(args: AddContractsToTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<AddContractsToTokenDirectoryReturn>;
672
+ removeContractsFromTokenDirectory(args: RemoveContractsFromTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<RemoveContractsFromTokenDirectoryReturn>;
673
+ modifyFeatureIndex(args: ModifyFeatureIndexArgs, headers?: object, signal?: AbortSignal): Promise<ModifyFeatureIndexReturn>;
674
+ getFeatureIndex(args: GetFeatureIndexArgs, headers?: object, signal?: AbortSignal): Promise<GetFeatureIndexReturn>;
675
+ listTokenDirectory(args: ListTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<ListTokenDirectoryReturn>;
676
+ }
677
+ export interface AddContractsToTokenDirectoryArgs {
678
+ contracts: Array<ContractInfo>;
679
+ featureIndexes: Array<number>;
680
+ }
681
+ export interface AddContractsToTokenDirectoryReturn {
682
+ ok: boolean;
683
+ }
684
+ export interface RemoveContractsFromTokenDirectoryArgs {
685
+ chainHandle: string;
686
+ contracts: Array<string>;
687
+ }
688
+ export interface RemoveContractsFromTokenDirectoryReturn {
689
+ ok: boolean;
690
+ }
691
+ export interface ModifyFeatureIndexArgs {
692
+ chainHandle: string;
693
+ contractAddress: string;
694
+ featured: number;
695
+ }
696
+ export interface ModifyFeatureIndexReturn {
697
+ ok: boolean;
698
+ }
699
+ export interface GetFeatureIndexArgs {
700
+ chainHandle: string;
701
+ contractAddress: string;
702
+ }
703
+ export interface GetFeatureIndexReturn {
704
+ featured: number;
705
+ }
706
+ export interface ListTokenDirectoryArgs {
707
+ chainID?: string;
708
+ page?: Page;
709
+ }
710
+ export interface ListTokenDirectoryReturn {
711
+ page: Page;
712
+ contracts: Array<ContractInfo>;
713
+ }
635
714
  export declare class Metadata implements Metadata {
636
715
  protected hostname: string;
637
716
  protected fetch: Fetch;
@@ -656,11 +735,8 @@ export declare class Metadata implements Metadata {
656
735
  searchContractInfo: (args: SearchContractInfoArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<SearchContractInfoReturn>;
657
736
  searchContractInfoBatch: (args: SearchContractInfoBatchArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<SearchContractInfoBatchReturn>;
658
737
  searchMetadata: (args: SearchMetadataArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<SearchMetadataReturn>;
659
- addContractsToTokenDirectory: (args: AddContractsToTokenDirectoryArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<AddContractsToTokenDirectoryReturn>;
660
- removeContractsFromTokenDirectory: (args: RemoveContractsFromTokenDirectoryArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<RemoveContractsFromTokenDirectoryReturn>;
661
- modifyFeatureIndex: (args: ModifyFeatureIndexArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<ModifyFeatureIndexReturn>;
662
- getFeatureIndex: (args: GetFeatureIndexArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<GetFeatureIndexReturn>;
663
- listTokenDirectory: (args: ListTokenDirectoryArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<ListTokenDirectoryReturn>;
738
+ searchTokens: (args: SearchTokensArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<SearchTokensReturn>;
739
+ searchContracts: (args: SearchContractsArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<SearchContractsReturn>;
664
740
  getNiftyswapTokenQuantity: (args: GetNiftyswapTokenQuantityArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<GetNiftyswapTokenQuantityReturn>;
665
741
  getNiftyswapUnitPrices: (args: GetNiftyswapUnitPricesArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<GetNiftyswapUnitPricesReturn>;
666
742
  getNiftyswapUnitPricesWithQuantities: (args: GetNiftyswapUnitPricesWithQuantitiesArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<GetNiftyswapUnitPricesWithQuantitiesReturn>;
@@ -668,6 +744,12 @@ export declare class Metadata implements Metadata {
668
744
  removeContractFromMintMonitor: (args: RemoveContractFromMintMonitorArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<RemoveContractFromMintMonitorReturn>;
669
745
  mintMonitorJobStatus: (args: MintMonitorJobStatusArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<MintMonitorJobStatusReturn>;
670
746
  mintMonitorTriggerJob: (args: MintMonitorTriggerJobArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<MintMonitorTriggerJobReturn>;
747
+ syncContractTokens: (args: SyncContractTokensArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<SyncContractTokensReturn>;
748
+ abortContractSync: (args: AbortContractSyncArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<AbortContractSyncReturn>;
749
+ contractSyncJobStatus: (args: ContractSyncJobStatusArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<ContractSyncJobStatusReturn>;
750
+ directoryGetNetworks: (args: DirectoryGetNetworksArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<DirectoryGetNetworksReturn>;
751
+ directoryGetCollections: (args: DirectoryGetCollectionsArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<DirectoryGetCollectionsReturn>;
752
+ directorySearchCollections: (args: DirectorySearchCollectionsArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<DirectorySearchCollectionsReturn>;
671
753
  }
672
754
  export declare class Collections implements Collections {
673
755
  protected hostname: string;
@@ -693,6 +775,18 @@ export declare class Collections implements Collections {
693
775
  updateAsset: (args: UpdateAssetArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<UpdateAssetReturn>;
694
776
  deleteAsset: (args: DeleteAssetArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<DeleteAssetReturn>;
695
777
  }
778
+ export declare class Admin implements Admin {
779
+ protected hostname: string;
780
+ protected fetch: Fetch;
781
+ protected path: string;
782
+ constructor(hostname: string, fetch: Fetch);
783
+ private url;
784
+ addContractsToTokenDirectory: (args: AddContractsToTokenDirectoryArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<AddContractsToTokenDirectoryReturn>;
785
+ removeContractsFromTokenDirectory: (args: RemoveContractsFromTokenDirectoryArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<RemoveContractsFromTokenDirectoryReturn>;
786
+ modifyFeatureIndex: (args: ModifyFeatureIndexArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<ModifyFeatureIndexReturn>;
787
+ getFeatureIndex: (args: GetFeatureIndexArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<GetFeatureIndexReturn>;
788
+ listTokenDirectory: (args: ListTokenDirectoryArgs, headers?: object | undefined, signal?: AbortSignal | undefined) => Promise<ListTokenDirectoryReturn>;
789
+ }
696
790
  export declare class WebrpcError extends Error {
697
791
  name: string;
698
792
  code: number;
@@ -755,6 +849,9 @@ export declare class RequestConflictError extends WebrpcError {
755
849
  export declare class FailError extends WebrpcError {
756
850
  constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
757
851
  }
852
+ export declare class GeoblockedError extends WebrpcError {
853
+ constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
854
+ }
758
855
  export declare class TimeoutError extends WebrpcError {
759
856
  constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
760
857
  }
@@ -764,6 +861,15 @@ export declare class InvalidArgumentError extends WebrpcError {
764
861
  export declare class RequiredArgumentError extends WebrpcError {
765
862
  constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
766
863
  }
864
+ export declare class QueryFailedError extends WebrpcError {
865
+ constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
866
+ }
867
+ export declare class ValidationFailedError extends WebrpcError {
868
+ constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
869
+ }
870
+ export declare class RateLimitedError extends WebrpcError {
871
+ constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
872
+ }
767
873
  export declare class NotFoundError extends WebrpcError {
768
874
  constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
769
875
  }
@@ -773,6 +879,9 @@ export declare class ProjectNotFoundError extends WebrpcError {
773
879
  export declare class ChainNotFoundError extends WebrpcError {
774
880
  constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
775
881
  }
882
+ export declare class TokenDirectoryDisabledError extends WebrpcError {
883
+ constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
884
+ }
776
885
  export declare enum errors {
777
886
  WebrpcEndpoint = "WebrpcEndpoint",
778
887
  WebrpcRequestFailed = "WebrpcRequestFailed",
@@ -791,11 +900,16 @@ export declare enum errors {
791
900
  MethodNotFound = "MethodNotFound",
792
901
  RequestConflict = "RequestConflict",
793
902
  Fail = "Fail",
903
+ Geoblocked = "Geoblocked",
794
904
  Timeout = "Timeout",
795
905
  InvalidArgument = "InvalidArgument",
796
906
  RequiredArgument = "RequiredArgument",
907
+ QueryFailed = "QueryFailed",
908
+ ValidationFailed = "ValidationFailed",
909
+ RateLimited = "RateLimited",
797
910
  NotFound = "NotFound",
798
911
  ProjectNotFound = "ProjectNotFound",
799
- ChainNotFound = "ChainNotFound"
912
+ ChainNotFound = "ChainNotFound",
913
+ TokenDirectoryDisabled = "TokenDirectoryDisabled"
800
914
  }
801
915
  export type Fetch = (input: RequestInfo, init?: RequestInit) => Promise<Response>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@0xsequence/metadata",
3
- "version": "1.9.37",
3
+ "version": "1.10.1",
4
4
  "description": "metadata sub-package for Sequence",
5
5
  "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/metadata",
6
6
  "source": "src/index.ts",