@imtbl/sdk 0.1.7-alpha.1 → 0.1.7-alpha.3

package/dist/passport.js

@@ -1,5 +1,3 @@
-import * as guardian from '@imtbl/guardian';
-export { guardian };
 import { ImmutableX, Config, generateLegacyStarkPrivateKey, createStarkSigner } from '@imtbl/core-sdk';
 import { UserManager } from 'oidc-client-ts';
 import { ethers } from 'ethers';
@@ -15,24 +13,33 @@ var Environment;
 })(Environment || (Environment = {}));
 
 /**
- * Set `sdkVersion` on config
+ * createImmutableXConfiguration to create a custom ImmutableXConfiguration
+ * other than the production and sandbox defined below.
  */
-const production = () => Config.createConfig({
+const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress, registrationContractAddress, }) => Config.createConfig({
+    basePath,
+    chainID,
+    coreContractAddress,
+    registrationContractAddress,
+    sdkVersion: 'ts-immutable-sdk-0.1.7-alpha.3',
+});
+/**
+ * Sets `sdkVersion` at the time of build
+ */
+const production = () => createImmutableXConfiguration({
     basePath: 'https://api.x.immutable.com',
     chainID: 1,
     coreContractAddress: '0x5FDCCA53617f4d2b9134B29090C87D01058e27e9',
     registrationContractAddress: '0x72a06bf2a1CE5e39cBA06c0CAb824960B587d64c',
-    sdkVersion: 'ts-immutable-sdk-0.1.7-alpha.1',
 });
 /**
- * Set `sdkVersion` on config
+ * Sets `sdkVersion` at the time of build
  */
