@ultraos/wallet-sdk 0.0.4 → 0.0.5

package/src/lib/common/window-manager.spec.ts

@@ -1,65 +0,0 @@
-import { WindowManager } from './window-manager';
-import UltraWalletSdkConfig from '../config/ultra-wallet-sdk.config';
-
-describe('WindowManager', () => {
-  let windowManager: WindowManager;
-  const walletUrl = 'https://wallet.example.com';
-
-  let walletWindowMock: Window;
-
-  beforeEach(() => {
-    walletWindowMock = {
-      closed: false,
-      focus: jest.fn(),
-    } as unknown as Window;
-
-    (window as any).open = jest.fn(() => walletWindowMock);
-    Object.defineProperty(window, 'top', { value: 100 });
-    Object.defineProperty(window, 'screenLeft', { value: 200 });
-    Object.defineProperty(window, 'innerWidth', { value: 1200 });
-
-    windowManager = new WindowManager(walletUrl);
-  });
-
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
-
-  it('opens a new wallet window when none exists', () => {
-    windowManager.openOrReuseWallet();
-
-    expect(window.open).toHaveBeenCalledWith(
-      walletUrl,
-      '_blank',
-      expect.stringContaining(`width=${UltraWalletSdkConfig.width}`),
-    );
-    expect(windowManager.getWalletWindow()).toBe(walletWindowMock);
-  });
-
-  it('focuses existing wallet window if already open and not closed', () => {
-    windowManager['walletWindow'] = walletWindowMock;
-    windowManager.openOrReuseWallet();
-
-    expect(walletWindowMock.focus).toHaveBeenCalled();
-    expect(window.open).not.toHaveBeenCalled();
-  });
-
-  it('returns the current wallet window reference', () => {
-    windowManager['walletWindow'] = walletWindowMock;
-    const result = windowManager.getWalletWindow();
-    expect(result).toBe(walletWindowMock);
-  });
-
-  it('opens a new window if previous one was closed', () => {
-    const closedWindowMock = { closed: true } as unknown as Window;
-    windowManager['walletWindow'] = closedWindowMock;
-
-    windowManager.openOrReuseWallet();
-
-    expect(window.open).toHaveBeenCalledWith(
-      walletUrl,
-      '_blank',
-      expect.stringContaining(`width=${UltraWalletSdkConfig.width}`),
-    );
-  });
-});

package/src/lib/common/window-manager.ts

@@ -1,34 +0,0 @@
-import UltraWalletSdkConfig from '../config/ultra-wallet-sdk.config';
-
-export class WindowManager {
-  private currentWindow: Window;
-  private walletWindow: Window | null = null;
-  public readonly walletUrl: string;
-
-  constructor(walletUrl: string) {
-    this.currentWindow = window;
-    this.walletUrl = walletUrl;
-  }
-
-  openOrReuseWallet() {
-    if (this.walletWindow == null || this.walletWindow.closed) {
-      const height = UltraWalletSdkConfig.height;
-      const width = UltraWalletSdkConfig.width;
-      const top = this.currentWindow.top;
-      const left = this.currentWindow.screenLeft + this.currentWindow.innerWidth - width;
-
-      this.walletWindow = window.open(
-        this.walletUrl,
-        '_blank',
-        `width=${width},height=${height},top=${top},left=${left}`,
-      );
-    } else {
-      this.walletWindow.focus();
-    }
-  }
-
-  // Provides a reference to the wallet window
-  getWalletWindow(): Window | null {
-    return this.walletWindow;
-  }
-}

package/src/lib/config/ultra-wallet-sdk.config.ts

@@ -1,37 +0,0 @@
-interface UltraWalletSdkConfig {
-  width: number;
-  height: number;
-  walletUrls: {
-    mainnet: string;
-    testnet: string;
-  };
-  checkWindowInterval: number;
-  handshakeTimeout: number;
-  networkInfo: Record<
-    'mainnet' | 'testnet',
-    {
-      chainId: string;
-    }
-  >;
-}
-
-const UltraWalletSdkConfig: UltraWalletSdkConfig = Object.freeze({
-  width: 345,
-  height: 610,
-  walletUrls: {
-    mainnet: 'https://web-wallet.ultra.io',
-    testnet: 'https://web-wallet.staging.ultra.io',
-  },
-  networkInfo: {
-    mainnet: {
-      chainId: 'a9c481dfbc7d9506dc7e87e9a137c931b0a9303f64fd7a1d08b8230133920097',
-    },
-    testnet: {
-      chainId: '7fc56be645bb76ab9d747b53089f132dcb7681db06f0852cfa03eaf6f7ac80e9',
-    },
-  },
-  checkWindowInterval: 500,
-  handshakeTimeout: 10_000,
-});
-
-export default UltraWalletSdkConfig;

