Merge pull request #330 from Nacho1499/feat/light-version-SDK

feat/light version of SDK

Author: Otaiki1

sdk/LIGHT_VERSION.md

@@ -0,0 +1,27 @@
+# Tikka SDK Light Version
+
+A lightweight, framework-agnostic version of the Tikka SDK designed for mobile and browser integrations.
+
+## Features
+- **Zero NestJS Overheads**: No decorators or dependency injection logic.
+- **Small Footprint**: Target < 50kb gzipped.
+- **ESM Ready**: Optimized for modern bundlers (Vite, Webpack 5).
+
+## Usage
+Instead of the main entry, import from the light bundle:
+`import { RaffleService } from '@tikka/sdk/dist/light/index.light';`
+
+## Limitations
+- No NestJS Module support (`TikkaModule` is excluded).
+- Requires manual instantiation of services (e.g., `new RaffleService(rpcService)`).
+
+
+# Tikka SDK Light
+This version is optimized for mobile and browser environments.
+
+## How to use
+Import from `@tikka/sdk/dist/light/index.light`.
+
+## Exclusions
+- Does not include NestJS Modules or Providers.
+- Services must be instantiated manually (e.g., `new RpcService()`).

sdk/package.json

@@ -3,21 +3,30 @@
   "version": "0.1.0",
   "description": "NestJS SDK for Tikka Soroban contract interaction",
   "private": true,
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "tikka": "./bin/tikka.mjs"
+  },
   "scripts": {
     "build": "nest build",
+    "build:light": "tsc -p tsconfig.light.json",
     "start": "nest start",
     "start:dev": "nest start --watch",
     "start:debug": "nest start --debug --watch",
     "lint": "eslint \"{src,test}/**/*.ts\"",
     "test": "jest",
+    "tikka": "node bin/tikka.mjs",
     "examples:check": "tsc --project examples/tsconfig.json",
+    "example:cli": "node bin/tikka.mjs",
     "example:quickstart": "ts-node examples/quickstart.ts",
     "example:create-raffle": "ts-node examples/create-raffle.ts",
     "example:buy-tickets": "ts-node examples/buy-tickets.ts",
     "example:listen-events": "ts-node examples/listen-events.ts",
     "example:offline-signing": "ts-node examples/offline-signing.ts",
     "docs": "typedoc",
-    "docs:watch": "typedoc --watch"
+    "docs:watch": "typedoc --watch",
+    "size-check": "powershell (Get-Item dist/light/index.light.js).Length"
   },
   "dependencies": {
     "@albedo-link/intent": "^0.13.0",
@@ -27,12 +36,16 @@
     "@stellar/freighter-api": "^3.1.0",
     "@stellar/stellar-sdk": "^14.5.0",
     "bignumber.js": "^9.3.1",
+    "chalk": "^5.3.0",
+    "commander": "^12.1.0",
+    "inquirer": "^9.3.2",
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.8.0"
   },
   "devDependencies": {
     "@nestjs/cli": "^11.0.16",
     "@nestjs/testing": "^10.4.0",
+    "@types/inquirer": "^9.0.7",
     "@types/jest": "^30.0.0",
     "@types/node": "^22.0.0",
     "@typescript-eslint/eslint-plugin": "^8.56.1",
@@ -58,4 +71,4 @@
     },
     "testEnvironment": "node"
   }
-}
+}

sdk/src/index.light.ts

@@ -0,0 +1,4 @@
+export { RpcService } from './network/rpc.service';
+export { RaffleService } from './modules/raffle/raffle.service';
+export { TicketService } from './modules/ticket/ticket.service';
+export * from './types';

sdk/src/modules/admin/admin.service.spec.ts

@@ -33,7 +33,7 @@ describe('AdminService', () => {
 
       const result = await service.pause();
 
-      expect(contractService.invoke).toHaveBeenCalledWith('pause', []);
+      expect(contractService.invoke).toHaveBeenCalledWith('pause', [], expect.anything());
       expect(result).toEqual({ txHash: 'abc123', ledger: 100 });
     });
   });
@@ -48,7 +48,7 @@ describe('AdminService', () => {
 
       const result = await service.unpause();
 
-      expect(contractService.invoke).toHaveBeenCalledWith('unpause', []);
+     expect(contractService.invoke).toHaveBeenCalledWith('unpause', [], expect.anything());
       expect(result).toEqual({ txHash: 'def456', ledger: 101 });
     });
   });
