@karn_lat/protocol-sdk 0.1.0-alpha.1

package/src/generated/valocracy/tsconfig.json

@@ -0,0 +1,98 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+    /* Language and Environment */
+    "target": "ESNext", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+    /* Modules */
+    "module": "NodeNext", /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "nodenext", /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+    /* Emit */
+    "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist", /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    // "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    // "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+    /* Type Checking */
+    // "strict": true, /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  },
+  "include": [
+    "src/*"
+  ]
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './clients/index.js';
+export * from './utils/index.js';
+export * from './react/index.js';
+export * from './wallet/index.js';

package/src/react/hooks/useGovernor.ts

@@ -0,0 +1,69 @@
+import { useState, useEffect } from 'react';
+import { useKarn } from '../providers/KarnProvider.js';
+
+export interface Proposal {
+  id: bigint;
+  proposer: string;
+  description: string;
+  votesFor: bigint;
+  votesAgainst: bigint;
+  startTime: bigint;
+  endTime: bigint;
+  executed: boolean;
+  // Add other proposal fields as needed
+}
+
+export interface UseGovernorResult {
+  proposal: Proposal | null;
+  isLoading: boolean;
+  error: Error | null;
+  refetch: () => Promise<void>;
+}
+
+/**
+ * React hook to fetch Governor contract proposal data
+ *
+ * @param proposalId - The proposal ID to query (optional)
+ * @returns Object containing proposal data, loading state, and refetch function
+ */
+
+
+export function useGovernor(proposalId?: bigint): UseGovernorResult {
+  const { governor } = useKarn();
+  const [proposal, setProposal] = useState<Proposal | null>(null);
+  const [isLoading, setIsLoading] = useState<boolean>(false);
+  const [error, setError] = useState<Error | null>(null);
+
+  const fetchData = async () => {
+    if (proposalId === undefined) {
+      setProposal(null);
+      setError(null);
+      return;
+    }
+
+    setIsLoading(true);
+    setError(null);
+
+    try {
+      const proposalData = await governor.getProposal(proposalId);
+      setProposal(proposalData as Proposal);
+    } catch (err) {
+      const error = err instanceof Error ? err : new Error('Failed to fetch proposal data');
+      setError(error);
+      console.error('useGovernor error:', error);
+    } finally {
+      setIsLoading(false);
+    }
+  };
+
+  useEffect(() => {
+    fetchData();
+  }, [proposalId?.toString()]);
+
+  return {
+    proposal,
+    isLoading,
+    error,
+    refetch: fetchData,
+  };
+}

package/src/react/hooks/useMultiWallet.ts

