@everstake/wallet-sdk-hysp-solana 1.4.1 → 1.5.0

package/dist/index.d.mts

@@ -89,6 +89,9 @@ declare const ERROR_MESSAGES: {
     VAULT_LOAD_ERROR: string;
     VAULT_NOT_FOUND_ERROR: string;
     TX_TOO_LARGE: string;
+    MEMO_REQUIRED_ERROR: string;
+    MEMO_TOO_LONG_ERROR: string;
+    MEMO_INVALID_CHARACTERS_ERROR: string;
 };
 
 /**
@@ -173,6 +176,9 @@ declare class HyspSolana extends Blockchain {
         VAULT_LOAD_ERROR: string;
         VAULT_NOT_FOUND_ERROR: string;
         TX_TOO_LARGE: string;
+        MEMO_REQUIRED_ERROR: string;
+        MEMO_TOO_LONG_ERROR: string;
+        MEMO_INVALID_CHARACTERS_ERROR: string;
     };
     protected ORIGINAL_ERROR_MESSAGES: {
         INITIALIZATION_ERROR: string;
@@ -183,6 +189,9 @@ declare class HyspSolana extends Blockchain {
         VAULT_LOAD_ERROR: string;
         VAULT_NOT_FOUND_ERROR: string;
         TX_TOO_LARGE: string;
+        MEMO_REQUIRED_ERROR: string;
+        MEMO_TOO_LONG_ERROR: string;
+        MEMO_INVALID_CHARACTERS_ERROR: string;
     };
     private connection;
     private vault;

package/dist/index.d.ts

@@ -89,6 +89,9 @@ declare const ERROR_MESSAGES: {
     VAULT_LOAD_ERROR: string;
     VAULT_NOT_FOUND_ERROR: string;
     TX_TOO_LARGE: string;
+    MEMO_REQUIRED_ERROR: string;
+    MEMO_TOO_LONG_ERROR: string;
+    MEMO_INVALID_CHARACTERS_ERROR: string;
 };
 
 /**
@@ -173,6 +176,9 @@ declare class HyspSolana extends Blockchain {
         VAULT_LOAD_ERROR: string;
         VAULT_NOT_FOUND_ERROR: string;
         TX_TOO_LARGE: string;
+        MEMO_REQUIRED_ERROR: string;
+        MEMO_TOO_LONG_ERROR: string;
+        MEMO_INVALID_CHARACTERS_ERROR: string;
     };
     protected ORIGINAL_ERROR_MESSAGES: {
         INITIALIZATION_ERROR: string;
@@ -183,6 +189,9 @@ declare class HyspSolana extends Blockchain {
         VAULT_LOAD_ERROR: string;
         VAULT_NOT_FOUND_ERROR: string;
         TX_TOO_LARGE: string;
+        MEMO_REQUIRED_ERROR: string;
+        MEMO_TOO_LONG_ERROR: string;
+        MEMO_INVALID_CHARACTERS_ERROR: string;
     };
     private connection;
     private vault;

package/dist/index.js

@@ -128,7 +128,10 @@ var ERROR_MESSAGES = {
   GET_BALANCE_ERROR: "An error occurred while fetching user token balance",
   VAULT_LOAD_ERROR: "An error occurred while loading vault info",
   VAULT_NOT_FOUND_ERROR: "Vault not found for token: {0}",
-  TX_TOO_LARGE: "Transaction exceeds the maximum size limit of 1232 bytes"
+  TX_TOO_LARGE: "Transaction exceeds the maximum size limit of 1232 bytes",
+  MEMO_REQUIRED_ERROR: "Memo is required. Please contact us to get your referrer ID.",
+  MEMO_TOO_LONG_ERROR: 'Invalid memo: "{0}". Must be max 64 characters',
+  MEMO_INVALID_CHARACTERS_ERROR: 'Invalid memo: "{0}". Must contain only [A-Za-z0-9:_-] characters'
 };
 
 // src/constants/index.ts
@@ -403,29 +406,22 @@ var HyspSolana = class extends Blockchain {
    * @returns Memo instruction
    */
   processMemo(memo) {
-    let processedMemo;
     if (!memo || memo.trim() === "") {
-      processedMemo = "SDK";
+      throw this.throwError("MEMO_REQUIRED_ERROR");
+    }
+    const trimmedMemo = memo.trim();
+    let processedMemo;
+    if (!trimmedMemo.startsWith("SDK")) {
+      processedMemo = `SDK:${trimmedMemo}`;
     } else {
-      const trimmedMemo = memo.trim();
-      if (trimmedMemo === "SDK") {
-        processedMemo = trimmedMemo;
-      } else if (!trimmedMemo.startsWith("SDK:")) {
-        processedMemo = `SDK:${trimmedMemo}`;
-      } else {
-        processedMemo = trimmedMemo;
-      }
+      processedMemo = trimmedMemo;
     }
     if (processedMemo.length > 64) {
-      throw new Error(
-        `Invalid memo: "${processedMemo}". Must be max 64 characters`
-      );
+      throw this.throwError("MEMO_TOO_LONG_ERROR", processedMemo);
     }
     const validPattern = /^[A-Za-z0-9:_-]*$/;
     if (!validPattern.test(processedMemo)) {
-      throw new Error(
-        `Invalid memo: "${processedMemo}". Must contain only [A-Za-z0-9:_-] characters`
-      );
+      throw this.throwError("MEMO_INVALID_CHARACTERS_ERROR", processedMemo);
     }
     return (0, import_memo.getAddMemoInstruction)({ memo: processedMemo });
   }