package/src/lib/interfaces/blockchain-transaction.interface.ts

@@ -1,21 +0,0 @@
-/**
- * Defines the structure of a blockchain transaction request to be signed by the Ultra Wallet.
- */
-export interface BlockchainTransaction {
-  /**
-   * The smart contract address or name to interact with.
-   */
-  contract: string;
-  /**
-   * The action or method to call on the contract.
-   */
-  action: string;
-  /**
-   * The data payload for the contract action.
-   */
-  data: any;
-  /**
-   * List of authorizations (account@permission) required for the transaction.
-   */
-  authorizations?: string[];
-}

package/src/lib/interfaces/connect-params.interface.ts

@@ -1,13 +0,0 @@
-/**
- * Optional parameters for establishing a connection with the Ultra Wallet.
- */
-export interface ConnectParams {
-  /**
-   * If true, do not prompt the user for permissions; share account info only if Dapp is already trusted.
-   */
-  onlyIfTrusted?: boolean;
-  /**
-   * Optional referral code to associate with the connection request.
-   */
-  referralCode?: string;
-}

package/src/lib/interfaces/error-enum.ts

@@ -1,15 +0,0 @@
-export enum SdkErrorCode {
-  USER_REJECTED_REQUEST = 4001,
-  WALLET_HANDSHAKE_TIMEOUT = 4300,
-  WALLET_WINDOW_UNAVAILABLE = 4301,
-  REQUESTED_RESOURCE_NOT_AVAILABLE = 32002,
-  UNKNOWN_ERROR = -32604,
-}
-
-export const SDK_ERROR_MESSAGE: { [key in SdkErrorCode]: string } = {
-  [SdkErrorCode.USER_REJECTED_REQUEST]: 'The user rejected the request.',
-  [SdkErrorCode.WALLET_HANDSHAKE_TIMEOUT]: 'Timeout to connect with the web wallet.',
-  [SdkErrorCode.WALLET_WINDOW_UNAVAILABLE]: 'The Web Wallet is not available.',
-  [SdkErrorCode.REQUESTED_RESOURCE_NOT_AVAILABLE]: 'Requested resource not available.',
-  [SdkErrorCode.UNKNOWN_ERROR]: 'Unknown error occurred.',
-};

package/src/lib/interfaces/index.ts

@@ -1,8 +0,0 @@
-export * from './blockchain-transaction.interface';
-export * from './connect-params.interface';
-export * from './error-enum';
-export * from './json-rpc-message.interface';
-export * from './purchase-item.interface';
-export * from './wallet-provider.interface';
-export * from './wallet-provider-response.interface';
-export * from './wallet-sdk-options.interface';

package/src/lib/interfaces/json-rpc-message.interface.ts

@@ -1,7 +0,0 @@
-export interface JsonRpcMessage {
-  jsonrpc: '2.0';
-  method: string;
-  params?: any;
-  id?: string;
-  result?: any;
-}

package/src/lib/interfaces/purchase-item.interface.ts

@@ -1,7 +0,0 @@
-/**
- * Enumeration of supported item types that can be purchased via the Ultra Wallet.
- */
-export enum PurchaseItemType {
-  UNIQ_FACTORY = 'UniqFactory',
-  GAME_FACTORY = 'GameFactory',
-}

package/src/lib/interfaces/wallet-provider-response.interface.ts