@@ -95,7 +95,7 @@ describe('AdminService', () => {
 
       const result = await service.transferAdmin(newAdmin);
 
-      expect(contractService.invoke).toHaveBeenCalledWith('transfer_admin', [newAdmin]);
+      expect(contractService.invoke).toHaveBeenCalledWith('transfer_admin', [newAdmin], expect.anything());
       expect(result).toEqual({ txHash: 'ghi789', ledger: 102 });
     });
 
@@ -114,7 +114,7 @@ describe('AdminService', () => {
 
       const result = await service.acceptAdmin();
 
-      expect(contractService.invoke).toHaveBeenCalledWith('accept_admin', []);
+      expect(contractService.invoke).toHaveBeenCalledWith('accept_admin', [], expect.anything());
       expect(result).toEqual({ txHash: 'jkl012', ledger: 103 });
     });
   });

sdk/src/modules/raffle/raffle.service.spec.ts

@@ -1,10 +1,10 @@
-import { RaffleService } from './raffle.service';
-import { ContractService } from '../../contract/contract.service';
-import { ContractFn } from '../../contract/bindings';
-import { RaffleParams, RaffleData } from './raffle.types';
-import { nativeToScVal } from '@stellar/stellar-sdk';
+import { RaffleService } from "./raffle.service";
+import { ContractService } from "../../contract/contract.service";
+import { ContractFn } from "../../contract/bindings";
+import { RaffleParams, RaffleData } from "./raffle.types";
+import { nativeToScVal } from "@stellar/stellar-sdk";
 