@@ -0,0 +1,169 @@
+/**
+ * React hook for multi-wallet support
+ *
+ * Provides React-friendly interface to WalletManager with automatic state updates
+ */
+
+
+
+import { useState, useEffect, useCallback, useRef } from 'react';
+import {
+  WalletManager,
+  WalletType,
+  WalletState,
+  WalletMetadata,
+  WalletConnection,
+  WalletEvent,
+  SignTransactionOptions,
+  WalletError,
+} from '../../wallet/index.js';
+
+export interface UseMultiWalletReturn {
+  /** Current wallet state */
+  state: WalletState;
+
+  /** List of available (installed) wallets */
+  availableWallets: WalletMetadata[];
+
+  /** List of all supported wallets (including unavailable) */
+  allWallets: WalletMetadata[];
+
+  /** Connect to a specific wallet */
+  connect: (walletType: WalletType) => Promise<WalletConnection>;
+
+  /** Disconnect from current wallet */
+  disconnect: () => Promise<void>;
+
+  /** Sign a transaction with current wallet */
+  signTransaction: (xdr: string, options?: SignTransactionOptions) => Promise<string>;
+
+  /** Sign a message (if supported) */
+  signMessage: (message: string) => Promise<string>;
+
+  /** Get current network (if supported) */
+  getNetwork: () => Promise<string>;
+
+  /** Get current address */
+  getAddress: () => Promise<string | null>;
+
+  /** Check if connected */
+  isConnected: () => Promise<boolean>;
+
+  /** Wallet manager instance (for advanced usage) */
+  manager: WalletManager;
+}
+
+/**
+ * Hook for multi-wallet support
+ */
+export function useMultiWallet(): UseMultiWalletReturn {
+
+  const managerRef = useRef<WalletManager>();
+  if (!managerRef.current) {
+    managerRef.current = new WalletManager();
+  }
+  const manager = managerRef.current;
+
+  const [state, setState] = useState<WalletState>(manager.getState());
+  const [availableWallets, setAvailableWallets] = useState<WalletMetadata[]>([]);
+  const [allWallets] = useState<WalletMetadata[]>(manager.getAllWallets());
+
+
+  useEffect(() => {
+    const handleConnect = () => setState(manager.getState());
+    const handleDisconnect = () => setState(manager.getState());
+    const handleAccountChanged = () => setState(manager.getState());
+    const handleNetworkChanged = () => setState(manager.getState());
+
+    manager.on(WalletEvent.CONNECT, handleConnect);
+    manager.on(WalletEvent.DISCONNECT, handleDisconnect);
+    manager.on(WalletEvent.ACCOUNT_CHANGED, handleAccountChanged);
+    manager.on(WalletEvent.NETWORK_CHANGED, handleNetworkChanged);
+
+    return () => {
+      manager.off(WalletEvent.CONNECT, handleConnect);
+      manager.off(WalletEvent.DISCONNECT, handleDisconnect);
+      manager.off(WalletEvent.ACCOUNT_CHANGED, handleAccountChanged);
+      manager.off(WalletEvent.NETWORK_CHANGED, handleNetworkChanged);
+    };
+  }, [manager]);
+
+
+  useEffect(() => {
+    let mounted = true;
+
+    async function loadAvailableWallets() {
+      const wallets = await manager.getAvailableWallets();
+      if (mounted) {
+        setAvailableWallets(wallets);
+      }
+    }
+
+    loadAvailableWallets();
+
+    return () => {
+      mounted = false;
+    };
+  }, [manager]);
+
+
+  const connect = useCallback(
+    async (walletType: WalletType): Promise<WalletConnection> => {
+      const connection = await manager.connect(walletType);
+      setState(manager.getState());
+      return connection;
+    },
+    [manager]
+  );
+
+
+  const disconnect = useCallback(async (): Promise<void> => {
+    await manager.disconnect();
+    setState(manager.getState());
+  }, [manager]);
+
+
+  const signTransaction = useCallback(
+    async (xdr: string, options?: SignTransactionOptions): Promise<string> => {
+      return await manager.signTransaction(xdr, options);
+    },
+    [manager]
+  );
+
+
+  const signMessage = useCallback(
+    async (message: string): Promise<string> => {
+      return await manager.signMessage(message);
+    },
+    [manager]
+  );
+
+
+  const getNetwork = useCallback(async (): Promise<string> => {
+    return await manager.getNetwork();
+  }, [manager]);
+
+
+  const getAddress = useCallback(async (): Promise<string | null> => {
+    return await manager.getAddress();
+  }, [manager]);
+
+
+  const isConnected = useCallback(async (): Promise<boolean> => {
+    return await manager.isConnected();
+  }, [manager]);
+
+  return {
+    state,
+    availableWallets,
+    allWallets,
+    connect,
+    disconnect,
+    signTransaction,
+    signMessage,
+    getNetwork,
+    getAddress,
+    isConnected,
+    manager,
+  };
+}

package/src/react/hooks/useTreasury.ts