@@ -1,157 +0,0 @@
-/**
- * A generic wrapper for all Ultra Wallet SDK responses.
- * Encapsulates the status, data payload, and optional error messaging or codes.
- *
- * @template T The type of the data payload contained in the response.
- */
-export interface UltraResponse<T = any> {
-  /**
-   * The status of the response, e.g., success, fail, or error.
-   */
-  status: ResponseStatus;
-  /**
-   * The actual response data payload.
-   */
-  data: T;
-  /**
-   * Optional end-user-readable message, explaining what went wrong (if applicable).
-   */
-  message?: string;
-  /**
-   * Optional error or status code.
-   */
-  code?: number;
-}
-
-/**
- * Enumeration of possible response statuses returned by the Ultra Wallet SDK.
- */
-export enum ResponseStatus {
-  SUCCESS = 'success',
-  FAIL = 'fail',
-  ERROR = 'error',
-}
-
-/**
- * Represents the result of a disconnect request.
- * A boolean indicating whether the disconnection was successful.
- */
-export type DisconnectResponse = boolean;
-
-/**
- * Represents the result of a successful connection request, containing the user's account details.
- */
-export type ConnectResult = Array<{
-  /**
-   * The blockchain network identifier.
-   */
-  blockchainid: string;
-  /**
-   * The public key associated with the user's account.
-   */
-  publicKey: string;
-}>;
-
-/**
- * The result structure returned after a successful item purchase using the Ultra Wallet.
- * Contains metadata about the purchased items and the associated blockchain transaction.
- */
-export interface PurchaseItemResult {
-  /**
-   * An ID associated with the purchase order, used for support requests if required.
-   */
-  orderHash: string;
-
-  items: {
-    /**
-     * The ID of the minted Uniq.
-     */
-    artifactId: string;
-    /**
-     * The purchased item ID.
-     */
-    productId: string;
-    /**
-     * The ID of the transaction in the blockchain, useful for tracking the status and details of the transaction.
-     */
-    blockchainTransactionId: string;
-  }[];
-}
-
-/**
- * Represents the result returned after signing a message with the Ultra Wallet.
- */
-export interface SignMessageResult {
-  signature: string;
-}
-
-/**
- * Represents the result returned after signing a blockchain transaction with the Ultra Wallet.
- */
-export interface SignTransactionResult {
-  /**
-   * The hash of the signed blockchain transaction.
-   */
-  transactionHash?: string;
-  processed?: {
-    id: string;
-    block_num: number;
-    block_time: string; // ISO timestamp
-    producer_block_id: string | null;
-    receipt: {
-      status: string;
-      cpu_usage_us: number;
-      net_usage_words: number;
-    };
-    elapsed: number;
-    net_usage: number;
-    scheduled: boolean;
-    action_traces: ActionTrace[];
-    account_ram_delta: any | null;
-    except: any | null;
-    error_code: number | null;
-  };
-}
-
-export interface ActionTrace {
-  action_ordinal: number;
-  creator_action_ordinal: number;
-  closest_unnotified_ancestor_action_ordinal: number;
-  receipt: {
-    receiver: string;
-    act_digest: string;
-    global_sequence: number;
-    recv_sequence: number;
-    auth_sequence: [string, number][];
-    code_sequence: number;
-    abi_sequence: number;
-  };
-  receiver: string;
-  act: {
-    account: string;
-    name: string;
-    authorization: {
-      actor: string;
-      permission: string;
-    }[];
-    data: {
-      from: string;
-      to: string;
-      quantity: string;
-      memo: string;
-    };
-    hex_data: string;
-  };
-  context_free: boolean;
-  elapsed: number;
-  console: string;
-  trx_id: string;
-  block_num: number;
-  block_time: string;
-  producer_block_id: string | null;
-  account_ram_deltas: any[];
-  except: any | null;
-  error_code: number | null;
-  return_value_hex_data: string;
-  inline_traces: ActionTrace[];
-}

package/src/lib/interfaces/wallet-provider.interface.ts