package/dist/index.mjs

@@ -113,7 +113,10 @@ var ERROR_MESSAGES = {
   GET_BALANCE_ERROR: "An error occurred while fetching user token balance",
   VAULT_LOAD_ERROR: "An error occurred while loading vault info",
   VAULT_NOT_FOUND_ERROR: "Vault not found for token: {0}",
-  TX_TOO_LARGE: "Transaction exceeds the maximum size limit of 1232 bytes"
+  TX_TOO_LARGE: "Transaction exceeds the maximum size limit of 1232 bytes",
+  MEMO_REQUIRED_ERROR: "Memo is required. Please contact us to get your referrer ID.",
+  MEMO_TOO_LONG_ERROR: 'Invalid memo: "{0}". Must be max 64 characters',
+  MEMO_INVALID_CHARACTERS_ERROR: 'Invalid memo: "{0}". Must contain only [A-Za-z0-9:_-] characters'
 };
 
 // src/constants/index.ts
@@ -388,29 +391,22 @@ var HyspSolana = class extends Blockchain {
    * @returns Memo instruction
    */
   processMemo(memo) {
-    let processedMemo;
     if (!memo || memo.trim() === "") {
-      processedMemo = "SDK";
+      throw this.throwError("MEMO_REQUIRED_ERROR");
+    }
+    const trimmedMemo = memo.trim();
+    let processedMemo;
+    if (!trimmedMemo.startsWith("SDK")) {
+      processedMemo = `SDK:${trimmedMemo}`;
     } else {
-      const trimmedMemo = memo.trim();
-      if (trimmedMemo === "SDK") {
-        processedMemo = trimmedMemo;
-      } else if (!trimmedMemo.startsWith("SDK:")) {
-        processedMemo = `SDK:${trimmedMemo}`;
-      } else {
-        processedMemo = trimmedMemo;
-      }
+      processedMemo = trimmedMemo;
     }
     if (processedMemo.length > 64) {
-      throw new Error(
-        `Invalid memo: "${processedMemo}". Must be max 64 characters`
-      );
+      throw this.throwError("MEMO_TOO_LONG_ERROR", processedMemo);
     }
     const validPattern = /^[A-Za-z0-9:_-]*$/;
     if (!validPattern.test(processedMemo)) {
-      throw new Error(
-        `Invalid memo: "${processedMemo}". Must contain only [A-Za-z0-9:_-] characters`
-      );
+      throw this.throwError("MEMO_INVALID_CHARACTERS_ERROR", processedMemo);
     }
     return getAddMemoInstruction({ memo: processedMemo });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@everstake/wallet-sdk-hysp-solana",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "HYSP Solana - Everstake Wallet SDK",
   "publishConfig": {
     "access": "public"
@@ -16,7 +16,7 @@
   },
   "sideEffects": false,
   "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "build": "pnpm run prebuild && tsup src/index.ts --format cjs,esm --dts",
     "type-check": "tsc",
     "lint": "eslint 'src/**/*.{ts,tsx}'",
     "prettier": "prettier --write 'src/**/*.{ts,tsx}'",
@@ -73,7 +73,17 @@
       "js-yaml@>=4.0.0 <4.1.1": ">=4.1.1",
       "glob@>=10.2.0 <10.5.0": ">=10.5.0",
       "js-yaml": ">=4.1.1",
-      "glob": ">=10.5.0"
+      "glob": ">=10.5.0",
+      "lodash@>=4.0.0 <=4.17.22": ">=4.17.23",
+      "diff@>=4.0.0 <4.0.4": ">=4.0.4",
+      "@isaacs/brace-expansion@<=5.0.0": ">=5.0.1",
+      "axios@>=1.0.0 <=1.13.4": ">=1.13.5",
+      "bn.js@>=5.0.0 <5.2.3": ">=5.2.3",
+      "rollup@>=4.0.0 <4.59.0": ">=4.59.0",
+      "minimatch@<10.2.3": ">=10.2.3",
+      "flatted@<3.4.0": ">=3.4.0",
+      "flatted@<=3.4.1": ">=3.4.2",
+      "picomatch@<4.0.4": ">=4.0.4"
     }
   }
 }