@@ -0,0 +1,57 @@
+import { useState, useEffect } from 'react';
+import { useKarn } from '../providers/KarnProvider.js';
+
+export interface UseTreasuryResult {
+  claimableBalance: bigint | null;
+  isLoading: boolean;
+  error: Error | null;
+  refetch: () => Promise<void>;
+}
+
+/**
+ * React hook to fetch Treasury contract data for a member
+ *
+ * @param member - The member address to query (optional)
+ * @returns Object containing claimable balance, loading state, and refetch function
+ */
+
+
+export function useTreasury(member?: string): UseTreasuryResult {
+  const { treasury } = useKarn();
+  const [claimableBalance, setClaimableBalance] = useState<bigint | null>(null);
+  const [isLoading, setIsLoading] = useState<boolean>(false);
+  const [error, setError] = useState<Error | null>(null);
+
+  const fetchData = async () => {
+    if (!member) {
+      setClaimableBalance(null);
+      setError(null);
+      return;
+    }
+
+    setIsLoading(true);
+    setError(null);
+
+    try {
+      const balance = await treasury.getClaimableBalance(member);
+      setClaimableBalance(balance);
+    } catch (err) {
+      const error = err instanceof Error ? err : new Error('Failed to fetch treasury data');
+      setError(error);
+      console.error('useTreasury error:', error);
+    } finally {
+      setIsLoading(false);
+    }
+  };
+
+  useEffect(() => {
+    fetchData();
+  }, [member]);
+
+  return {
+    claimableBalance,
+    isLoading,
+    error,
+    refetch: fetchData,
+  };
+}

package/src/react/hooks/useValocracy.ts

@@ -0,0 +1,66 @@
+import { useState, useEffect } from 'react';
+import { useKarn } from '../providers/KarnProvider.js';
+
+export interface UseValocracyResult {
+  level: number | null;
+  mana: number | null;
+  isLoading: boolean;
+  error: Error | null;
+  refetch: () => Promise<void>;
+}
+
+/**
+ * React hook to fetch Valocracy contract data for an address
+ *
+ * @param address - The account address to query (optional)
+ * @returns Object containing level, mana, loading state, and refetch function
+ *
+ */
+export function useValocracy(address?: string): UseValocracyResult {
+  const { valocracy } = useKarn();
+  const [level, setLevel] = useState<number | null>(null);
+  const [mana, setMana] = useState<number | null>(null);
+  const [isLoading, setIsLoading] = useState<boolean>(false);
+  const [error, setError] = useState<Error | null>(null);
+
+  const fetchData = async () => {
+    if (!address) {
+      setLevel(null);
+      setMana(null);
+      setError(null);
+      return;
+    }
+
+    setIsLoading(true);
+    setError(null);
+
+    try {
+      // Fetch level and mana in parallel
+      const [levelResult, manaResult] = await Promise.all([
+        valocracy.getLevel(address),
+        valocracy.getMana(address),
+      ]);
+
+      setLevel(levelResult);
+      setMana(manaResult);
+    } catch (err) {
+      const error = err instanceof Error ? err : new Error('Failed to fetch Valocracy data');
+      setError(error);
+      console.error('useValocracy error:', error);
+    } finally {
+      setIsLoading(false);
+    }
+  };
+
+  useEffect(() => {
+    fetchData();
+  }, [address]);
+
+  return {
+    level,
+    mana,
+    isLoading,
+    error,
+    refetch: fetchData,
+  };
+}

package/src/react/hooks/useWallet.ts

@@ -0,0 +1,60 @@
+import { useState, useCallback, useEffect } from 'react';
+import * as freighter from '@stellar/freighter-api';
+// @ts-ignore
+const { isConnected, requestAccess, signTransaction } = freighter;
+
+interface WalletState {
+  isConnected: boolean;
+  address: string | null;
+  isConnecting: boolean;
+  error: string | null;
+}
+
+export const useWallet = () => {
+  const [state, setState] = useState<WalletState>({
+    isConnected: false,
+    address: null,
+    isConnecting: false,
+    error: null,
+  });
+
+  const connect = useCallback(async () => {
+    setState(prev => ({ ...prev, isConnecting: true, error: null }));
+    try {
+      const allowed = await requestAccess();
+      if (allowed) {
+
+          const address = allowed; 
+          if (address) {
+            setState({
+              isConnected: true,
+              address: address, // Type check: allowed is string
+              isConnecting: false,
+              error: null,
+            });
+          } else {
+             throw new Error("Access denied");
+          }
+      } else {
+        throw new Error("User denied access");
+      }
+    } catch (err: any) {
+      setState(prev => ({ ...prev, isConnecting: false, error: err.message || "Failed to connect" }));
+    }
+  }, []);
+
+  // Check connection on mount
+  useEffect(() => {
+    isConnected().then(async (connected) => {
+      if (connected) {
+
+      }
+    });
+  }, []);
+
+  return {
+    ...state,
+    connect,
+    signTransaction, // Expose freighter sign
+  };
+};

