@everstake/wallet-sdk-hysp-solana 1.2.0 → 1.3.1

package/dist/index.d.mts

@@ -126,6 +126,8 @@ type Params = {
     };
     /** Instructions to be added after the main instructions  created by SDK */
     afterInstructions?: Instruction[];
+    /** Memo text to be included in the transaction */
+    memo?: string;
 };
 interface ShareToken {
     address: string;
@@ -271,6 +273,12 @@ declare class HyspSolana extends Blockchain {
      * @returns Returns a promise that resolves with the withdraw transaction response.
      */
     withdraw(userAddress: Address, sharesAmount: number | string | bigint | Decimal, params?: Params): Promise<ApiResponse<TransactionMessageWithLifetime>>;
+    /**
+     * Processes and creates a memo instruction according to SDK requirements
+     * @param memo - Input memo text
+     * @returns Memo instruction
+     */
+    protected processMemo(memo?: string): Instruction;
     private buildTx;
 }
 

package/dist/index.d.ts

@@ -126,6 +126,8 @@ type Params = {
     };
     /** Instructions to be added after the main instructions  created by SDK */
     afterInstructions?: Instruction[];
+    /** Memo text to be included in the transaction */
+    memo?: string;
 };
 interface ShareToken {
     address: string;
@@ -271,6 +273,12 @@ declare class HyspSolana extends Blockchain {
      * @returns Returns a promise that resolves with the withdraw transaction response.
      */
     withdraw(userAddress: Address, sharesAmount: number | string | bigint | Decimal, params?: Params): Promise<ApiResponse<TransactionMessageWithLifetime>>;
+    /**
+     * Processes and creates a memo instruction according to SDK requirements
+     * @param memo - Input memo text
+     * @returns Memo instruction
+     */
+    protected processMemo(memo?: string): Instruction;
     private buildTx;
 }
 

package/dist/index.js

@@ -31,6 +31,7 @@ module.exports = __toCommonJS(index_exports);
 // src/hysp.ts
 var import_kit2 = require("@solana/kit");
 var import_compute_budget = require("@solana-program/compute-budget");
+var import_memo = require("@solana-program/memo");
 var import_klend_sdk = require("@kamino-finance/klend-sdk");
 var import_decimal = require("decimal.js");
 
@@ -393,6 +394,38 @@ var HyspSolana = class extends Blockchain {
       throw this.handleError("WITHDRAW_ERROR", error);
     }
   }
