Link lift n shift

packages/x-link/jest.config.cjs

@@ -1,5 +1,5 @@
 module.exports = {
-  testEnvironment: 'node',
+  testEnvironment: 'jsdom',
   moduleDirectories: ['node_modules', '<rootDir>/src'],
   modulePathIgnorePatterns: ['<rootDir>/dist/', '<rootDir>/backup/'],
   testRegex: '^.+\\.test\\.(js|ts|jsx|tsx)$',

packages/x-link/package.json

@@ -5,11 +5,13 @@
   "author": "Immutable",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
   "dependencies": {
-    "@imtbl/imx-sdk": "^3.8.0"
+    "qs": "^6.12.1",
+    "query-string": "^7.1.3"
   },
   "devDependencies": {
     "@rollup/plugin-typescript": "^11.0.0",
     "@swc/jest": "^0.2.24",
+    "@testing-library/jest-dom": "^5.16.5",
     "@types/jest": "^29.4.3",
     "eslint": "^8.40.0",
     "jest": "^29.4.3",

packages/x-link/src/index.ts

@@ -1 +1,9 @@
+export { LinkError } from './sdk-types';
 export * from './link';
+export {
+  Params as LinkParams,
+  Results as LinkResults,
+  ERC20TokenType,
+  ERC721TokenType,
+  ETHTokenType,
+} from './types';

packages/x-link/src/libs/constants.ts

@@ -0,0 +1,5 @@
+export enum LocalStorageKeys {
+  WALLET_ADDRESS = 'WALLET_ADDRESS',
+  STARK_PUBLIC_KEY = 'STARK_PUBLIC_KEY',
+  PROVIDER_PREFERENCE = 'PROVIDER_PREFERENCE',
+}

packages/x-link/src/libs/index.ts

@@ -0,0 +1 @@
+export * from './constants';

packages/x-link/src/link.ts

@@ -1,4 +1,6 @@
-import { Link as OldLink, ConfigurableIframeOptions } from '@imtbl/imx-sdk';
+// import { Link as OldLink, ConfigurableIframeOptions } from '@imtbl/imx-sdk';
+import { Link as OldLink } from './sdk';
+import { ConfigurableIframeOptions } from './sdk-types';
 
 import { Params, Results } from './types';
 

packages/x-link/src/sdk-types/iframe.ts

@@ -0,0 +1,26 @@
+export type IframePositionKeys = 'left' | 'right' | 'top' | 'bottom';
+
+export type IframePositionOptions = {
+  [key in IframePositionKeys]?: string;
+};
+
+export type IframeSizeOptions = {
+  width: number;
+  height: number;
+};
+
+export type FullIframeOptions = {
+  size: IframeSizeOptions;
+  position: IframePositionOptions;
+  className: string;
+  containerElement: HTMLElement;
+  protectAgainstGlobalStyleBleed: boolean;
+  hidden?: boolean;
+};
+
+export type ConfigurableIframeOptions = null | {
+  position?: IframePositionOptions;
+  className?: string;
+  containerElement?: HTMLElement;
+  protectAgainstGlobalStyleBleed?: boolean;
+};

packages/x-link/src/sdk-types/index.ts

@@ -0,0 +1,6 @@
+export * from './iframe';
+export * from './runtime';
+export * from './messages';
+export * from './static';
+export * from './routes';
+export * from './info-events';

packages/x-link/src/sdk-types/info-events.ts

@@ -0,0 +1,24 @@
+/**
+ * WT-1001
+ * These info events are dispatched by the SDK for Marketplaces and other applications which use Link, to listen to.
+ * This has been designed in conjunction with the postMessage messageType.info that Link can fire to pass
+ * data back to it's parent window (without closing Link itself).
+ */
+export const LINK_INFO_MESSAGE_TYPE = 'imx-link-info';
+
+export enum ImxLinkInfoEventType {
+  WALLET_CONNECTION = 'wallet-connection',
+}
+
+export type InfoEvent<T> = {
+  type: ImxLinkInfoEventType;
+  payload?: T;
+};
+
+export interface WalletConnectionInfoEvent {
+  walletAddress: string;
+  starkPublicKey: string;
+  providerPreference: string;
+  email: string;
+  ethNetwork: string;
+}

packages/x-link/src/sdk-types/messages.ts

@@ -0,0 +1,18 @@
+export const LINK_MESSAGE_TYPE = 'imx-link';
+export const messageTypes = {
+  inProgress: 'inProgress',
+  success: 'success',
+  fail: 'fail',
+  result: 'result',
+  close: 'close',
+  ready: 'ready',
+  transfer: 'transfer',
+  batchNftTransfer: 'batchNftTransfer',
+  sign: 'sign',
+  getPublicKey: 'getPublicKey',
+  // Triggered by the parent window for the parent window itself when a new
+  // subscriber to link events is registered. Used to make sure there's always
+  // only one subscriber to a Link window.
+  newSubscriber: 'newSubscriber',
+  info: 'info',
+};

packages/x-link/src/sdk-types/routes.ts

@@ -0,0 +1,33 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+export enum Routes {
+  'Home' = 'home',
+  'Setup' = 'setup',
+  'Buy' = 'buy',
+  'BuyV2' = 'v2/buy',
+  'Sell' = 'sell',
+  'Deposit' = 'deposit',
+  'History' = 'history',
+  'PrepareWithdrawal' = 'prepare-withdrawal',
+  'CompleteWithdrawal' = 'complete-withdrawal',
+  'Transfer' = 'transfer',
+  'TransferV2' = 'v2/transfer',
+  'BatchNftTransfer' = 'batch-nft-transfer',
+  'Sign' = 'sign',
+  'GetPublicKey' = 'get-public-key',
+  'Cancel' = 'cancel',
+  'Claim' = 'claim',
+  'ClaimUSInstant' = 'claim-instant',
+  'ClaimUSOverTime' = 'claim-over-time',
+  'ClaimUSOverTimeDetails' = 'claim-over-time-details',
+  'FiatToCrypto' = 'fiat-to-crypto',
+  'CryptoToFiat' = 'crypto-to-fiat',
+  'Offramp' = 'offramp',
+  'Onramp' = 'onramp',
+  'NFTCheckoutPrimary' = 'nft-checkout-primary',
+  'NFTCheckoutSecondary' = 'nft-checkout-secondary',
+  'MakeOffer' = 'make-offer',
+  'CancelOffer' = 'cancel-offer',
+  'AcceptOffer' = 'accept-offer',
+}
+
+export const messagingUrls = [Routes.BatchNftTransfer, Routes.Sign];

packages/x-link/src/sdk-types/runtime.ts

@@ -0,0 +1,20 @@
+export enum ERC721TokenType {
+  ERC721 = 'ERC721',
+}
+
+export interface FeeType {
+  recipient: string;
+  /**
+   * Percentage truncated to 2 d.p.
+   * 10.24 = 10.24%
+   */
+  percentage: number;
+}
+
+export enum ETHTokenType {
+  ETH = 'ETH',
+}
+
+export enum ERC20TokenType {
+  ERC20 = 'ERC20',
+}

packages/x-link/src/sdk-types/static.ts

@@ -0,0 +1,6 @@
+export class LinkError extends Error {
+  constructor(public code: number, message?: string) {
+    super(message ?? '');
+    Object.setPrototypeOf(this, LinkError.prototype);
+  }
+}