code cleanup

immutable · Feb 27, 2024 · 7f02c9d · 7f02c9d
1 parent 24982c3
commit 7f02c9d
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 396 deletions.
diff --git a/packages/x-client/src/IMXClient.ts b/packages/x-client/src/IMXClient.ts
@@ -1,71 +1,10 @@
 import { ImxApiClients } from '@imtbl/generated-clients';
 import {
   ImxConfiguration,
-  ImxModuleConfiguration as ImxClientModuleConfiguration,
+  ImxModuleConfiguration as ImxClientModuleConfiguration, // preserve old name for backwards compatibility
 } from './config';
 import { formatError } from './utils/formatError';
 import {
-  // // ImmutableX,
-  // EthSigner,
-  // // generateLegacyStarkPrivateKey,
-  // // createStarkSigner,
-  // UnsignedExchangeTransferRequest,
-  // UnsignedMintRequest,
-  // WalletConnection,
-  // AssetsApi,
-  // BalancesApi,
-  // CollectionsApi,
-  // DepositsApi,
-  // EncodingApi,
-  // MintsApi,
-  // MetadataApi,
-  // OrdersApi,
-  // PrimarySalesApi,
-  // ProjectsApi,
-  // TokensApi,
-  // TradesApi,
-  // TransfersApi,
-  // UsersApi,
-  // WithdrawalsApi,
-  // DepositsApiGetDepositRequest,
-  // DepositsApiListDepositsRequest,
-  // AssetsApiGetAssetRequest,
-  // AssetsApiListAssetsRequest,
-  // CreateCollectionRequest,
-  // CollectionsApiGetCollectionRequest,
-  // CollectionsApiListCollectionFiltersRequest,
-  // CollectionsApiListCollectionsRequest,
-  // UpdateCollectionRequest,
-  // AddMetadataSchemaToCollectionRequest,
-  // MetadataApiGetMetadataSchemaRequest,
-  // MetadataSchemaRequest,
-  // BalancesApiGetBalanceRequest,
-  // BalancesApiListBalancesRequest,
-  // MintsApiGetMintRequest,
-  // MintsApiListMintsRequest,
-  // WithdrawalsApiListWithdrawalsRequest,
-  // WithdrawalsApiGetWithdrawalRequest,
-  // OrdersApiGetOrderV3Request,
-  // OrdersApiListOrdersV3Request,
-  // TradesApiGetTradeV3Request,
-  // TradesApiListTradesV3Request,
-  // TokensApiGetTokenRequest,
-  // TokensApiListTokensRequest,
-  // TransfersApiGetTransferRequest,
-  // TransfersApiListTransfersRequest,
-  // MetadataRefreshesApi,
-  // CreateMetadataRefreshRequest,
-  // ExchangesApi,
-  // ExchangesApiCreateExchangeRequest,
-  // ExchangesApiGetExchangeRequest,
-  // ExchangesApiGetExchangesRequest,
-  // NftCheckoutPrimaryApi,
-  // NftCheckoutPrimaryApiCreateNftPrimaryRequest,
-  // NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest,
-  // NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest,
-  // NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest,
-  // PrimarySalesApiSignableCreatePrimarySaleRequest,
-
   AddMetadataSchemaToCollectionRequest,
   AssetsApi,
   AssetsApiGetAssetRequest,
@@ -913,40 +852,3 @@ export class IMXClient {
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const ImmutableX = IMXClient;
-
-// methods moved to x-provider
-/**
- * getAddress
- * registerOffchain
- * isRegisteredOffchain
- * isRegisteredOnchain
- * createOrder
- * cancelOrder
- * createTrade
- * transfer
- * batchNftTransfer
- * exchangeTransfer
- * deposit
- * prepareWithdrawal
- * completeWithdrawal
- */
-
-// methods moved from Core SDK that aren't in x-provider
-// workflows
-/**
- * createCollection ✅
- * updateCollection ✅
- * addMetadataSchemaToCollection ✅
- * updateMetadataSchemaByName ✅
- * listMetadataRefreshes ✅
- * getMetadataRefreshErrors ✅
- * getMetadataRefreshResults ✅
- * createMetadataRefresh ✅
- * getProject ✅
- * getProjects (removed)
- * mint ✅
- * exchangeTransfer ✅
- * createPrimarySale ✅
- * acceptPrimarySale ✅
- * rejectPrimarySale ✅
- */
diff --git a/packages/x-client/src/config/index.ts b/packages/x-client/src/config/index.ts
@@ -42,6 +42,9 @@ export interface ImmutableXConfiguration {
   ethConfiguration: EthConfiguration;
 }
 
+/**
+ * @dev Copied from Core SDK as a convenience for migrating away from Core SDK
+ */
 const createConfig = ({
   coreContractAddress,
   registrationContractAddress,
@@ -66,7 +69,7 @@ const createConfig = ({
   };
 
   return {
-    apiConfiguration: new imx.Configuration(apiConfigOptions),
+    apiConfiguration: new ApiConfiguration(apiConfigOptions),
     ethConfiguration: {
       coreContractAddress,
       registrationContractAddress,

diff --git a/packages/x-client/src/exportUtils.ts b/packages/x-client/src/exportUtils.ts
@@ -2,4 +2,6 @@ export {
   generateStarkPrivateKey,
   generateLegacyStarkPrivateKey,
   createStarkSigner,
+  generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey, // preserve old name for backwards compatibility
+  createStarkSigner as imxClientCreateStarkSigner, // preserve old name for backwards compatibility
 } from './utils';
diff --git a/packages/x-client/src/index.ts b/packages/x-client/src/index.ts
@@ -1,15 +1,11 @@
 export {
+  EthConfiguration,
   ImxModuleConfiguration,
   ImxModuleConfiguration as ImxClientModuleConfiguration, // preserve old name for backwards compatibility
 } from './config';
 export { IMXClient, ImmutableX } from './IMXClient';
-export {
-  createStarkSigner,
-  createStarkSigner as imxClientCreateStarkSigner, // preserve old name for backwards compatibility
-  generateLegacyStarkPrivateKey,
-  generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey, // TODO - remove console.log in utils file -- // preserve old name for backwards compatibility
-  generateStarkPrivateKey,
-} from './utils';
+export * from './exportUtils';
+export * as Contracts from './exportContracts';
 export { IMXError } from './types/errors';
 export * from './types/requests';
 export {

diff --git a/packages/x-client/src/utils/stark/starkCurve.ts b/packages/x-client/src/utils/stark/starkCurve.ts
@@ -278,21 +278,15 @@ export function generateStarkPrivateKey(): string {
 export async function generateLegacyStarkPrivateKey(
   signer: Signer,
 ): Promise<string> {
-  // console.log('generateLegacyStarkPrivateKey');
   const address = (await signer.getAddress()).toLowerCase();
-  // console.log('address', address);
   const signature = await signer.signMessage(legacy.DEFAULT_SIGNATURE_MESSAGE);
-  // console.log('signature', signature);
   const seed = splitSignature(signature).s;
-  // console.log('seed', seed);
   const path = legacy.getAccountPath(
     legacy.DEFAULT_ACCOUNT_LAYER,
     legacy.DEFAULT_ACCOUNT_APPLICATION,
     address,
     legacy.DEFAULT_ACCOUNT_INDEX,
   );
-  // console.log('path', path);
   const key = await getKeyFromPath(seed, path, address);
-  // console.log('key', key);
   return key.padStart(64, '0');
 }