-const sandbox = () => Config.createConfig({
+const sandbox = () => createImmutableXConfiguration({
     basePath: 'https://api.sandbox.x.immutable.com',
     chainID: 5,
     coreContractAddress: '0x7917eDb51ecD6CdB3F9854c3cc593F33de10c623',
     registrationContractAddress: '0x1C97Ada273C9A52253f463042f29117090Cd7D83',
-    sdkVersion: 'ts-immutable-sdk-0.1.7-alpha.1',
 });
 class ImxConfiguration {
     immutableXConfig;
@@ -772,25 +779,13 @@ var SendMessage;
 })(SendMessage || (SendMessage = {}));
 var TransactionTypes;
 (function (TransactionTypes) {
-    // TODO: remove this once the naming has been fixed
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    TransactionTypes["CancelOrder"] = "delete:v1/orders";
-    // TODO: remove this once the naming has been fixed
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    TransactionTypes["CreateOrder"] = "post:v1/orders";
-    // TODO: remove this once the naming has been fixed
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    TransactionTypes["CreateTrade"] = "post:v1/trades";
-    // TODO: remove this once the naming has been fixed
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    TransactionTypes["CreateTransfer"] = "post:v1/transfers";
-    // TODO: remove this once the naming has been fixed
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    TransactionTypes["CreateBatchTransfer"] = "post:v2/transfers";
+    TransactionTypes["cancelOrder"] = "delete:v1/orders";
+    TransactionTypes["createOrder"] = "post:v1/orders";
+    TransactionTypes["createTrade"] = "post:v1/trades";
+    TransactionTypes["createTransfer"] = "post:v1/transfers";
+    TransactionTypes["createBatchTransfer"] = "post:v2/transfers";
 })(TransactionTypes || (TransactionTypes = {}));
-// TODO: remove this once the naming has been fixed
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const PassportEventType = 'imx_passport_confirmation';
+const PASSPORT_EVENT_TYPE = 'imx_passport_confirmation';
 
 const openPopupCenter = ({ url, title, width, height, }) => {
     const left = Math.max(0, Math.round(window.screenX + (window.outerWidth - width) / 2));
@@ -820,7 +815,7 @@ class ConfirmationScreen {
     }
     postMessage(destinationWindow, accessToken, message) {
         destinationWindow.postMessage({
-            eventType: PassportEventType,
+            eventType: PASSPORT_EVENT_TYPE,
             accessToken,
             ...message,
         }, this.config.passportDomain);
@@ -829,7 +824,7 @@ class ConfirmationScreen {
         return new Promise((resolve, reject) => {
             const messageHandler = ({ data, origin }) => {
                 if (origin !== this.config.passportDomain
-                    || data.eventType !== PassportEventType) {
+                    || data.eventType !== PASSPORT_EVENT_TYPE) {
                     return;
                 }
                 switch (data.messageType) {
@@ -874,59 +869,57 @@ class ConfirmationScreen {
 }
 
 const ERC721$1 = 'ERC721';
-const transfer = ({ request, transfersApi, starkSigner, user, passportConfig,
-// TODO: remove this eslint disable once we have a better solution
-// eslint-disable-next-line max-len
- }) => withPassportError(async () => {
-    const transferAmount = request.type === ERC721$1 ? '1' : request.amount;
-    const getSignableTransferRequest = {
-        sender: user.etherKey,
-        token: convertToSignableToken(request),
-        amount: transferAmount,
-        receiver: request.receiver,
-    };
-    const signableResult = await transfersApi.getSignableTransferV1({
-        getSignableTransferRequest,
-    });
-    const confirmationScreen = new ConfirmationScreen(passportConfig);
-    const confirmationResult = await confirmationScreen.startTransaction(user.accessToken, {
-        transactionType: TransactionTypes.CreateTransfer,
-        transactionData: getSignableTransferRequest,
-    });
-    if (!confirmationResult.confirmed) {
-        throw new Error('Transaction rejected by user');
-    }
-    const signableResultData = signableResult.data;
-    const { payload_hash: payloadHash } = signableResultData;
-    const starkSignature = await starkSigner.signMessage(payloadHash);
-    const senderStarkKey = await starkSigner.getAddress();
-    const transferSigningParams = {
-        sender_stark_key: signableResultData.sender_stark_key || senderStarkKey,
-        sender_vault_id: signableResultData.sender_vault_id,
-        receiver_stark_key: signableResultData.receiver_stark_key,
-        receiver_vault_id: signableResultData.receiver_vault_id,
-        asset_id: signableResultData.asset_id,
-        amount: signableResultData.amount,
-        nonce: signableResultData.nonce,
-        expiration_timestamp: signableResultData.expiration_timestamp,
-        stark_signature: starkSignature,
-    };
-    const createTransferRequest = {
-        createTransferRequest: transferSigningParams,
-    };
-    const headers = {
-        // eslint-disable-next-line @typescript-eslint/naming-convention
-        Authorization: `Bearer ${user.accessToken}`,
-    };
-    const { data: responseData } = await transfersApi.createTransferV1(createTransferRequest, { headers });
-    return {
-        sent_signature: responseData.sent_signature,
-        status: responseData.status?.toString(),
-        time: responseData.time,
-        transfer_id: responseData.transfer_id,
-    };
-}, PassportErrorType.TRANSFER_ERROR);
-async function batchNftTransfer({ user, starkSigner, request, transfersApi, passportConfig, }) {
+async function transfer({ request, transfersApi, starkSigner, user, confirmationScreen, }) {
+    return withPassportError(async () => {
+        const transferAmount = request.type === ERC721$1 ? '1' : request.amount;
+        const getSignableTransferRequest = {
+            sender: user.etherKey,
+            token: convertToSignableToken(request),
+            amount: transferAmount,
+            receiver: request.receiver,
+        };
+        const signableResult = await transfersApi.getSignableTransferV1({
+            getSignableTransferRequest,
+        });
+        const confirmationResult = await confirmationScreen.startTransaction(user.accessToken, {
+            transactionType: TransactionTypes.createTransfer,
+            transactionData: getSignableTransferRequest,
+        });
+        if (!confirmationResult.confirmed) {
+            throw new Error('Transaction rejected by user');
+        }
+        const signableResultData = signableResult.data;
+        const { payload_hash: payloadHash } = signableResultData;
+        const starkSignature = await starkSigner.signMessage(payloadHash);
+        const senderStarkKey = await starkSigner.getAddress();
+        const transferSigningParams = {
+            sender_stark_key: signableResultData.sender_stark_key || senderStarkKey,
+            sender_vault_id: signableResultData.sender_vault_id,
+            receiver_stark_key: signableResultData.receiver_stark_key,
+            receiver_vault_id: signableResultData.receiver_vault_id,
+            asset_id: signableResultData.asset_id,
+            amount: signableResultData.amount,
+            nonce: signableResultData.nonce,
+            expiration_timestamp: signableResultData.expiration_timestamp,
+            stark_signature: starkSignature,
+        };
+        const createTransferRequest = {
+            createTransferRequest: transferSigningParams,
+        };
+        const headers = {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            Authorization: `Bearer ${user.accessToken}`,
+        };
+        const { data: responseData } = await transfersApi.createTransferV1(createTransferRequest, { headers });
+        return {
+            sent_signature: responseData.sent_signature,
+            status: responseData.status?.toString(),
+            time: responseData.time,
+            transfer_id: responseData.transfer_id,
+        };
+    }, PassportErrorType.TRANSFER_ERROR);
+}
+async function batchNftTransfer({ user, starkSigner, request, transfersApi, confirmationScreen, }) {
     return withPassportError(async () => {
         const ethAddress = user.etherKey;
         const signableRequests = request.map((nftTransfer) => ({
@@ -945,10 +938,9 @@ async function batchNftTransfer({ user, starkSigner, request, transfersApi, pass
         const signableResult = await transfersApi.getSignableTransfer({
             getSignableTransferRequestV2,
         });
-        const confirmationScreen = new ConfirmationScreen(passportConfig);
         const popupWindowSize = { width: 480, height: 784 };
         const confirmationResult = await confirmationScreen.startTransaction(user.accessToken, {
-            transactionType: TransactionTypes.CreateBatchTransfer,
+            transactionType: TransactionTypes.createBatchTransfer,
             transactionData: getSignableTransferRequestV2,
         }, popupWindowSize);
         if (!confirmationResult.confirmed) {
@@ -985,7 +977,7 @@ async function batchNftTransfer({ user, starkSigner, request, transfersApi, pass
 }
 
 const ERC721 = 'ERC721';
-async function createOrder({ starkSigner, user, request, ordersApi, passportConfig, }) {
+async function createOrder({ starkSigner, user, request, ordersApi, confirmationScreen, }) {
     return withPassportError(async () => {
         const ethAddress = user.etherKey;
         const amountSell = request.sell.type === ERC721 ? '1' : request.sell.amount;
@@ -1002,9 +994,8 @@ async function createOrder({ starkSigner, user, request, ordersApi, passportConf
         const getSignableOrderResponse = await ordersApi.getSignableOrder({
             getSignableOrderRequestV3,
         });
-        const confirmationScreen = new ConfirmationScreen(passportConfig);
         const confirmationResult = await confirmationScreen.startTransaction(user.accessToken, {
-            transactionType: TransactionTypes.CreateOrder,
+            transactionType: TransactionTypes.createOrder,
             transactionData: getSignableOrderRequestV3,
         });
         if (!confirmationResult.confirmed) {
@@ -1041,7 +1032,7 @@ async function createOrder({ starkSigner, user, request, ordersApi, passportConf
         };
     }, PassportErrorType.CREATE_ORDER_ERROR);
 }
-async function cancelOrder({ user, starkSigner, request, ordersApi, passportConfig, }) {
+async function cancelOrder({ user, starkSigner, request, ordersApi, confirmationScreen, }) {
     return withPassportError(async () => {
         const getSignableCancelOrderRequest = {
             order_id: request.order_id,
@@ -1049,9 +1040,8 @@ async function cancelOrder({ user, starkSigner, request, ordersApi, passportConf
         const getSignableCancelOrderResponse = await ordersApi.getSignableCancelOrder({
             getSignableCancelOrderRequest,
         });
-        const confirmationScreen = new ConfirmationScreen(passportConfig);
         const confirmationResult = await confirmationScreen.startTransaction(user.accessToken, {
-            transactionType: TransactionTypes.CancelOrder,
+            transactionType: TransactionTypes.cancelOrder,
             transactionData: getSignableCancelOrderRequest,
         });
         if (!confirmationResult.confirmed) {
@@ -1121,7 +1111,7 @@ async function exchangeTransfer({ user, starkSigner, request, exchangesApi, }) {
     }, PassportErrorType.EXCHANGE_TRANSFER_ERROR);
 }
 
-async function createTrade({ request, tradesApi, user, starkSigner, passportConfig, }) {
+async function createTrade({ request, tradesApi, user, starkSigner, confirmationScreen, }) {
     return withPassportError(async () => {
         const ethAddress = user.etherKey;
         const getSignableTradeRequest = {
@@ -1133,9 +1123,8 @@ async function createTrade({ request, tradesApi, user, starkSigner, passportConf
         const getSignableTradeResponse = await tradesApi.getSignableTrade({
             getSignableTradeRequest,
         });
-        const confirmationScreen = new ConfirmationScreen(passportConfig);
         const confirmationResult = await confirmationScreen.startTransaction(user.accessToken, {
-            transactionType: TransactionTypes.CreateTrade,
+            transactionType: TransactionTypes.createTrade,
             transactionData: getSignableTradeRequest,
         });
         if (!confirmationResult.confirmed) {
@@ -1174,13 +1163,13 @@ async function createTrade({ request, tradesApi, user, starkSigner, passportConf
 class PassportImxProvider {
     user;
     starkSigner;
-    passportConfig;
     immutableXClient;
-    constructor({ user, starkSigner, passportConfig, immutableXClient, }) {
+    confirmationScreen;
+    constructor({ user, starkSigner, immutableXClient, confirmationScreen, }) {
         this.user = user;
         this.starkSigner = starkSigner;
-        this.passportConfig = passportConfig;
         this.immutableXClient = immutableXClient;
+        this.confirmationScreen = confirmationScreen;
     }
     async transfer(request) {
         return transfer({
@@ -1188,7 +1177,7 @@ class PassportImxProvider {
             user: this.user,
             starkSigner: this.starkSigner,
             transfersApi: this.immutableXClient.transfersApi,
-            passportConfig: this.passportConfig,
+            confirmationScreen: this.confirmationScreen,
         });
     }
     // TODO: Remove once implemented
@@ -1207,7 +1196,7 @@ class PassportImxProvider {
             user: this.user,
             starkSigner: this.starkSigner,
             ordersApi: this.immutableXClient.ordersApi,
-            passportConfig: this.passportConfig,
+            confirmationScreen: this.confirmationScreen,
         });
     }
     cancelOrder(request) {
@@ -1216,7 +1205,7 @@ class PassportImxProvider {
             user: this.user,
             starkSigner: this.starkSigner,
             ordersApi: this.immutableXClient.ordersApi,
-            passportConfig: this.passportConfig,
+            confirmationScreen: this.confirmationScreen,
         });
     }
     createTrade(request) {
@@ -1225,7 +1214,7 @@ class PassportImxProvider {
             user: this.user,
             starkSigner: this.starkSigner,
             tradesApi: this.immutableXClient.tradesApi,
-            passportConfig: this.passportConfig,
+            confirmationScreen: this.confirmationScreen,
         });
     }
     batchNftTransfer(request) {
@@ -1234,7 +1223,7 @@ class PassportImxProvider {
             user: this.user,
             starkSigner: this.starkSigner,
             transfersApi: this.immutableXClient.transfersApi,
-            passportConfig: this.passportConfig,
+            confirmationScreen: this.confirmationScreen,
         });
     }
     exchangeTransfer(request) {
@@ -1374,17 +1363,17 @@ async function registerPassport({ ethSigner, starkSigner, usersApi }, authorizat
     }, PassportErrorType.USER_REGISTRATION_ERROR);
 }
 
-// TODO: Remove this once the dependency has been added
-// eslint-disable-next-line import/no-extraneous-dependencies
 class Passport {
     authManager;
     magicAdapter;
     config;
     immutableXClient;
+    confirmationScreen;
     constructor(passportModuleConfiguration) {
         this.config = new PassportConfiguration(passportModuleConfiguration);
         this.authManager = new AuthManager(this.config);
         this.magicAdapter = new MagicAdapter(this.config);
+        this.confirmationScreen = new ConfirmationScreen(this.config);
         this.immutableXClient = passportModuleConfiguration.overrides?.immutableXClient
             || new ImmutableXClient({
                 baseConfig: passportModuleConfiguration.baseConfig,
@@ -1402,16 +1391,16 @@ class Passport {
             return new PassportImxProvider({
                 user: updatedUser,
                 starkSigner,
-                passportConfig: this.config,
                 immutableXClient: this.immutableXClient,
+                confirmationScreen: this.confirmationScreen,
             });
         }
         const userWithEtherKey = user;
         return new PassportImxProvider({
             user: userWithEtherKey,
             starkSigner,
-            passportConfig: this.config,
             immutableXClient: this.immutableXClient,
+            confirmationScreen: this.confirmationScreen,
         });
     }
     async connectImxSilent() {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.1.7-alpha.1",
+  "version": "0.1.7-alpha.3",
   "author": "Immutable",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
   "dependencies": {
@@ -20,10 +20,14 @@
     "oidc-client-ts": "^2.2.1"
   },
   "devDependencies": {
+    "@imtbl/blockchain-data": "0.0.0",
     "@imtbl/checkout-sdk": "0.0.0",
     "@imtbl/checkout-widgets": "0.0.0",
     "@imtbl/config": "0.0.0",
     "@imtbl/cryptofiat": "0.0.0",
+    "@imtbl/erc20": "0.0.0",
+    "@imtbl/erc721-permissioned-mintable": "0.0.0",
+    "@imtbl/guardian": "0.0.0",
     "@imtbl/immutablex-client": "0.0.0",
     "@imtbl/orderbook": "0.0.0",
     "@imtbl/passport": "0.0.0",
@@ -56,6 +60,10 @@
       "types": "./dist/config.d.ts",
       "import": "./dist/config.js"
     },
+    "./blockchain-data": {
+      "types": "./dist/blockchain-data.d.ts",
+      "import": "./dist/blockchain-data.js"
+    },
     "./immutablex_client": {
       "types": "./dist/immutablex_client.d.ts",
       "import": "./dist/immutablex_client.js"
@@ -79,6 +87,14 @@
     "./checkout_widgets": {
       "types": "./dist/checkout_widgets.d.ts",
       "import": "./dist/checkout_widgets.js"
+    },
+    "./erc20": {
+      "types": "./dist/erc20.d.ts",
+      "import": "./dist/erc20.js"
+    },
+    "./erc721-permissioned-mintable": {
+      "types": "./dist/erc721-permissioned-mintable.d.ts",
+      "import": "./dist/erc721-permissioned-mintable.js"
     }
   },
   "files": [