package/src/react/index.ts

@@ -0,0 +1,6 @@
+export * from './providers/KarnProvider.js';
+export * from './hooks/useValocracy.js';
+export * from './hooks/useGovernor.js';
+export * from './hooks/useTreasury.js';
+export * from './hooks/useWallet.js';
+export * from './hooks/useMultiWallet.js';

package/src/react/providers/KarnProvider.tsx

@@ -0,0 +1,63 @@
+import React, { createContext, useContext, useMemo, ReactNode } from 'react';
+import { ValocracyClient, GovernorClient, TreasuryClient } from '../../clients';
+
+export interface KarnConfig {
+  networkPassphrase: string;
+  rpcUrl: string;
+  contracts: {
+    valocracy: string;
+    governor: string;
+    treasury: string;
+  };
+}
+
+interface KarnContextValue {
+  valocracy: ValocracyClient;
+  governor: GovernorClient;
+  treasury: TreasuryClient;
+  config: KarnConfig;
+}
+
+const KarnContext = createContext<KarnContextValue | null>(null);
+
+export const useKarn = () => {
+  const context = useContext(KarnContext);
+  if (!context) {
+    throw new Error('useKarn must be used within a KarnProvider');
+  }
+  return context;
+};
+
+interface KarnProviderProps {
+  config: KarnConfig;
+  children: ReactNode;
+}
+
+export const KarnProvider: React.FC<KarnProviderProps> = ({ config, children }) => {
+  const clients = useMemo(() => {
+    return {
+      valocracy: new ValocracyClient(
+        config.networkPassphrase,
+        config.rpcUrl,
+        config.contracts.valocracy
+      ),
+      governor: new GovernorClient(
+        config.networkPassphrase,
+        config.rpcUrl,
+        config.contracts.governor
+      ),
+      treasury: new TreasuryClient(
+        config.networkPassphrase,
+        config.rpcUrl,
+        config.contracts.treasury
+      ),
+    };
+  }, [config.networkPassphrase, config.rpcUrl, config.contracts.valocracy, config.contracts.governor, config.contracts.treasury]);
+
+  const value: KarnContextValue = {
+    ...clients,
+    config,
+  };
+
+  return <KarnContext.Provider value={value}>{children}</KarnContext.Provider>;
+};

package/src/utils/decay.ts

@@ -0,0 +1,44 @@
+/**
+ * Client-side Mana decay calculation
+ */
+
+const MEMBER_FLOOR = 5;
+const VACANCY_PERIOD = 15552000; // 180 days in seconds
+
+/**
+ * Calculate current Mana based on level and last activity
+ *
+ * Formula: Mana = floor + bonus
+ * - floor = MEMBER_FLOOR (fixed constant, e.g. 5)
+ * - extra_level = level - floor
+ * - bonus = (extra_level * time_remaining) / VACANCY_PERIOD
+ *
+ * @param level Total level (including permanent)
+ * @param permanentLevel Permanent level (Founder badge)
+ * @param expiry Expiry timestamp (Unix seconds)
+ * @param currentTimestamp Current timestamp (Unix seconds)
+ * @returns Current Mana
+ */
+export function calculateMana(
+  level: number,
+  permanentLevel: number,
+  expiry: number,
+  currentTimestamp: number
+): number {
+  // 1. Calculate decaying portion
+  const decayingLevel = Math.max(0, level - permanentLevel);
+
+  
+  // 2. Calculate time remaining
+  const timeRemaining = Math.max(0, expiry - currentTimestamp);
+  
+  // 3. Calculate bonus
+  // Use Math.floor to match integer arithmetic
+  // bonus = (DecayingLevel * TimeRemaining) / VacancyPeriod
+  const bonus = Math.floor((decayingLevel * timeRemaining) / VACANCY_PERIOD);
+  
+  // 4. Default floor logic
+  // Contract: Mana = MemberFloor + bonus + PermanentLevel
+
+  return MEMBER_FLOOR + bonus + permanentLevel;
+}

package/src/utils/index.ts

@@ -0,0 +1,3 @@
+export * from './decay.js';
+export * from './simulation.js';
+export * from './polling.js';