@imtbl/sdk 1.19.2-alpha.1 → 1.19.3-alpha

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.
Files changed (40) hide show
  1. package/dist/blockchain_data.js +2 -2
  2. package/dist/browser/checkout/{BridgeWidget-a1459601.js → BridgeWidget-8473be99.js} +1 -1
  3. package/dist/browser/checkout/{HorizontalMenu-actual-08754aa6.js → HorizontalMenu-actual-fae5016a.js} +1 -1
  4. package/dist/browser/checkout/{OnRampWidget-52218bd1.js → OnRampWidget-541bdaf9.js} +1 -1
  5. package/dist/browser/checkout/SaleWidget-908b7bab.js +2 -0
  6. package/dist/browser/checkout/{SpendingCapHero-90db2206.js → SpendingCapHero-09425092.js} +1 -1
  7. package/dist/browser/checkout/{SwapWidget-3635434d.js → SwapWidget-67de0982.js} +1 -1
  8. package/dist/browser/checkout/{TopUpView-67c26c0e.js → TopUpView-0a2474da.js} +1 -1
  9. package/dist/browser/checkout/{WalletWidget-2ed51013.js → WalletWidget-5cd62948.js} +1 -1
  10. package/dist/browser/checkout/{auto-track-05a079ed.js → auto-track-e4ac1604.js} +1 -1
  11. package/dist/browser/checkout/{balance-0ee1be7d.js → balance-f3120e67.js} +1 -1
  12. package/dist/browser/checkout/{index-3f3f2ae3.js → index-4c0f56d2.js} +2 -2
  13. package/dist/browser/checkout/{index-b7601a04.js → index-4e267d8c.js} +1 -1
  14. package/dist/browser/checkout/{index-43d8cc45.js → index-62c63421.js} +1 -1
  15. package/dist/browser/checkout/{index-56a0f324.js → index-99eb8084.js} +1 -1
  16. package/dist/browser/checkout/{index-6c4db150.js → index-acee0f40.js} +1 -1
  17. package/dist/browser/checkout/{index-db394721.js → index-dc45747d.js} +1 -1
  18. package/dist/browser/checkout/index-eab43a8d.js +1 -0
  19. package/dist/browser/checkout/{index-5adbc757.js → index-fe11d6b1.js} +1 -1
  20. package/dist/browser/checkout/{index.umd-6ee30c1b.js → index.umd-aaf8e1b4.js} +1 -1
  21. package/dist/browser/checkout/{retry-27ee3083.js → retry-3152ba85.js} +1 -1
  22. package/dist/browser/checkout/sdk.js +4 -4
  23. package/dist/browser/checkout/widgets-esm.js +1 -1
  24. package/dist/browser/checkout/widgets.js +5 -5
  25. package/dist/checkout.d.ts +239 -603
  26. package/dist/checkout.js +7 -7
  27. package/dist/config.js +1 -1
  28. package/dist/index.browser.js +13 -13
  29. package/dist/index.browser.js.map +1 -1
  30. package/dist/index.cjs +77 -87
  31. package/dist/index.d.ts +1160 -1718
  32. package/dist/index.js +79 -89
  33. package/dist/orderbook.js +1 -1
  34. package/dist/passport.d.ts +478 -838
  35. package/dist/passport.js +29 -29
  36. package/dist/x.d.ts +103 -657
  37. package/dist/x.js +47 -58
  38. package/package.json +1 -1
  39. package/dist/browser/checkout/SaleWidget-22fef0b5.js +0 -2
  40. package/dist/browser/checkout/index-c652c950.js +0 -1
@@ -520,601 +520,30 @@ declare class JsonRpcProvider extends BaseProvider {
520
520
  };
521
521
  }
522
522
 