+  /**
+   * Processes and creates a memo instruction according to SDK requirements
+   * @param memo - Input memo text
+   * @returns Memo instruction
+   */
+  processMemo(memo) {
+    let processedMemo;
+    if (!memo || memo.trim() === "") {
+      processedMemo = "SDK";
+    } else {
+      const trimmedMemo = memo.trim();
+      if (trimmedMemo === "SDK") {
+        processedMemo = trimmedMemo;
+      } else if (!trimmedMemo.startsWith("SDK:")) {
+        processedMemo = `SDK:${trimmedMemo}`;
+      } else {
+        processedMemo = trimmedMemo;
+      }
+    }
+    if (processedMemo.length > 64) {
+      throw new Error(
+        `Invalid memo: "${processedMemo}". Must be max 64 characters`
+      );
+    }
+    const validPattern = /^[A-Za-z0-9:_-]*$/;
+    if (!validPattern.test(processedMemo)) {
+      throw new Error(
+        `Invalid memo: "${processedMemo}". Must contain only [A-Za-z0-9:_-] characters`
+      );
+    }
+    return (0, import_memo.getAddMemoInstruction)({ memo: processedMemo });
+  }
   async buildTx(sender, instructions, params, lookupTableAddresses) {
     let transactionMessage = (0, import_kit2.pipe)(
       (0, import_kit2.createTransactionMessage)({ version: 0 }),
@@ -424,6 +457,13 @@ var HyspSolana = class extends Blockchain {
         transactionMessage
       );
     }
+    if (params?.memo !== void 0) {
+      const memoInstruction = this.processMemo(params.memo);
+      transactionMessage = (0, import_kit2.appendTransactionMessageInstruction)(
+        memoInstruction,
+        transactionMessage
+      );
+    }
     if (params?.afterInstructions) {
       for (const instruction of params.afterInstructions) {
         transactionMessage = (0, import_kit2.appendTransactionMessageInstruction)(

package/dist/index.mjs

@@ -16,6 +16,7 @@ import {
   getSetComputeUnitLimitInstruction,
   getSetComputeUnitPriceInstruction
 } from "@solana-program/compute-budget";
+import { getAddMemoInstruction } from "@solana-program/memo";
 import { KaminoVault } from "@kamino-finance/klend-sdk";
 import { Decimal } from "decimal.js";
 
@@ -378,6 +379,38 @@ var HyspSolana = class extends Blockchain {
       throw this.handleError("WITHDRAW_ERROR", error);
     }
   }
+  /**
+   * Processes and creates a memo instruction according to SDK requirements
+   * @param memo - Input memo text
+   * @returns Memo instruction
+   */
+  processMemo(memo) {
+    let processedMemo;
+    if (!memo || memo.trim() === "") {
+      processedMemo = "SDK";
+    } else {
+      const trimmedMemo = memo.trim();
+      if (trimmedMemo === "SDK") {
+        processedMemo = trimmedMemo;
+      } else if (!trimmedMemo.startsWith("SDK:")) {
+        processedMemo = `SDK:${trimmedMemo}`;
+      } else {
+        processedMemo = trimmedMemo;
+      }
+    }
+    if (processedMemo.length > 64) {
+      throw new Error(
+        `Invalid memo: "${processedMemo}". Must be max 64 characters`
+      );
+    }
+    const validPattern = /^[A-Za-z0-9:_-]*$/;
+    if (!validPattern.test(processedMemo)) {
+      throw new Error(
+        `Invalid memo: "${processedMemo}". Must contain only [A-Za-z0-9:_-] characters`
+      );
+    }
+    return getAddMemoInstruction({ memo: processedMemo });
+  }
   async buildTx(sender, instructions, params, lookupTableAddresses) {
     let transactionMessage = pipe(
       createTransactionMessage({ version: 0 }),
@@ -409,6 +442,13 @@ var HyspSolana = class extends Blockchain {
         transactionMessage
       );
     }
+    if (params?.memo !== void 0) {
+      const memoInstruction = this.processMemo(params.memo);
+      transactionMessage = appendTransactionMessageInstruction(
+        memoInstruction,
+        transactionMessage
+      );
+    }
     if (params?.afterInstructions) {
       for (const instruction of params.afterInstructions) {
         transactionMessage = appendTransactionMessageInstruction(

package/jest.config.ts

@@ -0,0 +1,18 @@
+import type { Config } from 'jest';
+
+const config: Config = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  verbose: true,
+  roots: ['<rootDir>/src'],
+  testMatch: ['**/__tests__/**/*.test.ts'],
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/*.d.ts',
+    '!src/**/index.ts',
+  ],
+  coverageDirectory: 'coverage',
+  coverageReporters: ['text', 'lcov', 'html'],
+};
+
+export default config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@everstake/wallet-sdk-hysp-solana",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "HYSP Solana - Everstake Wallet SDK",
   "publishConfig": {
     "access": "public"
@@ -20,8 +20,8 @@
     "type-check": "tsc",
     "lint": "eslint 'src/**/*.{ts,tsx}'",
     "prettier": "prettier --write 'src/**/*.{ts,tsx}'",
-    "test": "jest",
-    "prebuild": "pnpm run type-check && pnpm run lint"
+    "test": "jest --passWithNoTests",
+    "prebuild": "pnpm run type-check && pnpm run lint && npm run test"
   },
   "keywords": [
     "hysp",
@@ -44,6 +44,7 @@
   "dependencies": {
     "@kamino-finance/klend-sdk": "^7.3.4",
     "@solana-program/compute-budget": "^0.7.0",
+    "@solana-program/memo": "^0.10.0",
     "@solana/kit": "^3.0.3",
     "decimal.js": "^10.6.0"
   },
@@ -65,5 +66,14 @@
     "tsup": "^8.1.0",
     "typescript": "^5.5.3",
     "typescript-eslint": "^8.46.2"
+  },
+  "pnpm": {
+    "overrides": {
+      "js-yaml@<3.14.2": ">=3.14.2",
+      "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"
+    }
   }
 }

package/src/__tests__/index.ts

@@ -0,0 +1,41 @@
+/**
+ * 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');
+  });
+});

package/src/hysp.ts

@@ -28,6 +28,8 @@ import {
   getSetComputeUnitPriceInstruction,
 } from '@solana-program/compute-budget';
 
+import { getAddMemoInstruction } from '@solana-program/memo';
+
 import { KaminoVault, VaultHoldings, APY } from '@kamino-finance/klend-sdk';
 
 import { Decimal } from 'decimal.js';
@@ -341,6 +343,44 @@ export class HyspSolana extends Blockchain {
     }
   }
 
+  /**
+   * Processes and creates a memo instruction according to SDK requirements
+   * @param memo - Input memo text
+   * @returns Memo instruction
+   */
+  protected processMemo(memo?: string): Instruction {
+    // Process memo text
+    let processedMemo: string;
+    if (!memo || memo.trim() === '') {
+      processedMemo = 'SDK';
+    } else {
+      const trimmedMemo = memo.trim();
+      if (trimmedMemo === 'SDK') {
+        processedMemo = trimmedMemo;
+      } else if (!trimmedMemo.startsWith('SDK:')) {
+        processedMemo = `SDK:${trimmedMemo}`;
+      } else {
+        processedMemo = trimmedMemo;
+      }
+    }
+
+    // Validate memo
+    if (processedMemo.length > 64) {
+      throw new Error(
+        `Invalid memo: "${processedMemo}". Must be max 64 characters`,
+      );
+    }
+
+    const validPattern = /^[A-Za-z0-9:_-]*$/;
+    if (!validPattern.test(processedMemo)) {
+      throw new Error(
+        `Invalid memo: "${processedMemo}". Must contain only [A-Za-z0-9:_-] characters`,
+      );
+    }
+
+    return getAddMemoInstruction({ memo: processedMemo });
+  }
+
   private async buildTx(
     sender: string,
     instructions: Instruction[],
@@ -388,6 +428,15 @@ export class HyspSolana extends Blockchain {
       );
     }
 
+    // Add memo instruction if memo is provided in params
+    if (params?.memo !== undefined) {
+      const memoInstruction = this.processMemo(params.memo);
+      transactionMessage = appendTransactionMessageInstruction(
+        memoInstruction,
+        transactionMessage,
+      );
+    }
+
     if (params?.afterInstructions) {
       for (const instruction of params.afterInstructions) {
         transactionMessage = appendTransactionMessageInstruction(

package/src/types/index.ts

@@ -20,6 +20,8 @@ export type Params = {
   };
   /** Instructions to be added after the main instructions  created by SDK */
   afterInstructions?: Instruction[];
+  /** Memo text to be included in the transaction */
+  memo?: string;
 };
 
 export interface ShareToken {