-describe('RaffleService', () => {
+describe("RaffleService", () => {
   let service: RaffleService;
   let contractService: jest.Mocked<ContractService>;
 
@@ -18,20 +18,20 @@ describe('RaffleService', () => {
     service = new RaffleService(contractService);
   });
 
-  describe('create', () => {
-    it('should correctly format and invoke CREATE_RAFFLE', async () => {
+  describe("create", () => {
+    it("should correctly format and invoke CREATE_RAFFLE", async () => {
       const params: RaffleParams = {
-        ticketPrice: '10',
+        ticketPrice: "10",
         maxTickets: 100,
         endTime: Date.now() + 86400000, // +1 day
         allowMultiple: true,
-        asset: 'XLM',
-        metadataCid: 'QmTest',
+        asset: "XLM",
+        metadataCid: "QmTest",
       };
 
       const mockInvokeResult = {
         result: 1,
-        txHash: 'abc',
+        txHash: "abc",
         ledger: 100,
       };
 
@@ -42,51 +42,57 @@ describe('RaffleService', () => {
       expect(contractService.invoke).toHaveBeenCalledWith(
         ContractFn.CREATE_RAFFLE,
         expect.any(Array),
+        expect.anything(), // Add this to handle the metadata object
       );
+
       expect(result).toEqual({
         raffleId: 1,
-        txHash: 'abc',
+        txHash: "abc",
         ledger: 100,
       });
     });
 
-    it('should throw if ticketPrice is empty', async () => {
+    it("should throw if ticketPrice is empty", async () => {
       const params: RaffleParams = {
-        ticketPrice: '',
+        ticketPrice: "",
         maxTickets: 100,
         endTime: Date.now(),
         allowMultiple: true,
-        asset: 'XLM',
+        asset: "XLM",
       };
 
-      await expect(service.create(params)).rejects.toThrow('ticketPrice must be a non-empty string');
+      await expect(service.create(params)).rejects.toThrow(
+        "ticketPrice must be a non-empty string",
+      );
     });
 
-    it('should throw if maxTickets is not a positive integer', async () => {
+    it("should throw if maxTickets is not a positive integer", async () => {
       const params: RaffleParams = {
-        ticketPrice: '10',
+        ticketPrice: "10",
         maxTickets: 0,
         endTime: Date.now(),
         allowMultiple: true,
-        asset: 'XLM',
+        asset: "XLM",
       };
 
-      await expect(service.create(params)).rejects.toThrow('maxTickets must be a positive integer');
+      await expect(service.create(params)).rejects.toThrow(
+        "maxTickets must be a positive integer",
+      );
     });
   });
 
-  describe('get', () => {
-    it('should fetch and map raffle data', async () => {
+  describe("get", () => {
+    it("should fetch and map raffle data", async () => {
       const mockRawData = {
-        creator: 'G...',
+        creator: "G...",
         status: 1, // OPEN
         ticket_price: BigInt(100000000),
         max_tickets: 100,
         tickets_sold: 50,
         end_time: BigInt(1711545600), // example timestamp in seconds
-        asset: 'XLM',
+        asset: "XLM",
         allow_multiple: true,
-        metadata_cid: 'Qm...',
+        metadata_cid: "Qm...",
       };
 
       contractService.simulateReadOnly.mockResolvedValue(mockRawData);
@@ -99,18 +105,20 @@ describe('RaffleService', () => {
         [raffleId],
       );
       expect(result.raffleId).toBe(raffleId);
-      expect(result.ticketPrice).toBe('100000000');
+      expect(result.ticketPrice).toBe("100000000");
       expect(result.maxTickets).toBe(100);
       expect(result.endTime).toBe(1711545600 * 1000);
     });
 
-    it('should throw if raffleId is invalid', async () => {
-      await expect(service.get(-1)).rejects.toThrow('raffleId must be a positive integer');
+    it("should throw if raffleId is invalid", async () => {
+      await expect(service.get(-1)).rejects.toThrow(
+        "raffleId must be a positive integer",
+      );
     });
   });
 
-  describe('listActive', () => {
-    it('should return active raffle IDs', async () => {
+  describe("listActive", () => {
+    it("should return active raffle IDs", async () => {
       const mockIds = [1, 2, 3];
       contractService.simulateReadOnly.mockResolvedValue(mockIds);
 
@@ -124,8 +132,8 @@ describe('RaffleService', () => {
     });
   });
 
-  describe('listAll', () => {
-    it('should return all raffle IDs', async () => {
+  describe("listAll", () => {
+    it("should return all raffle IDs", async () => {
       const mockIds = [1, 2, 3, 4];
       contractService.simulateReadOnly.mockResolvedValue(mockIds);
 
@@ -139,22 +147,22 @@ describe('RaffleService', () => {
     });
   });
 
-  describe('cancel', () => {
-    it('should invoke CANCEL_RAFFLE', async () => {
+  describe("cancel", () => {
+    it("should invoke CANCEL_RAFFLE", async () => {
       const mockInvokeResult = {
         result: undefined,
-        txHash: 'hash',
+        txHash: "hash",
         ledger: 200,
       };
 
       contractService.invoke.mockResolvedValue(mockInvokeResult);
 
       const raffleId = 1;
-      const result = await service.cancel(raffleId);
-
+      const result = await service.cancel({ raffleId });
       expect(contractService.invoke).toHaveBeenCalledWith(
         ContractFn.CANCEL_RAFFLE,
         [raffleId],
+        expect.anything(), // Add this to handle the metadata object
       );
       expect(result).toEqual(mockInvokeResult);
     });

sdk/src/network/rpc.service.ts

@@ -1,6 +1,7 @@
 import { Injectable } from '@nestjs/common';
 import { rpc } from '@stellar/stellar-sdk';
-import { NetworkConfig, RpcConfig, DEFAULT_RPC_CONFIG } from './network.config';
+import { DEFAULT_RPC_CONFIG } from './network.config';
+import type { NetworkConfig, RpcConfig } from './network.config';
 import { TikkaSdkError, TikkaSdkErrorCode } from '../utils/errors';
 
 interface RequestOptions {

sdk/src/types.ts

@@ -0,0 +1,13 @@
+export interface Raffle {
+  id: string;
+  name: string;
+  ticketPrice: string;
+  status: string;
+}
+
+export interface NetworkConfig {
+  rpcUrl: string;
+  networkPassphrase: string;
+}
+
+// Add any other core interfaces used by your services

sdk/tsconfig.light.json

@@ -0,0 +1,24 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "ESNext",
+    "target": "ES2020",
+    "moduleResolution": "node",
+    "outDir": "./dist/light",
+    "rootDir": "src",
+    "declaration": true,
+    "isolatedModules": false, 
+    "emitDecoratorMetadata": false, 
+    "experimentalDecorators": true,
+    "skipLibCheck": true
+  },
+  "include": [
+    "src/index.light.ts",
+    "src/types.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "src/**/*.module.ts",
+    "src/contract/contract.service.ts"
+  ]
+}