523
- declare class StaticJsonRpcProvider extends JsonRpcProvider {
524
- detectNetwork(): Promise<Network>;
525
- }
526
-
527
- declare type ExternalProvider = {
528
- isMetaMask?: boolean;
529
- isStatus?: boolean;
530
- host?: string;
531
- path?: string;
532
- sendAsync?: (request: {
533
- method: string;
534
- params?: Array<any>;
535
- }, callback: (error: any, response: any) => void) => void;
536
- send?: (request: {
537
- method: string;
538
- params?: Array<any>;
539
- }, callback: (error: any, response: any) => void) => void;
540
- request?: (request: {
541
- method: string;
542
- params?: Array<any>;
543
- }) => Promise<any>;
544
- };
545
- declare type JsonRpcFetchFunc = (method: string, params?: Array<any>) => Promise<any>;
546
- declare class Web3Provider extends JsonRpcProvider {
547
- readonly provider: ExternalProvider;
548
- readonly jsonRpcFetchFunc: JsonRpcFetchFunc;
549
- constructor(provider: ExternalProvider | JsonRpcFetchFunc, network?: Networkish);
550
- send(method: string, params: Array<any>): Promise<any>;
551
- }
552
-
553
- /**
554
- * An ERC20 token
555
- */
556
- interface ERC20Token$1 {
557
- type: 'ERC20';
558
- tokenAddress: string;
559
- }
560
- /**
561
- * An ERC721 token
562
- */
563
- interface ERC721Token {
564
- type: 'ERC721';
565
- tokenId: string;
566
- tokenAddress: string;
567
- }
568
- /**
569
- * An ETH token
570
- */
571
- interface ETHToken$1 {
572
- type: 'ETH';
573
- }
574
- /**
575
- * An amount of ETH token of unit Wei
576
- */
577
- interface ETHAmount$1 extends ETHToken$1 {
578
- /**
579
- * An amount in unit Wei
580
- */
581
- amount: string;
582
- }
583
- /**
584
- * The token details and amount of ERC20 token units
585
- */
586
- interface ERC20Amount$1 extends ERC20Token$1 {
587
- /**
588
- * An amount in units for the given ERC20 token
589
- */
590
- amount: string;
591
- }
592
- /**
593
- * Union type that represents all token types
594
- */
595
- declare type AnyToken = ETHToken$1 | ERC721Token | ERC20Token$1;
596
- /**
597
- * Union type that represents all token type amounts
598
- */
599
- declare type TokenAmount = ETHAmount$1 | ERC20Amount$1 | ERC721Token;
600
- /**
601
- * Union type that represents exchange token type amounts
602
- */
603
- declare type ExchangeTokenAmount$1 = ETHAmount$1 | ERC20Amount$1;
604
-
605
- /**
606
- * Immutable X API
607
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
608
- *
609
- * The version of the OpenAPI document: 3.0
610
- * Contact: support@immutable.com
611
- *
612
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
613
- * https://openapi-generator.tech
614
- * Do not edit the class manually.
615
- */
616
- /**
617
- *
618
- * @export
619
- * @interface CancelOrderResponse
620
- */
621
- interface CancelOrderResponse$1 {
622
- /**
623
- * ID of the cancelled order
624
- * @type {number}
625
- * @memberof CancelOrderResponse
626
- */
627
- 'order_id': number;
628
- /**
629
- * New status of the order
630
- * @type {string}
631
- * @memberof CancelOrderResponse
632
- */
633
- 'status': string;
634
- }
635
-
636
- /**
637
- * Immutable X API
638
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
639
- *
640
- * The version of the OpenAPI document: 3.0
641
- * Contact: support@immutable.com
642
- *
643
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
644
- * https://openapi-generator.tech
645
- * Do not edit the class manually.
646
- */
647
- /**
648
- *
649
- * @export
650
- * @interface FeeEntry
651
- */
652
- interface FeeEntry$1 {
653
- /**
654
- *
655
- * @type {string}
656
- * @memberof FeeEntry
657
- */
658
- 'address'?: string;
659
- /**
660
- *
661
- * @type {number}
662
- * @memberof FeeEntry
663
- */
664
- 'fee_percentage'?: number;
665
- }
666
-
667
- /**
668
- * Immutable X API
669
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
670
- *
671
- * The version of the OpenAPI document: 3.0
672
- * Contact: support@immutable.com
673
- *
674
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
675
- * https://openapi-generator.tech
676
- * Do not edit the class manually.
677
- */
678
- /**
679
- *
680
- * @export
681
- * @interface CreateOrderResponse
682
- */
683
- interface CreateOrderResponse$1 {
684
- /**
685
- * ID of the created order
686
- * @type {number}
687
- * @memberof CreateOrderResponse
688
- */
689
- 'order_id': number;
690
- /**
691
- * Request ID as a reference for an asynchronous order creation request
692
- * @type {string}
693
- * @memberof CreateOrderResponse
694
- */
695
- 'request_id'?: string;
696
- /**
697
- * Status of the created order
698
- * @type {string}
699
- * @memberof CreateOrderResponse
700
- */
701
- 'status': string;
702
- /**
703
- * Timestamp of the created order
704
- * @type {number}
705
- * @memberof CreateOrderResponse
706
- */
707
- 'time': number;
708
- }
709
-
710
- /**
711
- * Immutable X API
712
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
713
- *
714
- * The version of the OpenAPI document: 3.0
715
- * Contact: support@immutable.com
716
- *
717
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
718
- * https://openapi-generator.tech
719
- * Do not edit the class manually.
720
- */
721
- /**
722
- *
723
- * @export
724
- * @interface CreateTradeResponse
725
- */
726
- interface CreateTradeResponse$1 {
727
- /**
728
- * Request ID as a reference for an asynchronous trade creation request
729
- * @type {string}
730
- * @memberof CreateTradeResponse
731
- */
732
- 'request_id'?: string;
733
- /**
734
- * Current status of trade
735
- * @type {string}
736
- * @memberof CreateTradeResponse
737
- */
738
- 'status': string;
739
- /**
740
- * ID of trade within Immutable X
741
- * @type {number}
742
- * @memberof CreateTradeResponse
743
- */
744
- 'trade_id': number;
745
- }
746
-
747
- /**
748
- * Immutable X API
749
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
750
- *
751
- * The version of the OpenAPI document: 3.0
752
- * Contact: support@immutable.com
753
- *
754
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
755
- * https://openapi-generator.tech
756
- * Do not edit the class manually.
757
- */
758
- /**
759
- *
760
- * @export
761
- * @interface CreateTransferResponse
762
- */
763
- interface CreateTransferResponse {
764
- /**
765
- * List of transfer IDs
766
- * @type {Array<number>}
767
- * @memberof CreateTransferResponse
768
- */
769
- 'transfer_ids': Array<number>;
770
- }
771
-
772
- /**
773
- * Immutable X API
774
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
775
- *
776
- * The version of the OpenAPI document: 3.0
777
- * Contact: support@immutable.com
778
- *
779
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
780
- * https://openapi-generator.tech
781
- * Do not edit the class manually.
782
- */
783
- /**
784
- *
785
- * @export
786
- * @interface CreateTransferResponseV1
787
- */
788
- interface CreateTransferResponseV1$2 {
789
- /**
790
- * [deprecated] Sent signature
791
- * @type {string}
792
- * @memberof CreateTransferResponseV1
793
- */
794
- 'sent_signature': string;
795
- /**
796
- * [deprecated] The status of transfer
797
- * @type {string}
798
- * @memberof CreateTransferResponseV1
799
- */
800
- 'status': string;
801
- /**
802
- * [deprecated] Time of the transfer
803
- * @type {number}
804
- * @memberof CreateTransferResponseV1
805
- */
806
- 'time': number;
807
- /**
808
- * ID of the transfer
809
- * @type {number}
810
- * @memberof CreateTransferResponseV1
811
- */
812
- 'transfer_id': number;
813
- }
814
-
815
- /**
816
- * Immutable X API
817
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
818
- *
819
- * The version of the OpenAPI document: 3.0
820
- * Contact: support@immutable.com
821
- *
822
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
823
- * https://openapi-generator.tech
824
- * Do not edit the class manually.
825
- */
826
- /**
827
- *
828
- * @export
829
- * @interface CreateWithdrawalResponse
830
- */
831
- interface CreateWithdrawalResponse$1 {
832
- /**
833
- * Status of the withdrawal
834
- * @type {string}
835
- * @memberof CreateWithdrawalResponse
836
- */
837
- 'status': string;
838
- /**
839
- * Time of the withdrawal
840
- * @type {number}
841
- * @memberof CreateWithdrawalResponse
842
- */
843
- 'time': number;
844
- /**
845
- * ID of the withdrawal
846
- * @type {number}
847
- * @memberof CreateWithdrawalResponse
848
- */
849
- 'withdrawal_id': number;
850
- }
851
-
852
- /**
853
- * Immutable X API
854
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
855
- *
856
- * The version of the OpenAPI document: 3.0
857
- * Contact: support@immutable.com
858
- *
859
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
860
- * https://openapi-generator.tech
861
- * Do not edit the class manually.
862
- */
863
- /**
864
- *
865
- * @export
866
- * @interface GetSignableCancelOrderRequest
867
- */
868
- interface GetSignableCancelOrderRequest$1 {
869
- /**
870
- * ID of the order to be cancelled
871
- * @type {number}
872
- * @memberof GetSignableCancelOrderRequest
873
- */
874
- 'order_id': number;
875
- }
876
-
877
- /**
878
- * Immutable X API
879
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
880
- *
881
- * The version of the OpenAPI document: 3.0
882
- * Contact: support@immutable.com
883
- *
884
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
885
- * https://openapi-generator.tech
886
- * Do not edit the class manually.
887
- */
888
-
889
- /**
890
- *
891
- * @export
892
- * @interface GetSignableTradeRequest
893
- */
894
- interface GetSignableTradeRequest$1 {
895
- /**
896
- * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
897
- * @type {number}
898
- * @memberof GetSignableTradeRequest
899
- */
900
- 'expiration_timestamp'?: number;
901
- /**
902
- * Inclusion of either maker or taker fees
903
- * @type {Array<FeeEntry>}
904
- * @memberof GetSignableTradeRequest
905
- */
906
- 'fees'?: Array<FeeEntry$1>;
907
- /**
908
- * The ID of the maker order involved
909
- * @type {number}
910
- * @memberof GetSignableTradeRequest
911
- */
912
- 'order_id': number;
913
- /**
914
- * Ethereum address of the submitting user
915
- * @type {string}
916
- * @memberof GetSignableTradeRequest
917
- */
918
- 'user': string;
919
- }
920
-
921
- /**
922
- * Immutable X API
923
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
924
- *
925
- * The version of the OpenAPI document: 3.0
926
- * Contact: support@immutable.com
927
- *
928
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
929
- * https://openapi-generator.tech
930
- * Do not edit the class manually.
931
- */
932
- /**
933
- *
934
- * @export
935
- * @interface RegisterUserResponse
936
- */
937
- interface RegisterUserResponse$1 {
938
- /**
939
- * Immutable signature authorising registration
940
- * @type {string}
941
- * @memberof RegisterUserResponse
942
- */
943
- 'tx_hash': string;
944
- }
945
-
946
- /**
947
- * Parameter required to create an Order
948
- */
949
- interface UnsignedOrderRequest {
950
- /**
951
- * The amount of tokens that will be bought for this order
952
- */
953
- buy: TokenAmount;
954
- /**
955
- * The amount of tokens that will be sold for this order
956
- */
957
- sell: TokenAmount;
958
- /**
959
- * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
960
- */
961
- expiration_timestamp?: number;
962
- /**
963
- * Inclusion of either maker or taker fees
964
- */
965
- fees?: Array<FeeEntry$1>;
966
- }
967
- /**
968
- * Parameter required to create a Transfer
969
- */
970
- declare type UnsignedTransferRequest = TokenAmount & {
971
- /**
972
- * Ethereum address of the receiving user
973
- */
974
- receiver: string;
975
- };
976
- /**
977
- * Parameter required to create a Transfer
978
- */
979
- declare type UnsignedExchangeTransferRequest$1 = ExchangeTokenAmount$1 & {
980
- /**
981
- * Ethereum address of the receiving user
982
- */
983
- receiver: string;
984
- /**
985
- * Exchange transaction ID
986
- */
987
- transactionID: string;
988
- };
989
-
990
- /**
991
- * Parameter required to create a batchNftTransfer
992
- */
993
- interface NftTransferDetails {
994
- /**
995
- * Ethereum address of the receiving user
996
- */
997
- receiver: string;
998
- /**
999
- * The token ID
1000
- */
1001
- tokenId: string;
1002
- /**
1003
- * The token contract address
1004
- */
1005
- tokenAddress: string;
1006
- }
1007
-
1008
- interface IMXProvider {
1009
- /**
1010
- * Get the Signer address
1011
- *
1012
- * @return {Promise<string>} Returns a promise that resolves with the signer's address
1013
- */
1014
- getAddress(): Promise<string>;
1015
- /**
1016
- * Register a User to Immutable X if they are not already registered
1017
- *
1018
- * @return {Promise<RegisterUserResponse>} Returns a promise that resolves with the user registration response
1019
- */
1020
- registerOffchain(): Promise<RegisterUserResponse$1>;
1021
- /**
1022
- * Checks if a User is registered off-chain
1023
- *
1024
- * @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered with IMX, false otherwise
1025
- */
1026
- isRegisteredOffchain(): Promise<boolean>;
1027
- /**
1028
- * Checks if a User is registered on-chain
1029
- *
1030
- * @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered, false otherwise
1031
- */
1032
- isRegisteredOnchain(): Promise<boolean>;
1033
- /**
1034
- * Create an Order
1035
- *
1036
- * @param {UnsignedOrderRequest} request The unsigned order request to create an order
1037
- * @return {Promise<CreateOrderResponse>} Returns a promise that resolves with the created Order
1038
- */
1039
- createOrder(request: UnsignedOrderRequest): Promise<CreateOrderResponse$1>;
1040
- /**
1041
- * Cancel an Order
1042
- *
1043
- * @param {GetSignableCancelOrderRequest} request The signable cancel order request
1044
- * @return {Promise<CancelOrderResponse>} Returns a promise that resolves with the cancelled Order
1045
- */
1046
- cancelOrder(request: GetSignableCancelOrderRequest$1): Promise<CancelOrderResponse$1>;
1047
- /**
1048
- * Create a Trade
1049
- *
1050
- * @param {GetSignableTradeRequest} request The signable trade request
1051
- * @return {Promise<CreateTradeResponse>} Returns a promise that resolves with the created Trade
1052
- */
1053
- createTrade(request: GetSignableTradeRequest$1): Promise<CreateTradeResponse$1>;
1054
- /**
1055
- * Create a new Transfer request
1056
- *
1057
- * @param {UnsignedTransferRequest} request The unsigned transfer request
1058
- * @return {Promise<CreateTransferResponseV1>} Returns a promise that resolves with the created Transfer
1059
- */
1060
- transfer(request: UnsignedTransferRequest): Promise<CreateTransferResponseV1$2>;
1061
- /**
1062
- * Create a batch of NFT transfer requests
1063
- *
1064
- * @param {Array<NftTransferDetails>} request An array of NFT transfer details
1065
- * @return {Promise<CreateTransferResponse>} Resolves a promise that resolves with the list of Transfer IDs
1066
- */
1067
- batchNftTransfer(request: Array<NftTransferDetails>): Promise<CreateTransferResponse>;
1068
- /**
1069
- * Create a new Exchange transaction
1070
- *
1071
- * @param {UnsignedExchangeTransferRequest} request The unsigned exchange transfer request
1072
- * @return {Promise<CreateTransferResponseV1>} Returns a promise that resolves with the created Exchange Transaction
1073
- */
1074
- exchangeTransfer(request: UnsignedExchangeTransferRequest$1): Promise<CreateTransferResponseV1$2>;
1075
- /**
1076
- * Deposit either ETH, ERC20 or ERC721 tokens
1077
- *
1078
- * @param {TokenAmount} request The token type amount in its corresponding unit
1079
- * @return {Promise<TransactionResponse>} Returns a promise that resolves with the transaction
1080
- */
1081
- deposit(deposit: TokenAmount): Promise<TransactionResponse>;
1082
- /**
1083
- * Create a Withdrawal
1084
- *
1085
- * @param {TokenAmount} request The token type amount in its corresponding unit
1086
- * @return {Promise<CreateWithdrawalResponse>} Returns a promise that resolves with the created Withdrawal
1087
- */
1088
- prepareWithdrawal(request: TokenAmount): Promise<CreateWithdrawalResponse$1>;
1089
- /**
1090
- * Completes a Withdrawal
1091
- *
1092
- * @param {string} starkPublicKey The stark public key
1093
- * @param {AnyToken} token The token to withdraw
1094
- * @return {Promise<TransactionResponse>} Returns a promise that resolves with the transaction
1095
- */
1096
- completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
1097
- }
1098
-
1099
- declare enum Environment {
1100
- PRODUCTION = "production",
1101
- SANDBOX = "sandbox"
1102
- }
1103
- declare class ImmutableConfiguration {
1104
- readonly environment: Environment;
1105
- readonly rateLimitingKey?: string;
1106
- readonly apiKey?: string;
1107
- readonly publishableKey?: string;
1108
- constructor(options: {
1109
- environment: Environment;
1110
- rateLimitingKey?: string;
1111
- apiKey?: string;
1112
- publishableKey?: string;
1113
- });
1114
- }
1115
- interface ModuleConfiguration<T> {
1116
- baseConfig: ImmutableConfiguration;
1117
- overrides?: T;
523
+ declare type ExternalProvider = {
524
+ isMetaMask?: boolean;
525
+ isStatus?: boolean;
526
+ host?: string;
527
+ path?: string;
528
+ sendAsync?: (request: {
529
+ method: string;
530
+ params?: Array<any>;
531
+ }, callback: (error: any, response: any) => void) => void;
532
+ send?: (request: {
533
+ method: string;
534
+ params?: Array<any>;
535
+ }, callback: (error: any, response: any) => void) => void;
536
+ request?: (request: {
537
+ method: string;
538
+ params?: Array<any>;
539
+ }) => Promise<any>;
540
+ };
541
+ declare type JsonRpcFetchFunc = (method: string, params?: Array<any>) => Promise<any>;
542
+ declare class Web3Provider extends JsonRpcProvider {
543
+ readonly provider: ExternalProvider;
544
+ readonly jsonRpcFetchFunc: JsonRpcFetchFunc;
545
+ constructor(provider: ExternalProvider | JsonRpcFetchFunc, network?: Networkish);
546
+ send(method: string, params: Array<any>): Promise<any>;
1118
547
  }
1119
548
 
1120
549
  // TypeScript Version: 4.7
@@ -4618,7 +4047,7 @@ interface FeeInfo {
4618
4047
  * @export
4619
4048
  * @interface CreateTradeResponse
4620
4049
  */
4621
- interface CreateTradeResponse {
4050
+ interface CreateTradeResponse$1 {
4622
4051
  /**
4623
4052
  * Request ID as a reference for an asynchronous trade creation request
4624
4053
  * @type {string}
@@ -4811,6 +4240,31 @@ interface CreateTransferRequestV1 {
4811
4240
  'stark_signature': string;
4812
4241
  }
4813
4242
 
4243
+ /**
4244
+ * Immutable X API
4245
+ * Immutable X API
4246
+ *
4247
+ * The version of the OpenAPI document: 3.0.0
4248
+ * Contact: support@immutable.com
4249
+ *
4250
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4251
+ * https://openapi-generator.tech
4252
+ * Do not edit the class manually.
4253
+ */
4254
+ /**
4255
+ *
4256
+ * @export
4257
+ * @interface CreateTransferResponse
4258
+ */
4259
+ interface CreateTransferResponse {
4260
+ /**
4261
+ * List of transfer IDs
4262
+ * @type {Array<number>}
4263
+ * @memberof CreateTransferResponse
4264
+ */
4265
+ 'transfer_ids': Array<number>;
4266
+ }
4267
+
4814
4268
  /**
4815
4269
  * Immutable X API
4816
4270
  * Immutable X API
@@ -6115,7 +5569,7 @@ interface Project {
6115
5569
  * @export
6116
5570
  * @interface GetSignableCancelOrderRequest
6117
5571
  */
6118
- interface GetSignableCancelOrderRequest {
5572
+ interface GetSignableCancelOrderRequest$1 {
6119
5573
  /**
6120
5574
  * ID of the order to be cancelled
6121
5575
  * @type {number}
@@ -6673,7 +6127,7 @@ interface GetSignableRegistrationResponse {
6673
6127
  * @export
6674
6128
  * @interface GetSignableTradeRequest
6675
6129
  */
6676
- interface GetSignableTradeRequest {
6130
+ interface GetSignableTradeRequest$1 {
6677
6131
  /**
6678
6132
  * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
6679
6133
  * @type {number}
@@ -12046,7 +11500,7 @@ interface OrdersApiGetSignableCancelOrderV3Request {
12046
11500
  * @type {GetSignableCancelOrderRequest}
12047
11501
  * @memberof OrdersApiGetSignableCancelOrderV3
12048
11502
  */
12049
- readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest;
11503
+ readonly getSignableCancelOrderRequest: GetSignableCancelOrderRequest$1;
12050
11504
  }
12051
11505
  /**
12052
11506
  * Request parameters for getSignableOrder operation in OrdersApi.
@@ -12636,7 +12090,7 @@ interface TradesApiGetSignableTradeRequest {
12636
12090
  * @type {GetSignableTradeRequest}
12637
12091
  * @memberof TradesApiGetSignableTrade
12638
12092
  */
12639
- readonly getSignableTradeRequest: GetSignableTradeRequest;
12093
+ readonly getSignableTradeRequest: GetSignableTradeRequest$1;
12640
12094
  }
12641
12095
  /**
12642
12096
  * Request parameters for getTradeV3 operation in TradesApi.
@@ -12739,7 +12193,7 @@ declare class TradesApi$1 extends BaseAPI {
12739
12193
  * @throws {RequiredError}
12740
12194
  * @memberof TradesApi
12741
12195
  */
12742
- createTradeV3(requestParameters: TradesApiCreateTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
12196
+ createTradeV3(requestParameters: TradesApiCreateTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse$1, any>>;
12743
12197
  /**
12744
12198
  * Generate a signable trade message (V3)
12745
12199
  * @summary Generate a signable trade message (V3)
@@ -13490,6 +12944,27 @@ declare class ImxApiClients {
13490
12944
  constructor(config: ImmutableAPIConfiguration);
13491
12945
  }
13492
12946
 
12947
+ declare enum Environment {
12948
+ PRODUCTION = "production",
12949
+ SANDBOX = "sandbox"
12950
+ }
12951
+ declare class ImmutableConfiguration {
12952
+ readonly environment: Environment;
12953
+ readonly rateLimitingKey?: string;
12954
+ readonly apiKey?: string;
12955
+ readonly publishableKey?: string;
12956
+ constructor(options: {
12957
+ environment: Environment;
12958
+ rateLimitingKey?: string;
12959
+ apiKey?: string;
12960
+ publishableKey?: string;
12961
+ });
12962
+ }
12963
+ interface ModuleConfiguration<T> {
12964
+ baseConfig: ImmutableConfiguration;
12965
+ overrides?: T;
12966
+ }
12967
+
13493
12968
  declare class ApiConfiguration extends Configuration {
13494
12969
  }
13495
12970
  interface EthConfiguration {
@@ -13556,6 +13031,14 @@ interface ERC20Token {
13556
13031
  type: 'ERC20';
13557
13032
  tokenAddress: string;
13558
13033
  }
13034
+ /**
13035
+ * An ERC721 token
13036
+ */
13037
+ interface ERC721Token {
13038
+ type: 'ERC721';
13039
+ tokenId: string;
13040
+ tokenAddress: string;
13041
+ }
13559
13042
  /**
13560
13043
  * An ETH token
13561
13044
  */
@@ -13580,11 +13063,49 @@ interface ERC20Amount extends ERC20Token {
13580
13063
  */
13581
13064
  amount: string;
13582
13065
  }
13066
+ /**
13067
+ * Union type that represents all token types
13068
+ */
13069
+ type AnyToken = ETHToken | ERC721Token | ERC20Token;
13070
+ /**
13071
+ * Union type that represents all token type amounts
13072
+ */
13073
+ type TokenAmount = ETHAmount | ERC20Amount | ERC721Token;
13583
13074
  /**
13584
13075
  * Union type that represents exchange token type amounts
13585
13076
  */
13586
13077
  type ExchangeTokenAmount = ETHAmount | ERC20Amount;
13587
13078
 
13079
+ /**
13080
+ * Parameter required to create an Order
13081
+ */
13082
+ interface UnsignedOrderRequest {
13083
+ /**
13084
+ * The amount of tokens that will be bought for this order
13085
+ */
13086
+ buy: TokenAmount;
13087
+ /**
13088
+ * The amount of tokens that will be sold for this order
13089
+ */
13090
+ sell: TokenAmount;
13091
+ /**
13092
+ * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
13093
+ */
13094
+ expiration_timestamp?: number;
13095
+ /**
13096
+ * Inclusion of either maker or taker fees
13097
+ */
13098
+ fees?: Array<FeeEntry>;
13099
+ }
13100
+ /**
13101
+ * Parameter required to create a Transfer
13102
+ */
13103
+ type UnsignedTransferRequest = TokenAmount & {
13104
+ /**
13105
+ * Ethereum address of the receiving user
13106
+ */
13107
+ receiver: string;
13108
+ };
13588
13109
  /**
13589
13110
  * Parameter required to Mint tokens
13590
13111
  */
@@ -13603,6 +13124,24 @@ type UnsignedExchangeTransferRequest = ExchangeTokenAmount & {
13603
13124
  transactionID: string;
13604
13125
  };
13605
13126
 
13127
+ /**
13128
+ * Parameter required to create a batchNftTransfer
13129
+ */
13130
+ interface NftTransferDetails {
13131
+ /**
13132
+ * Ethereum address of the receiving user
13133
+ */
13134
+ receiver: string;
13135
+ /**
13136
+ * The token ID
13137
+ */
13138
+ tokenId: string;
13139
+ /**
13140
+ * The token contract address
13141
+ */
13142
+ tokenAddress: string;
13143
+ }
13144
+
13606
13145
  /**
13607
13146
  * Need to specifically export the classes and interfaces from the generated
13608
13147
  * clients imx object for rollup to bundle them correctly.
@@ -13683,6 +13222,8 @@ interface CreatePrimarySaleNotFoundBody extends CreatePrimarySaleNotFoundBody$1
13683
13222
  }
13684
13223
  interface CreatePrimarySaleUnauthorizedBody extends CreatePrimarySaleUnauthorizedBody$1 {
13685
13224
  }
13225
+ interface CreateTradeResponse extends CreateTradeResponse$1 {
13226
+ }
13686
13227
  interface CreateTransferResponseV1 extends CreateTransferResponseV1$1 {
13687
13228
  }
13688
13229
  interface DepositsApiGetDepositRequest extends DepositsApiGetDepositRequest$1 {
@@ -13695,6 +13236,10 @@ interface ExchangesApiGetExchangeRequest extends ExchangesApiGetExchangeRequest$
13695
13236
  }
13696
13237
  interface ExchangesApiGetExchangesRequest extends ExchangesApiGetExchangesRequest$1 {
13697
13238
  }
13239
+ interface GetSignableCancelOrderRequest extends GetSignableCancelOrderRequest$1 {
13240
+ }
13241
+ interface GetSignableTradeRequest extends GetSignableTradeRequest$1 {
13242
+ }
13698
13243
  interface MetadataApiGetMetadataSchemaRequest extends MetadataApiGetMetadataSchemaRequest$1 {
13699
13244
  }
13700
13245
  interface MetadataSchemaRequest extends MetadataSchemaRequest$1 {
@@ -14132,6 +13677,97 @@ declare class IMXClient {
14132
13677
  rejectPrimarySale(ethSigner: Signer, primarySaleId: number): Promise<RejectPrimarySaleBadRequestBody | RejectPrimarySaleForbiddenBody | RejectPrimarySaleNotFoundBody | RejectPrimarySaleOKBody | RejectPrimarySaleUnauthorizedBody>;
14133
13678
  }
14134
13679
 
13680
+ interface IMXProvider {
13681
+ /**
13682
+ * Get the Signer address
13683
+ *
13684
+ * @return {Promise<string>} Returns a promise that resolves with the signer's address
13685
+ */
13686
+ getAddress(): Promise<string>;
13687
+ /**
13688
+ * Register a User to Immutable X if they are not already registered
13689
+ *
13690
+ * @return {Promise<imx.RegisterUserResponse>} Returns a promise that resolves with the user registration response
13691
+ */
13692
+ registerOffchain(): Promise<RegisterUserResponse>;
13693
+ /**
13694
+ * Checks if a User is registered off-chain
13695
+ *
13696
+ * @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered with IMX, false otherwise
13697
+ */
13698
+ isRegisteredOffchain(): Promise<boolean>;
13699
+ /**
13700
+ * Checks if a User is registered on-chain
13701
+ *
13702
+ * @return {Promise<boolean>} Returns a promise that resolves with true if the User is registered, false otherwise
13703
+ */
13704
+ isRegisteredOnchain(): Promise<boolean>;
13705
+ /**
13706
+ * Create an Order
13707
+ *
13708
+ * @param {UnsignedOrderRequest} request The unsigned order request to create an order
13709
+ * @return {Promise<CreateOrderResponse>} Returns a promise that resolves with the created Order
13710
+ */
13711
+ createOrder(request: UnsignedOrderRequest): Promise<CreateOrderResponse>;
13712
+ /**
13713
+ * Cancel an Order
13714
+ *
13715
+ * @param {GetSignableCancelOrderRequest} request The signable cancel order request
13716
+ * @return {Promise<CancelOrderResponse>} Returns a promise that resolves with the cancelled Order
13717
+ */
13718
+ cancelOrder(request: GetSignableCancelOrderRequest): Promise<CancelOrderResponse>;
13719
+ /**
13720
+ * Create a Trade
13721
+ *
13722
+ * @param {GetSignableTradeRequest} request The signable trade request
13723
+ * @return {Promise<CreateTradeResponse>} Returns a promise that resolves with the created Trade
13724
+ */
13725
+ createTrade(request: GetSignableTradeRequest): Promise<CreateTradeResponse>;
13726
+ /**
13727
+ * Create a new Transfer request
13728
+ *
13729
+ * @param {UnsignedTransferRequest} request The unsigned transfer request
13730
+ * @return {Promise<imx.CreateTransferResponseV1>} Returns a promise that resolves with the created Transfer
13731
+ */
13732
+ transfer(request: UnsignedTransferRequest): Promise<CreateTransferResponseV1$1>;
13733
+ /**
13734
+ * Create a batch of NFT transfer requests
13735
+ *
13736
+ * @param {Array<NftTransferDetails>} request An array of NFT transfer details
13737
+ * @return {Promise<CreateTransferResponse>} Resolves a promise that resolves with the list of Transfer IDs
13738
+ */
13739
+ batchNftTransfer(request: Array<NftTransferDetails>): Promise<CreateTransferResponse>;
13740
+ /**
13741
+ * Create a new Exchange transaction
13742
+ *
13743
+ * @param {UnsignedExchangeTransferRequest} request The unsigned exchange transfer request
13744
+ * @return {Promise<imx.CreateTransferResponseV1>} Returns a promise that resolves with the created Exchange Transaction
13745
+ */
13746
+ exchangeTransfer(request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1$1>;
13747
+ /**
13748
+ * Deposit either ETH, ERC20 or ERC721 tokens
13749
+ *
13750
+ * @param {TokenAmount} request The token type amount in its corresponding unit
13751
+ * @return {Promise<TransactionResponse>} Returns a promise that resolves with the transaction
13752
+ */
13753
+ deposit(deposit: TokenAmount): Promise<TransactionResponse>;
13754
+ /**
13755
+ * Create a Withdrawal
13756
+ *
13757
+ * @param {TokenAmount} request The token type amount in its corresponding unit
13758
+ * @return {Promise<CreateWithdrawalResponse>} Returns a promise that resolves with the created Withdrawal
13759
+ */
13760
+ prepareWithdrawal(request: TokenAmount): Promise<CreateWithdrawalResponse>;
13761
+ /**
13762
+ * Completes a Withdrawal
13763
+ *
13764
+ * @param {string} starkPublicKey The stark public key
13765
+ * @param {AnyToken} token The token to withdraw
13766
+ * @return {Promise<TransactionResponse>} Returns a promise that resolves with the transaction
13767
+ */
13768
+ completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
13769
+ }
13770
+
14135
13771
  type UserProfile = {
14136
13772
  email?: string;
14137
13773
  nickname?: string;
@@ -14349,11 +13985,11 @@ interface TokenInfo {
14349
13985
  }
14350
13986
  /**
14351
13987
  * Interface representing the parameters for {@link Checkout.getTokenInfo}.
14352
- * @property {Web3Provider | StaticJsonRpcProvider} provider - The provider used to get the balance.
13988
+ * @property {Web3Provider | JsonRpcProvider} provider - The provider used to get the balance.
14353
13989
  * @property {string} tokenAddress - The contract address of the token.
14354
13990
  */
14355
13991
  interface GetTokenInfoParams {
14356
- provider: Web3Provider | StaticJsonRpcProvider;
13992
+ provider: Web3Provider | JsonRpcProvider;
14357
13993
  tokenAddress: string;
14358
13994
  }
14359
13995