@@ -1,55 +0,0 @@
-import { BlockchainTransaction } from './blockchain-transaction.interface';
-import { ConnectParams } from './connect-params.interface';
-import { PurchaseItemType } from './purchase-item.interface';
-import {
-  ConnectResult,
-  DisconnectResponse,
-  PurchaseItemResult,
-  SignMessageResult,
-  SignTransactionResult,
-  UltraResponse,
-} from './wallet-provider-response.interface';
-
-/**
- * Defines the minimal interface that a wallet provider must implement for the Ultra Wallet SDK.
- */
-export interface UltraWalletProvider {
-  /**
-   * Prompt the user for permission to share his wallet info with the 3rd party application.
-   * Once permission is established the first time, the 3rd party application will be whitelisted for future requests.
-   * @param params.onlyIfTrusted - Do not prompt the user for permissions. Share current account info if Dapp is already trusted,
-   *                               otherwise rejects the request.
-   */
-  connect(params?: ConnectParams): Promise<UltraResponse<ConnectResult>>;
-
-  /**
-   * Remove permission to interact with the 3rd party application
-   */
-  disconnect(): Promise<UltraResponse<DisconnectResponse>>;
-
-  /**
-   * Open a popup to sign a message
-   * @param message - The message to sign. The message should be prefixed with "0x:, UOSx:, or message:"
-   */
-  signMessage(message: string): Promise<UltraResponse<SignMessageResult>>;
-
-  /**
-   * Open a popup to sign a transaction
-   * @param transaction - The transaction to sign
-   */
-  signTransaction(
-    transaction: BlockchainTransaction | BlockchainTransaction[],
-  ): Promise<UltraResponse<SignTransactionResult>>;
-
-  /**
-   * Get current chain id
-   */
-  getChainId(): Promise<UltraResponse<string>>;
-
-  /**
-   * Open a popup to purchase an item
-   * @param {PurchaseItemType} itemType - The type of item to purchase
-   * @param {string} itemId - The id of the item to purchase
-   */
-  purchaseItem(itemType: PurchaseItemType, itemId: string): Promise<UltraResponse<PurchaseItemResult>>;
-}

package/src/lib/interfaces/wallet-sdk-options.interface.ts

@@ -1,9 +0,0 @@
-/**
- * Options to configure the UltraWalletClient behavior.
- * Used primarily when falling back to the Web Wallet if no Ultra extension is available.
- *
- * @property {('mainnet' | 'testnet' | string)} [environment] - Target environment; defaults to 'mainnet' if unspecified.
- */
-export interface UltraWalletSdkOptions {
-  environment?: 'mainnet' | 'testnet' | string;
-}

package/src/lib/providers/extension-provider/extension.provider.spec.ts

@@ -1,121 +0,0 @@
-import {
-  BlockchainTransaction,
-  ConnectParams,
-  ConnectResult,
-  PurchaseItemResult,
-  PurchaseItemType,
-  ResponseStatus,
-  SignMessageResult,
-  SignTransactionResult,
-  UltraResponse,
-} from '../../interfaces';
-import { ExtensionProvider } from './extension.provider';
-import UltraWalletSdkConfig from '../../config/ultra-wallet-sdk.config';
-
-describe('ExtensionProvider', () => {
-  let provider: ExtensionProvider;
-
-  const mockUltra: jest.Mocked<Window['ultra']> = {
-    connect: jest.fn(),
-    disconnect: jest.fn(),
-    signMessage: jest.fn(),
-    signTransaction: jest.fn(),
-    getChainId: jest.fn(),
-    purchaseItem: jest.fn(),
-  };
-
-  beforeEach(() => {
-    (window as any).ultra = mockUltra;
-    provider = new ExtensionProvider();
-  });
-
-  afterEach(() => {
-    delete (window as any).ultra;
-    jest.clearAllMocks();
-  });
-
-  it('calls connect with params', async () => {
-    const params: ConnectParams = {};
-    const expected: UltraResponse<ConnectResult> = {
-      status: ResponseStatus.SUCCESS,
-      data: [{ blockchainid: 'acc', publicKey: 'pk' }],
-    };
-    mockUltra.getChainId.mockResolvedValue({
-      status: ResponseStatus.SUCCESS,
-      data: UltraWalletSdkConfig.networkInfo.mainnet.chainId,
-    });
-    mockUltra.connect.mockResolvedValue(expected);
-
-    const result = await provider.connect(params);
-    expect(mockUltra.connect).toHaveBeenCalledWith(params);
-    expect(result).toEqual(expected);
-  });
-
-  it('throws an error when connect is called with mismatched chainId', async () => {
-    (window as any).ultra = {
-      getChainId: jest.fn().mockResolvedValue({ data: 'wrong-chain' }),
-      connect: jest.fn(),
-    };
-
-    const provider = new ExtensionProvider({ environment: 'testnet' });
-
-    await expect(provider.connect()).rejects.toThrow(
-      'Wallet environment mismatch: expected "testnet" chain, but received "wrong-chain". Please verify the SDK configuration and the connected network.',
-    );
-  });
-
-  it('calls disconnect', async () => {
-    const expected: UltraResponse<boolean> = { status: ResponseStatus.SUCCESS, data: true };
-    mockUltra.disconnect.mockResolvedValue(expected);
-
-    const result = await provider.disconnect();
-    expect(mockUltra.disconnect).toHaveBeenCalled();
-    expect(result).toEqual(expected);
-  });
-
-  it('calls signMessage', async () => {
-    const expected: UltraResponse<SignMessageResult> = {
-      status: ResponseStatus.SUCCESS,
-      data: { signature: '0xabc' },
-    };
-    mockUltra.signMessage.mockResolvedValue(expected);
-
-    const result = await provider.signMessage('hello');
-    expect(mockUltra.signMessage).toHaveBeenCalledWith('hello');
-    expect(result).toEqual(expected);
-  });
-
-  it('calls signTransaction', async () => {
-    const tx: BlockchainTransaction = { to: '0x123', amount: '42' } as any;
-    const expected: UltraResponse<SignTransactionResult> = {
-      status: ResponseStatus.SUCCESS,
-      data: { transactionHash: '0x999' },
-    };
-    mockUltra.signTransaction.mockResolvedValue(expected);
-
-    const result = await provider.signTransaction(tx);
-    expect(mockUltra.signTransaction).toHaveBeenCalledWith(tx);
-    expect(result).toEqual(expected);
-  });
-
-  it('calls getChainId', async () => {
-    const expected: UltraResponse<string> = { status: ResponseStatus.SUCCESS, data: 'ultra-chain' };
-    mockUltra.getChainId.mockResolvedValue(expected);
-
-    const result = await provider.getChainId();
-    expect(mockUltra.getChainId).toHaveBeenCalled();
-    expect(result).toEqual(expected);
-  });
-
-  it('calls purchaseItem', async () => {
-    const expected: UltraResponse<PurchaseItemResult> = {
-      status: ResponseStatus.SUCCESS,
-      data: { orderHash: 'abc123', items: [] },
-    };
-    mockUltra.purchaseItem.mockResolvedValue(expected);
-
-    const result = await provider.purchaseItem(PurchaseItemType.UNIQ_FACTORY, '123');
-    expect(mockUltra.purchaseItem).toHaveBeenCalledWith(PurchaseItemType.UNIQ_FACTORY, '123');
-    expect(result).toEqual(expected);
-  });
-});

