Add optional nftEndPoint param

magiclabs · Jul 20, 2023 · f5fea52 · f5fea52
1 parent 276bad5
commit f5fea52
Show file tree

Hide file tree

Showing 12 changed files with 37 additions and 3 deletions.
diff --git a/packages/@magic-ext/auth/src/index.ts b/packages/@magic-ext/auth/src/index.ts
@@ -18,6 +18,7 @@ interface SDKEnvironment {
   version: string;
   platform: 'web' | 'react-native';
   defaultEndpoint: string;
+  defaultNFTEndpoint: string;
   ViewController: ConstructorOf<ViewController>;
   configureStorage: () => Promise<typeof localForage>;
   bundleId?: string | null;

diff --git a/packages/@magic-sdk/provider/src/core/sdk-environment.ts b/packages/@magic-sdk/provider/src/core/sdk-environment.ts
@@ -14,6 +14,7 @@ export interface SDKEnvironment {
   version: string;
   platform: 'web' | 'react-native';
   defaultEndpoint: string;
+  defaultNFTEndpoint: string;
   ViewController: ConstructorOf<ViewController>;
   configureStorage: () => Promise<typeof localForage>;
   bundleId?: string | null;

diff --git a/packages/@magic-sdk/provider/src/core/sdk.ts b/packages/@magic-sdk/provider/src/core/sdk.ts
@@ -91,6 +91,7 @@ export interface MagicSDKAdditionalConfiguration<
   TExt extends MagicSDKExtensionsOption<TCustomExtName> = any,
 > {
   endpoint?: string;
+  nftEndpoint?: string;
   locale?: SupportedLocale;
   network?: EthNetworkConfiguration;
   extensions?: TExt;
@@ -142,7 +143,7 @@ export class SDKBase {
       createReactNativeEndpointConfigurationWarning().log();
     }
 
-    const { defaultEndpoint, version } = SDKEnvironment;
+    const { defaultEndpoint, defaultNFTEndpoint, version } = SDKEnvironment;
     this.testMode = !!options?.testMode;
     this.endpoint = createURL(options?.endpoint ?? defaultEndpoint).origin;
 
@@ -161,6 +162,7 @@ export class SDKBase {
       API_KEY: this.apiKey,
       DOMAIN_ORIGIN: window.location ? window.location.origin : '',
       ETH_NETWORK: options?.network,
+      nftEndpoint: options?.nftEndpoint ?? defaultNFTEndpoint,
       host: createURL(this.endpoint).host,
       sdk: sdkNameToEnvName[SDKEnvironment.sdkName],
       version,

diff --git a/packages/@magic-sdk/provider/test/constants.ts b/packages/@magic-sdk/provider/test/constants.ts
@@ -1,4 +1,5 @@
 export const MAGIC_RELAYER_FULL_URL = 'https://auth.magic.link';
+export const MAGIC_NFT_API_URL = 'https://nft-api.magic.link';
 export const TEST_API_KEY = 'pk_test_123';
 export const LIVE_API_KEY = 'pk_live_123';
 export const ENCODED_QUERY_PARAMS = 'testqueryparams';

diff --git a/packages/@magic-sdk/provider/test/factories.ts b/packages/@magic-sdk/provider/test/factories.ts
@@ -1,6 +1,6 @@
 import * as memoryDriver from 'localforage-driver-memory';
 import localForage from 'localforage';
-import { MAGIC_RELAYER_FULL_URL, ENCODED_QUERY_PARAMS, TEST_API_KEY } from './constants';
+import { MAGIC_RELAYER_FULL_URL, ENCODED_QUERY_PARAMS, TEST_API_KEY, MAGIC_NFT_API_URL } from './constants';
 import { ViewController } from '../src';
 import type { SDKEnvironment } from '../src/core/sdk-environment';
 
@@ -41,6 +41,7 @@ export function createMagicSDKCtor(environment: { [P in keyof SDKEnvironment]?:
     platform: 'web',
     version: '1.0.0-test',
     defaultEndpoint: MAGIC_RELAYER_FULL_URL,
+    defaultNFTEndpoint: MAGIC_NFT_API_URL,
     ViewController: TestViewController,
     configureStorage: async () => {
       const lf = localForage.createInstance({});

diff --git a/packages/@magic-sdk/provider/test/spec/core/sdk/constructor.spec.ts b/packages/@magic-sdk/provider/test/spec/core/sdk/constructor.spec.ts
@@ -2,7 +2,7 @@
 /* eslint-disable no-new, class-methods-use-this, global-require */
 
 import browserEnv from '@ikscodes/browser-env';
-import { MAGIC_RELAYER_FULL_URL, TEST_API_KEY } from '../../../constants';
+import { MAGIC_NFT_API_URL, MAGIC_RELAYER_FULL_URL, TEST_API_KEY } from '../../../constants';
 import { createMagicSDKCtor } from '../../../factories';
 import { AuthModule } from '../../../../src/modules/auth';
 import { UserModule } from '../../../../src/modules/user';
@@ -18,6 +18,7 @@ function assertEncodedQueryParams(parameters: string, expectedParams: any = {})
   const defaultExpectedParams = {
     API_KEY: TEST_API_KEY,
     DOMAIN_ORIGIN: 'null',
+    nftEndpoint: MAGIC_NFT_API_URL,
     host: 'auth.magic.link',
     sdk: 'magic-sdk',
     version: '1.0.0-test',
@@ -67,6 +68,15 @@ test('Initialize `MagicSDK` with custom endpoint', () => {
   assertModuleInstanceTypes(magic);
 });
 
+test('Initialize `MagicSDK` with custom nftEnpoint', () => {
+  const Ctor = createMagicSDKCtor();
+  const magic = new Ctor(TEST_API_KEY, { nftEndpoint: 'https://example.com' });
+
+  expect(magic.apiKey).toBe(TEST_API_KEY);
+  assertEncodedQueryParams(magic.parameters, { nftEndpoint: 'https://example.com' });
+  assertModuleInstanceTypes(magic);
+});
+
 test('Initialize `MagicSDK` when `window.location` is missing', () => {
   browserEnv.stub('location', undefined);
 

diff --git a/packages/@magic-sdk/provider/test/spec/modules/user/getInfo.spec.ts b/packages/@magic-sdk/provider/test/spec/modules/user/getInfo.spec.ts
@@ -21,3 +21,16 @@ test('Generate JSON RPC request payload with method `magic_get_info` and the act
   expect(requestPayload.method).toBe('magic_get_info');
   expect(requestPayload.params).toEqual([{ walletType: 'metamask' }]);
 });
+
+test('Generate JSON RPC request payload with method `magic_get_info`', async () => {
+  const magic = createMagicSDK();
+  magic.user.request = jest.fn();
+
+  await storage.setItem('mc_active_wallet', 'metamask');
+
+  await magic.user.getInfo();
+
+  const requestPayload = magic.user.request.mock.calls[0][0];
+  expect(requestPayload.method).toBe('magic_get_info');
+  expect(requestPayload.params).toEqual([{ walletType: 'metamask' }]);
+});
diff --git a/packages/@magic-sdk/react-native-bare/src/index.ts b/packages/@magic-sdk/react-native-bare/src/index.ts
@@ -50,6 +50,7 @@ export const Magic = createSDK(SDKBaseReactNative, {
   version: process.env.BARE_REACT_NATIVE_VERSION!,
   bundleId: getBundleId(),
   defaultEndpoint: 'https://box.magic.link/',
+  defaultNFTEndpoint: 'https://nft-api.magic.link/',
   ViewController: ReactNativeWebViewController,
   configureStorage: /* istanbul ignore next */ async () => {
     const lf = localForage.createInstance({

diff --git a/packages/@magic-sdk/react-native-expo/src/index.ts b/packages/@magic-sdk/react-native-expo/src/index.ts
@@ -50,6 +50,7 @@ export const Magic = createSDK(SDKBaseReactNative, {
   version: process.env.EXPO_REACT_NATIVE_VERSION!,
   bundleId: Application.applicationId,
   defaultEndpoint: 'https://box.magic.link/',
+  defaultNFTEndpoint: 'https://nft-api.magic.link/',
   ViewController: ReactNativeWebViewController,
   configureStorage: /* istanbul ignore next */ async () => {
     const lf = localForage.createInstance({

diff --git a/packages/@magic-sdk/types/src/core/query-types.ts b/packages/@magic-sdk/types/src/core/query-types.ts
@@ -13,4 +13,5 @@ export interface QueryParameters {
   ext?: any;
   locale?: string;
   bundleId?: string;
+  nftEndpoint?: string;
 }
diff --git a/packages/magic-sdk/src/index.cdn.ts b/packages/magic-sdk/src/index.cdn.ts
@@ -14,6 +14,7 @@ const Magic = Object.assign(
     sdkName: 'magic-sdk',
     version: process.env.WEB_VERSION!,
     defaultEndpoint: 'https://auth.magic.link/',
+    defaultNFTEndpoint: 'https://nft-api.magic.link/',
     ViewController: IframeController,
     configureStorage: /* istanbul ignore next */ async () => {
       const lf = localForage.createInstance({

diff --git a/packages/magic-sdk/src/index.ts b/packages/magic-sdk/src/index.ts
@@ -13,6 +13,7 @@ export const Magic = createSDK(SDKBase, {
   sdkName: 'magic-sdk',
   version: process.env.WEB_VERSION!,
   defaultEndpoint: 'https://auth.magic.link/',
+  defaultNFTEndpoint: 'https://nft-api.magic.link/',
   ViewController: IframeController,
   configureStorage: async () => {
     const lf = localForage.createInstance({