package/src/__tests__/processMemo.test.ts

@@ -0,0 +1,146 @@
+/**
+ * Copyright (c) 2025, Everstake.
+ * Licensed under the BSD-3-Clause License. See LICENSE file for details.
+ */
+
+import { HyspSolana } from '..';
+import { SupportedToken } from '../constants';
+import { WalletSDKError } from '../../../utils';
+
+// Create a test class to access protected methods
+class TestableHyspSolana extends HyspSolana {
+  public testProcessMemo(memo?: string) {
+    return this.processMemo(memo);
+  }
+}
+
+describe('HyspSolana processMemo method', () => {
+  const hyspSolana: TestableHyspSolana = new TestableHyspSolana(
+    'USDC' as SupportedToken,
+    'https://api.mainnet-beta.solana.com',
+  );
+
+  describe('Error cases', () => {
+    it('should throw MEMO_REQUIRED_ERROR when memo is undefined', () => {
+      expect(() => hyspSolana.testProcessMemo(undefined)).toThrow(
+        WalletSDKError,
+      );
+      expect(() => hyspSolana.testProcessMemo(undefined)).toThrow(
+        'Memo is required. Please contact us to get your referrer ID.',
+      );
+    });
+
+    it('should throw MEMO_REQUIRED_ERROR when memo is empty string', () => {
+      expect(() => hyspSolana.testProcessMemo('')).toThrow(WalletSDKError);
+      expect(() => hyspSolana.testProcessMemo('')).toThrow(
+        'Memo is required. Please contact us to get your referrer ID.',
+      );
+    });
+
+    it('should throw MEMO_REQUIRED_ERROR when memo is only whitespace', () => {
+      expect(() => hyspSolana.testProcessMemo('   ')).toThrow(WalletSDKError);
+      expect(() => hyspSolana.testProcessMemo('   ')).toThrow(
+        'Memo is required. Please contact us to get your referrer ID.',
+      );
+    });
+
+    it('should throw MEMO_TOO_LONG_ERROR when processed memo exceeds 64 characters', () => {
+      const longMemo = 'a'.repeat(70);
+      expect(() => hyspSolana.testProcessMemo(longMemo)).toThrow(
+        WalletSDKError,
+      );
+      expect(() => hyspSolana.testProcessMemo(longMemo)).toThrow(
+        'Must be max 64 characters',
+      );
+    });
+
+    it('should throw MEMO_INVALID_CHARACTERS_ERROR when memo contains invalid characters', () => {
+      expect(() => hyspSolana.testProcessMemo('test@domain')).toThrow(
+        WalletSDKError,
+      );
+      expect(() => hyspSolana.testProcessMemo('test@domain')).toThrow(
+        'Must contain only [A-Za-z0-9:_-] characters',
+      );
+    });
+
+    it('should throw MEMO_INVALID_CHARACTERS_ERROR when memo contains spaces', () => {
+      expect(() => hyspSolana.testProcessMemo('test memo')).toThrow(
+        WalletSDKError,
+      );
+      expect(() => hyspSolana.testProcessMemo('test memo')).toThrow(
+        'Must contain only [A-Za-z0-9:_-] characters',
+      );
+    });
+
+    it('should throw MEMO_INVALID_CHARACTERS_ERROR when memo contains special characters', () => {
+      expect(() => hyspSolana.testProcessMemo('test!memo#')).toThrow(
+        WalletSDKError,
+      );
+      expect(() => hyspSolana.testProcessMemo('test!memo#')).toThrow(
+        'Must contain only [A-Za-z0-9:_-] characters',
+      );
+    });
+  });
+
+  describe('Success cases', () => {
+    it('should prepend SDK: to memo without SDK prefix', () => {
+      const result = hyspSolana.testProcessMemo('acme:pilotQ1:prod:v1');
+
+      expect(new TextDecoder().decode(result.data)).toBe(
+        'SDK:acme:pilotQ1:prod:v1',
+      );
+    });
+
+    it('should keep memo unchanged when it starts with SDK (but not SDK:)', () => {
+      const result = hyspSolana.testProcessMemo('SDKtest');
+
+      expect(new TextDecoder().decode(result.data)).toBe('SDKtest');
+    });
+
+    it('should keep memo unchanged when it starts with SDK:', () => {
+      const result = hyspSolana.testProcessMemo('SDK:bankxyz::prod:v1');
+
+      expect(new TextDecoder().decode(result.data)).toBe(
+        'SDK:bankxyz::prod:v1',
+      );
+    });
+
+    it('should handle simple referrer ID', () => {
+      const result = hyspSolana.testProcessMemo('referrer123');
+
+      expect(new TextDecoder().decode(result.data)).toBe('SDK:referrer123');
+    });
+
+    it('should handle referrer ID with underscores and hyphens', () => {
+      const result = hyspSolana.testProcessMemo('test_ref-id_123');
+
+      expect(new TextDecoder().decode(result.data)).toBe('SDK:test_ref-id_123');
+    });
+
+    it('should handle referrer ID with colons', () => {
+      const result = hyspSolana.testProcessMemo('org:team:user');
+
+      expect(new TextDecoder().decode(result.data)).toBe('SDK:org:team:user');
+    });
+
+    it('should handle maximum allowed length without SDK prefix', () => {
+      const maxMemo = 'a'.repeat(59); // 59 + 'SDK:' = 63 chars (under limit)
+      const result = hyspSolana.testProcessMemo(maxMemo);
+
+      expect(new TextDecoder().decode(result.data)).toBe(`SDK:${maxMemo}`);
+    });
+
+    it('should handle maximum allowed length with SDK prefix', () => {
+      const maxMemo = 'SDK:' + 'a'.repeat(60); // exactly 64 chars
+      const result = hyspSolana.testProcessMemo(maxMemo);
+
+      expect(new TextDecoder().decode(result.data)).toBe(maxMemo);
+    });
+
+    it('should trim whitespace from memo', () => {
+      const result = hyspSolana.testProcessMemo('  referrer123  ');
+
+      expect(new TextDecoder().decode(result.data)).toBe('SDK:referrer123');
+    });
+  });
+});