package/src/lib/providers/extension-provider/extension.provider.ts

@@ -1,55 +0,0 @@
-import {
-  BlockchainTransaction,
-  ConnectParams,
-  ConnectResult,
-  PurchaseItemResult,
-  PurchaseItemType,
-  SignMessageResult,
-  SignTransactionResult,
-  UltraResponse,
-  UltraWalletProvider,
-  UltraWalletSdkOptions,
-} from '../../interfaces';
-import { isValidChain } from '../../utils/chain-validator';
-
-declare global {
-  interface Window {
-    ultra: UltraWalletProvider;
-  }
-}
-
-export class ExtensionProvider implements UltraWalletProvider {
-  constructor(private readonly options?: UltraWalletSdkOptions) {}
-
-  async connect(params?: ConnectParams): Promise<UltraResponse<ConnectResult>> {
-    const { data: chainId } = await window.ultra.getChainId();
-    if (!isValidChain(this.options?.environment, chainId)) {
-      throw new Error(
-        `Wallet environment mismatch: expected "${this.options?.environment}" chain, but received "${chainId}". Please verify the SDK configuration and the connected network.`,
-      );
-    }
-    return window.ultra.connect(params);
-  }
-
-  disconnect(): Promise<UltraResponse<boolean>> {
-    return window.ultra.disconnect();
-  }
-
-  signMessage(message: string): Promise<UltraResponse<SignMessageResult>> {
-    return window.ultra.signMessage(message);
-  }
-
-  signTransaction(
-    transaction: BlockchainTransaction | BlockchainTransaction[],
-  ): Promise<UltraResponse<SignTransactionResult>> {
-    return window.ultra.signTransaction(transaction);
-  }
-
-  getChainId(): Promise<UltraResponse<string>> {
-    return window.ultra.getChainId();
-  }
-
-  purchaseItem(itemType: PurchaseItemType, itemId: string): Promise<UltraResponse<PurchaseItemResult>> {
-    return window.ultra.purchaseItem(itemType, itemId);
-  }
-}

package/src/lib/providers/index.ts

@@ -1,2 +0,0 @@
-export * from './extension-provider/extension.provider';
-export * from './web-provider/web.provider';