@0xsequence/metadata 2.3.2 → 2.3.4

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.
@@ -2,7 +2,7 @@ export declare const WebrpcHeader = "Webrpc";
2
2
  export declare const WebrpcHeaderValue = "webrpc@v0.25.3;gen-typescript@v0.17.0;sequence-metadata@v0.4.0";
3
3
  export declare const WebRPCVersion = "v1";
4
4
  export declare const WebRPCSchemaVersion = "v0.4.0";
5
- export declare const WebRPCSchemaHash = "eb101fbae674de87b532432e85ce7694ccee2212";
5
+ export declare const WebRPCSchemaHash = "272de60a6f0132e30ec4f29e8aa384109bc880e0";
6
6
  type WebrpcGenVersions = {
7
7
  webrpcGenVersion: string;
8
8
  codeGenName: string;
@@ -316,22 +316,6 @@ export interface Metadata {
316
316
  * Search for contract infos using a query string
317
317
  */
318
318
  searchContractsByQuery(args: SearchContractsByQueryArgs, headers?: object, signal?: AbortSignal): Promise<SearchContractsByQueryReturn>;
319
- /**
320
- * @deprecated UseFindContractInfo instead. (renamed).
321
- */
322
- searchContractInfo(args: SearchContractInfoArgs, headers?: object, signal?: AbortSignal): Promise<SearchContractInfoReturn>;
323
- /**
324
- * @deprecated Use FindContractInfoBatch instead. (renamed)
325
- */
326
- searchContractInfoBatch(args: SearchContractInfoBatchArgs, headers?: object, signal?: AbortSignal): Promise<SearchContractInfoBatchReturn>;
327
- /**
328
- * @deprecated Use SearchContractsByQuery instead. (renamed)
329
- */
330
- searchContracts(args: SearchContractsArgs, headers?: object, signal?: AbortSignal): Promise<SearchContractsReturn>;
331
- /**
332
- * @deprecated Use SearchContractsByQuery() and SearchTokenMetadataByQuery() instead.
333
- */
334
- searchMetadata(args: SearchMetadataArgs, headers?: object, signal?: AbortSignal): Promise<SearchMetadataReturn>;
335
319
  /**
336
320
  * GetTokenMetadata - fetch token metadata for a particular contract and respective tokenIDs
337
321
  */
@@ -366,25 +350,9 @@ export interface Metadata {
366
350
  */
367
351
  getTokenMetadataPropertyFilters(args: GetTokenMetadataPropertyFiltersArgs, headers?: object, signal?: AbortSignal): Promise<GetTokenMetadataPropertyFiltersReturn>;
368
352
  /**
369
- * @deprecated Use RefreshTokenMetadata instead.
370
- */
371
- refreshAllContractTokens(args: RefreshAllContractTokensArgs, headers?: object, signal?: AbortSignal): Promise<RefreshAllContractTokensReturn>;
372
- /**
373
- * @deprecated Use SearchTokenMetadataByQuery instead. (renamed)
374
- */
375
- searchTokens(args: SearchTokensArgs, headers?: object, signal?: AbortSignal): Promise<SearchTokensReturn>;
376
- /**
377
- * @deprecated Use GetTokenMetadataPropertyFilters (renamed)
378
- */
379
- tokenCollectionFilters(args: TokenCollectionFiltersArgs, headers?: object, signal?: AbortSignal): Promise<TokenCollectionFiltersReturn>;
380
- /**
381
- * @deprecated Use GetTaskStatus instead. (its the same thing)
382
- */
383
- getTokenRefreshStatus(args: GetTokenRefreshStatusArgs, headers?: object, signal?: AbortSignal): Promise<GetTokenRefreshStatusReturn>;
384
- /**
385
- * @deprecated Use SearchTokenMetadataTokenIDs instead. (renamed)
353
+ * Gets Token Directory supported networks
386
354
  */
387
- searchTokenIDs(args: SearchTokenIDsArgs, headers?: object, signal?: AbortSignal): Promise<SearchTokenIDsReturn>;
355
+ getTokenDirectoryNetworks(args: GetTokenDirectoryNetworksArgs, headers?: object, signal?: AbortSignal): Promise<GetTokenDirectoryNetworksReturn>;
388
356
  /**
389
357
  * Gets Token Directory entries
390
358
  */
@@ -393,22 +361,6 @@ export interface Metadata {
393
361
  * Search in Token Directory
394
362
  */
395
363
  searchTokenDirectory(args: SearchTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<SearchTokenDirectoryReturn>;
396
- /**
397
- * Gets Token Directory supported networks
398
- */
399
- getTokenDirectoryNetworks(args: GetTokenDirectoryNetworksArgs, headers?: object, signal?: AbortSignal): Promise<GetTokenDirectoryNetworksReturn>;
400
- /**
401
- * @deprecated Use GetTokenDirectoryNetworks instead.
402
- */
403
- directoryGetNetworks(args: DirectoryGetNetworksArgs, headers?: object, signal?: AbortSignal): Promise<DirectoryGetNetworksReturn>;
404
- /**
405
- * @deprecated Use GetTokenDirectory instead.
406
- */
407
- directoryGetCollections(args: DirectoryGetCollectionsArgs, headers?: object, signal?: AbortSignal): Promise<DirectoryGetCollectionsReturn>;
408
- /**
409
- * @deprecated Use SearchTokenDirectory instead.
410
- */
411
- directorySearchCollections(args: DirectorySearchCollectionsArgs, headers?: object, signal?: AbortSignal): Promise<DirectorySearchCollectionsReturn>;
412
364
  /**
413
365
  * Niftyswap querying data
414
366
  */
@@ -506,41 +458,6 @@ export interface SearchContractsByQueryReturn {
506
458
  contractInfo: Array<ContractInfo>;
507
459
  nextPage: Page;
508
460
  }
509
- export interface SearchContractInfoArgs {
510
- contractAddress: string;
511
- }
512
- export interface SearchContractInfoReturn {
513
- contractInfoList: Array<ContractInfo>;
514
- }
515
- export interface SearchContractInfoBatchArgs {
516
- contractAddresses: Array<string>;
517
- }
518
- export interface SearchContractInfoBatchReturn {
519
- contractInfoByChain: {
520
- [key: string]: Array<ContractInfo>;
521
- };
522
- }
523
- export interface SearchContractsArgs {
524
- q: string;
525
- chainID?: string;
526
- chainIDs?: Array<string>;
527
- types?: Array<ContractType>;
528
- page?: Page;
529
- }
530
- export interface SearchContractsReturn {
531
- contractInfo: Array<ContractInfo>;
532
- nextPage: Page;
533
- }
534
- export interface SearchMetadataArgs {
535
- filter: string;
536
- chainID?: string;
537
- types?: Array<ContractType>;
538
- excludeTokenMetadata?: boolean;
539
- }
540
- export interface SearchMetadataReturn {
541
- tokenMetadata: Array<TokenMetadata>;
542
- contractInfo: Array<ContractInfo>;
543
- }
544
461
  export interface GetTokenMetadataArgs {
545
462
  chainID: string;
546
463
  contractAddress: string;
@@ -609,67 +526,6 @@ export interface GetTokenMetadataPropertyFiltersArgs {
609
526
  export interface GetTokenMetadataPropertyFiltersReturn {
610
527
  filters: Array<PropertyFilter>;
611
528
  }
612
- export interface RefreshAllContractTokensArgs {
613
- chainHandle: string;
614
- contractAddress: string;
615
- }
616
- export interface RefreshAllContractTokensReturn {
617
- taskID?: number;
618
- retryAfter: number;
619
- }
620
- export interface SearchTokensArgs {
621
- q: string;
622
- chainID?: string;
623
- page?: Page;
624
- }
625
- export interface SearchTokensReturn {
626
- tokenMetadata: Array<TokenMetadata>;
627
- nextPage: Page;
628
- }
629
- export interface TokenCollectionFiltersArgs {
630
- chainID: string;
631
- contractAddress: string;
632
- }
633
- export interface TokenCollectionFiltersReturn {
634
- filters: Array<PropertyFilter>;
635
- }
636
- export interface GetTokenRefreshStatusArgs {
637
- taskId: number;
638
- }
639
- export interface GetTokenRefreshStatusReturn {
640
- status?: TaskStatus;
641
- }
642
- export interface SearchTokenIDsArgs {
643
- chainID: string;
644
- contractAddress: string;
645
- filter: Filter;
646
- page?: Page;
647
- }
648
- export interface SearchTokenIDsReturn {
649
- page: Page;
650
- tokenIds: Array<string>;
651
- }
652
- export interface GetTokenDirectoryArgs {
653
- chainID?: string;
654
- includeTestnets?: boolean;
655
- onlyFeatured?: boolean;
656
- page?: Page;
657
- }
658
- export interface GetTokenDirectoryReturn {
659
- collections: Array<ContractInfo>;
660
- page: Page;
661
- }
662
- export interface SearchTokenDirectoryArgs {
663
- query: string;
664
- chainID?: number;
665
- includeTestnets?: boolean;
666
- onlyFeatured?: boolean;
667
- page?: Page;
668
- }
669
- export interface SearchTokenDirectoryReturn {
670
- collections: Array<ContractInfo>;
671
- page: Page;
672
- }
673
529
  export interface GetTokenDirectoryNetworksArgs {
674
530
  includeTestnets?: boolean;
675
531
  onlyFeatured?: boolean;
@@ -678,32 +534,25 @@ export interface GetTokenDirectoryNetworksReturn {
678
534
  chainIDs: Array<number>;
679
535
  networks: Array<string>;
680
536
  }
681
- export interface DirectoryGetNetworksArgs {
682
- includeTestnets?: boolean;
683
- onlyFeatured?: boolean;
684
- }
685
- export interface DirectoryGetNetworksReturn {
686
- networks: Array<number>;
687
- }
688
- export interface DirectoryGetCollectionsArgs {
689
- chainId?: number;
537
+ export interface GetTokenDirectoryArgs {
538
+ chainID?: string;
690
539
  includeTestnets?: boolean;
691
540
  onlyFeatured?: boolean;
692
541
  page?: Page;
693
542
  }
694
- export interface DirectoryGetCollectionsReturn {
695
- collections: Array<ContractInfo>;
543
+ export interface GetTokenDirectoryReturn {
544
+ contracts: Array<ContractInfo>;
696
545
  page: Page;
697
546
  }
698
- export interface DirectorySearchCollectionsArgs {
547
+ export interface SearchTokenDirectoryArgs {
699
548
  query: string;
700
- chainId?: number;
549
+ chainID?: number;
701
550
  includeTestnets?: boolean;
702
551
  onlyFeatured?: boolean;
703
552
  page?: Page;
704
553
  }
705
- export interface DirectorySearchCollectionsReturn {
706
- collections: Array<ContractInfo>;
554
+ export interface SearchTokenDirectoryReturn {
555
+ contracts: Array<ContractInfo>;
707
556
  page: Page;
708
557
  }
709
558
  export interface GetNiftyswapTokenQuantityArgs {
@@ -943,26 +792,6 @@ export interface Admin {
943
792
  addContractToTokenDirectory(args: AddContractToTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<AddContractToTokenDirectoryReturn>;
944
793
  removeContractFromTokenDirectory(args: RemoveContractFromTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<RemoveContractFromTokenDirectoryReturn>;
945
794
  refreshTokenDirectory(headers?: object, signal?: AbortSignal): Promise<RefreshTokenDirectoryReturn>;
946
- /**
947
- * @deprecated use new admin api
948
- */
949
- addContractsToTokenDirectory(args: AddContractsToTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<AddContractsToTokenDirectoryReturn>;
950
- /**
951
- * @deprecated use new admin api
952
- */
953
- removeContractsFromTokenDirectory(args: RemoveContractsFromTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<RemoveContractsFromTokenDirectoryReturn>;
954
- /**
955
- * @deprecated use new admin api
956
- */
957
- modifyFeatureIndex(args: ModifyFeatureIndexArgs, headers?: object, signal?: AbortSignal): Promise<ModifyFeatureIndexReturn>;
958
- /**
959
- * @deprecated use new admin api
960
- */
961
- getFeatureIndex(args: GetFeatureIndexArgs, headers?: object, signal?: AbortSignal): Promise<GetFeatureIndexReturn>;
962
- /**
963
- * @deprecated use new admin api
964
- */
965
- listTokenDirectory(args: ListTokenDirectoryArgs, headers?: object, signal?: AbortSignal): Promise<ListTokenDirectoryReturn>;
966
795
  }
967
796
  export interface GetContractInfoOverrideArgs {
968
797
  chainID: string;
@@ -985,6 +814,7 @@ export interface AddContractInfoOverrideArgs {
985
814
  contractInfoOverride: ContractInfoOverride;
986
815
  }
987
816
  export interface AddContractInfoOverrideReturn {
817
+ ok: boolean;
988
818
  }
989
819
  export interface UpdateContractInfoOverrideArgs {
990
820
  chainID: string;
@@ -992,12 +822,14 @@ export interface UpdateContractInfoOverrideArgs {
992
822
  contractInfoOverride: ContractInfoOverride;
993
823
  }
994
824
  export interface UpdateContractInfoOverrideReturn {
825
+ ok: boolean;
995
826
  }
996
827
  export interface RemoveContractInfoOverrideArgs {
997
828
  chainID: string;
998
829
  contractAddress: string;
999
830
  }
1000
831
  export interface RemoveContractInfoOverrideReturn {
832
+ ok: boolean;
1001
833
  }
1002
834
  export interface IsInTokenDirectoryArgs {
1003
835
  chainID: string;
@@ -1013,63 +845,27 @@ export interface SetTokenDirectoryFeatureIndexArgs {
1013
845
  featureIndex: number;
1014
846
  }
1015
847
  export interface SetTokenDirectoryFeatureIndexReturn {
848
+ ok: boolean;
1016
849
  }
1017
850
  export interface AddContractToTokenDirectoryArgs {
1018
851
  chainID: string;
1019
852
  contractAddress: string;
1020
853
  }
1021
854
  export interface AddContractToTokenDirectoryReturn {
855
+ ok: boolean;
1022
856
  }
1023
857
  export interface RemoveContractFromTokenDirectoryArgs {
1024
858
  chainID: string;
1025
859
  contractAddress: string;
1026
860
  }
1027
861
  export interface RemoveContractFromTokenDirectoryReturn {
862
+ ok: boolean;
1028
863
  }
1029
864
  export interface RefreshTokenDirectoryArgs {
1030
865
  }
1031
866
  export interface RefreshTokenDirectoryReturn {
1032
867
  taskID: number;
1033
868
  }
1034
- export interface AddContractsToTokenDirectoryArgs {
1035
- contracts: Array<ContractInfo>;
1036
- featureIndexes: Array<number>;
1037
- }
1038
- export interface AddContractsToTokenDirectoryReturn {
1039
- ok: boolean;
1040
- }
1041
- export interface RemoveContractsFromTokenDirectoryArgs {
1042
- chainHandle: string;
1043
- contracts: Array<string>;
1044
- }
1045
- export interface RemoveContractsFromTokenDirectoryReturn {
1046
- ok: boolean;
1047
- }
1048
- export interface ModifyFeatureIndexArgs {
1049
- chainHandle: string;
1050
- contractAddress: string;
1051
- featured: number;
1052
- }
1053
- export interface ModifyFeatureIndexReturn {
1054
- ok: boolean;
1055
- }
1056
- export interface GetFeatureIndexArgs {
1057
- chainHandle: string;
1058
- contractAddress: string;
1059
- }
1060
- export interface GetFeatureIndexReturn {
1061
- featured: number;
1062
- }
1063
- export interface ListTokenDirectoryArgs {
1064
- chainID?: number;
1065
- includeTestnets?: boolean;
1066
- onlyFeatured?: boolean;
1067
- page?: Page;
1068
- }
1069
- export interface ListTokenDirectoryReturn {
1070
- page: Page;
1071
- collections: Array<ContractInfo>;
1072
- }
1073
869
  export declare class Metadata implements Metadata {
1074
870
  protected hostname: string;
1075
871
  protected fetch: Fetch;
@@ -1088,10 +884,6 @@ export declare class Metadata implements Metadata {
1088
884
  refreshContractInfo: (args: RefreshContractInfoArgs, headers?: object, signal?: AbortSignal) => Promise<RefreshContractInfoReturn>;
1089
885
  refreshContractInfoBatch: (args: RefreshContractInfoBatchArgs, headers?: object, signal?: AbortSignal) => Promise<RefreshContractInfoBatchReturn>;
1090
886
  searchContractsByQuery: (args: SearchContractsByQueryArgs, headers?: object, signal?: AbortSignal) => Promise<SearchContractsByQueryReturn>;
1091
- searchContractInfo: (args: SearchContractInfoArgs, headers?: object, signal?: AbortSignal) => Promise<SearchContractInfoReturn>;
1092
- searchContractInfoBatch: (args: SearchContractInfoBatchArgs, headers?: object, signal?: AbortSignal) => Promise<SearchContractInfoBatchReturn>;
1093
- searchContracts: (args: SearchContractsArgs, headers?: object, signal?: AbortSignal) => Promise<SearchContractsReturn>;
1094
- searchMetadata: (args: SearchMetadataArgs, headers?: object, signal?: AbortSignal) => Promise<SearchMetadataReturn>;
1095
887
  getTokenMetadata: (args: GetTokenMetadataArgs, headers?: object, signal?: AbortSignal) => Promise<GetTokenMetadataReturn>;
1096
888
  getTokenMetadataBatch: (args: GetTokenMetadataBatchArgs, headers?: object, signal?: AbortSignal) => Promise<GetTokenMetadataBatchReturn>;
1097
889
  refreshTokenMetadata: (args: RefreshTokenMetadataArgs, headers?: object, signal?: AbortSignal) => Promise<RefreshTokenMetadataReturn>;
@@ -1099,17 +891,9 @@ export declare class Metadata implements Metadata {
1099
891
  searchTokenMetadata: (args: SearchTokenMetadataArgs, headers?: object, signal?: AbortSignal) => Promise<SearchTokenMetadataReturn>;
1100
892
  searchTokenMetadataTokenIDs: (args: SearchTokenMetadataTokenIDsArgs, headers?: object, signal?: AbortSignal) => Promise<SearchTokenMetadataTokenIDsReturn>;
1101
893
  getTokenMetadataPropertyFilters: (args: GetTokenMetadataPropertyFiltersArgs, headers?: object, signal?: AbortSignal) => Promise<GetTokenMetadataPropertyFiltersReturn>;
1102
- refreshAllContractTokens: (args: RefreshAllContractTokensArgs, headers?: object, signal?: AbortSignal) => Promise<RefreshAllContractTokensReturn>;
1103
- searchTokens: (args: SearchTokensArgs, headers?: object, signal?: AbortSignal) => Promise<SearchTokensReturn>;
1104
- tokenCollectionFilters: (args: TokenCollectionFiltersArgs, headers?: object, signal?: AbortSignal) => Promise<TokenCollectionFiltersReturn>;
1105
- getTokenRefreshStatus: (args: GetTokenRefreshStatusArgs, headers?: object, signal?: AbortSignal) => Promise<GetTokenRefreshStatusReturn>;
1106
- searchTokenIDs: (args: SearchTokenIDsArgs, headers?: object, signal?: AbortSignal) => Promise<SearchTokenIDsReturn>;
894
+ getTokenDirectoryNetworks: (args: GetTokenDirectoryNetworksArgs, headers?: object, signal?: AbortSignal) => Promise<GetTokenDirectoryNetworksReturn>;
1107
895
  getTokenDirectory: (args: GetTokenDirectoryArgs, headers?: object, signal?: AbortSignal) => Promise<GetTokenDirectoryReturn>;
1108
896
  searchTokenDirectory: (args: SearchTokenDirectoryArgs, headers?: object, signal?: AbortSignal) => Promise<SearchTokenDirectoryReturn>;
1109
- getTokenDirectoryNetworks: (args: GetTokenDirectoryNetworksArgs, headers?: object, signal?: AbortSignal) => Promise<GetTokenDirectoryNetworksReturn>;
1110
- directoryGetNetworks: (args: DirectoryGetNetworksArgs, headers?: object, signal?: AbortSignal) => Promise<DirectoryGetNetworksReturn>;
1111
- directoryGetCollections: (args: DirectoryGetCollectionsArgs, headers?: object, signal?: AbortSignal) => Promise<DirectoryGetCollectionsReturn>;
1112
- directorySearchCollections: (args: DirectorySearchCollectionsArgs, headers?: object, signal?: AbortSignal) => Promise<DirectorySearchCollectionsReturn>;
1113
897
  getNiftyswapTokenQuantity: (args: GetNiftyswapTokenQuantityArgs, headers?: object, signal?: AbortSignal) => Promise<GetNiftyswapTokenQuantityReturn>;
1114
898
  getNiftyswapUnitPrices: (args: GetNiftyswapUnitPricesArgs, headers?: object, signal?: AbortSignal) => Promise<GetNiftyswapUnitPricesReturn>;
1115
899
  getNiftyswapUnitPricesWithQuantities: (args: GetNiftyswapUnitPricesWithQuantitiesArgs, headers?: object, signal?: AbortSignal) => Promise<GetNiftyswapUnitPricesWithQuantitiesReturn>;
@@ -1158,11 +942,6 @@ export declare class Admin implements Admin {
1158
942
  addContractToTokenDirectory: (args: AddContractToTokenDirectoryArgs, headers?: object, signal?: AbortSignal) => Promise<AddContractToTokenDirectoryReturn>;
1159
943
  removeContractFromTokenDirectory: (args: RemoveContractFromTokenDirectoryArgs, headers?: object, signal?: AbortSignal) => Promise<RemoveContractFromTokenDirectoryReturn>;
1160
944
  refreshTokenDirectory: (headers?: object, signal?: AbortSignal) => Promise<RefreshTokenDirectoryReturn>;
1161
- addContractsToTokenDirectory: (args: AddContractsToTokenDirectoryArgs, headers?: object, signal?: AbortSignal) => Promise<AddContractsToTokenDirectoryReturn>;
1162
- removeContractsFromTokenDirectory: (args: RemoveContractsFromTokenDirectoryArgs, headers?: object, signal?: AbortSignal) => Promise<RemoveContractsFromTokenDirectoryReturn>;
1163
- modifyFeatureIndex: (args: ModifyFeatureIndexArgs, headers?: object, signal?: AbortSignal) => Promise<ModifyFeatureIndexReturn>;
1164
- getFeatureIndex: (args: GetFeatureIndexArgs, headers?: object, signal?: AbortSignal) => Promise<GetFeatureIndexReturn>;
1165
- listTokenDirectory: (args: ListTokenDirectoryArgs, headers?: object, signal?: AbortSignal) => Promise<ListTokenDirectoryReturn>;
1166
945
  }
1167
946
  export declare class WebrpcError extends Error {
1168
947
  name: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@0xsequence/metadata",
3
- "version": "2.3.2",
3
+ "version": "2.3.4",
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",