package/src/__tests__/{transaction-size.ts → transaction-size.test.ts}

@@ -44,17 +44,19 @@ describe('HyspSolana Transaction Size Tests', () => {
   });
 
   describe('Transaction Size Limits', () => {
-    it('should check balance and error if insufficient shares', async () => {
+    it('should fetch user shares successfully', async () => {
       const userShares = await hyspSolana.getUserShares(
         PLACEHOLDER_USER_ADDRESS,
       );
 
       console.log(`User shares: ${userShares.result.toString()}`);
 
+      expect(userShares.result).toBeDefined();
+      expect(userShares.result).toBeInstanceOf(Decimal);
+
       if (userShares.result.lt(PLACEHOLDER_SHARES_AMOUNT)) {
-        console.warn('Insufficient shares for tests.');
-        fail(
-          'Insufficient shares for tests. Cannot proceed with transaction size tests.',
+        console.warn(
+          'Note: User has insufficient shares for withdrawal tests.',
         );
       }
     }, 30000);

package/src/constants/errors.ts

@@ -12,4 +12,9 @@ export const ERROR_MESSAGES = {
   VAULT_LOAD_ERROR: 'An error occurred while loading vault info',
   VAULT_NOT_FOUND_ERROR: 'Vault not found for token: {0}',
   TX_TOO_LARGE: 'Transaction exceeds the maximum size limit of 1232 bytes',
+  MEMO_REQUIRED_ERROR:
+    'Memo is required. Please contact us to get your referrer ID.',
+  MEMO_TOO_LONG_ERROR: 'Invalid memo: "{0}". Must be max 64 characters',
+  MEMO_INVALID_CHARACTERS_ERROR:
+    'Invalid memo: "{0}". Must contain only [A-Za-z0-9:_-] characters',
 };

package/src/hysp.ts

@@ -351,33 +351,29 @@ export class HyspSolana extends Blockchain {
    * @returns Memo instruction
    */
   protected processMemo(memo?: string): Instruction {
-    // Process memo text
-    let processedMemo: string;
+    // Check if memo is empty
     if (!memo || memo.trim() === '') {
-      processedMemo = 'SDK';
+      throw this.throwError('MEMO_REQUIRED_ERROR');
+    }
+
+    const trimmedMemo = memo.trim();
+    let processedMemo: string;
+
+    // If memo doesn't start with 'SDK', prepend 'SDK:'
+    if (!trimmedMemo.startsWith('SDK')) {
+      processedMemo = `SDK:${trimmedMemo}`;
     } else {
-      const trimmedMemo = memo.trim();
-      if (trimmedMemo === 'SDK') {
-        processedMemo = trimmedMemo;
-      } else if (!trimmedMemo.startsWith('SDK:')) {
-        processedMemo = `SDK:${trimmedMemo}`;
-      } else {
-        processedMemo = trimmedMemo;
-      }
+      processedMemo = trimmedMemo;
     }
 
     // Validate memo
     if (processedMemo.length > 64) {
-      throw new Error(
-        `Invalid memo: "${processedMemo}". Must be max 64 characters`,
-      );
+      throw this.throwError('MEMO_TOO_LONG_ERROR', processedMemo);
     }
 
     const validPattern = /^[A-Za-z0-9:_-]*$/;
     if (!validPattern.test(processedMemo)) {
-      throw new Error(
-        `Invalid memo: "${processedMemo}". Must contain only [A-Za-z0-9:_-] characters`,
-      );
+      throw this.throwError('MEMO_INVALID_CHARACTERS_ERROR', processedMemo);
     }
 
     return getAddMemoInstruction({ memo: processedMemo });

package/src/__tests__/index.ts

@@ -1,41 +0,0 @@
-/**
- * Copyright (c) 2025, Everstake.
- * Licensed under the BSD-3-Clause License. See LICENSE file for details.
- */
-
-import { HyspSolana } from '..';
-import { SupportedToken } from '../constants';
-
-// Create a test class to access protected methods
-class TestableHyspSolana extends HyspSolana {
-  public testProcessMemo(memo?: string) {
-    return this.processMemo(memo);
-  }
-}
-
-describe('HyspSolana processMemo method', () => {
-  const hyspSolana: TestableHyspSolana = new TestableHyspSolana(
-    'USDC' as SupportedToken,
-    'https://api.mainnet-beta.solana.com',
-  );
-
-  it('should return SDK when memo is empty', () => {
-    const result = hyspSolana.testProcessMemo('');
-
-    expect(new TextDecoder().decode(result.data)).toBe('SDK');
-  });
-
-  it('should prepend SDK: to memo without SDK prefix', () => {
-    const result = hyspSolana.testProcessMemo('acme:pilotQ1:prod:v1');
-
-    expect(new TextDecoder().decode(result.data)).toBe(
-      'SDK:acme:pilotQ1:prod:v1',
-    );
-  });
-
-  it('should keep memo unchanged when it has SDK prefix', () => {
-    const result = hyspSolana.testProcessMemo('SDK:bankxyz::prod:v1');
-
-    expect(new TextDecoder().decode(result.data)).toBe('SDK:bankxyz::prod:v1');
-  });
-});