@loyal-labs/transactions 0.1.0 → 0.1.2

package/README.md

@@ -34,6 +34,15 @@ const result = await client.deposit({
 
 console.log("Transaction:", result.signature);
 console.log("Deposited:", result.deposit.amount, "lamports");
+
+// Refund some of the deposit
+const refundResult = await client.refund({
+  username: "alice",
+  amountLamports: solToLamports(0.05), // 0.05 SOL
+});
+
+console.log("Refunded:", refundResult.signature);
+console.log("Remaining:", refundResult.deposit.amount, "lamports");
 ```
 
 ## Usage
@@ -146,6 +155,35 @@ interface DepositResult {
 }
 ```
 
+##### `refund(params): Promise<RefundResult>`
+
+Refund SOL from a deposit back to the depositor's wallet.
+
+```typescript
+interface RefundParams {
+  username: string;           // Telegram username (5-32 chars, without @)
+  amountLamports: number | bigint;  // Amount in lamports to refund
+  commitment?: Commitment;    // Optional, defaults to 'confirmed'
+}
+
+interface RefundResult {
+  signature: string;          // Transaction signature
+  deposit: DepositData;       // Updated deposit account data
+}
+```
+
+Example:
+
+```typescript
+const result = await client.refund({
+  username: "alice",
+  amountLamports: solToLamports(0.05),
+});
+
+console.log("Refunded:", result.signature);
+console.log("Remaining balance:", result.deposit.amount);
+```
+
 ##### `getDeposit(depositor, username): Promise<DepositData | null>`
 
 Fetch deposit data for a specific depositor and username.
@@ -275,7 +313,9 @@ try {
 
 Common errors:
 - `"Username must be between 5 and 32 characters"` - Invalid username length
-- `"Amount must be greater than 0"` - Invalid deposit amount
+- `"Amount must be greater than 0"` - Invalid amount
+- `"No deposit found for this username"` - Deposit doesn't exist (refund only)
+- `"Insufficient deposit"` - Refund amount exceeds deposit balance
 - `"Failed to fetch deposit account after transaction"` - Network/confirmation issue
 
 ## Development

package/dist/index.d.ts

@@ -40,7 +40,7 @@
  * const client = LoyalTransactionsClient.fromProvider(provider);
  */
 export { LoyalTransactionsClient } from "./src/LoyalTransactionsClient";
-export type { WalletSigner, WalletLike, DepositParams, DepositResult, DepositData, } from "./src/types";
+export type { WalletSigner, WalletLike, DepositParams, DepositResult, RefundParams, RefundResult, DepositData, } from "./src/types";
 export { isKeypair, isAnchorProvider, isWalletLike } from "./src/types";
 export { PROGRAM_ID, DEPOSIT_SEED, VAULT_SEED, LAMPORTS_PER_SOL, solToLamports, lamportsToSol, } from "./src/constants";
 export { findDepositPda, findVaultPda } from "./src/pda";

package/dist/index.js

@@ -473,6 +473,41 @@ class LoyalTransactionsClient {
       deposit
     };
   }
+  async refund(params) {
+    const { username, amountLamports, commitment = "confirmed" } = params;
+    if (!username || username.length < 5 || username.length > 32) {
+      throw new Error("Username must be between 5 and 32 characters");
+    }
+    if (amountLamports <= 0) {
+      throw new Error("Amount must be greater than 0");
+    }
+    const depositor = this.wallet.publicKey;
+    const currentDeposit = await this.getDeposit(depositor, username);
+    if (!currentDeposit) {
+      throw new Error("No deposit found for this username");
+    }
+    if (currentDeposit.amount < amountLamports) {
+      throw new Error("Insufficient deposit");
+    }
+    const [depositPda] = findDepositPda(depositor, username);
+    const [vaultPda] = findVaultPda();
+    const amountBN = new BN(amountLamports.toString());
+    const signature = await this.program.methods.refundDeposit(amountBN).accountsPartial({
+      depositor,
+      vault: vaultPda,
+      deposit: depositPda
+    }).rpc({ commitment });
+    console.log("Transaction:", signature);
+    const deposit = await this.getDeposit(depositor, username);
+    console.log("Deposit:", deposit);
+    if (!deposit) {
+      throw new Error("Failed to fetch deposit account after transaction");
+    }
+    return {
+      signature,
+      deposit
+    };
+  }
   async getDeposit(depositor, username) {
     const [depositPda] = findDepositPda(depositor, username);
     try {

package/dist/src/LoyalTransactionsClient.d.ts

@@ -1,7 +1,7 @@
 import { Connection, PublicKey, Keypair } from "@solana/web3.js";
 import { AnchorProvider, Program } from "@coral-xyz/anchor";
 import { type TelegramTransfer } from "./idl";
-import type { WalletSigner, WalletLike, DepositParams, DepositResult, DepositData } from "./types";
+import type { WalletSigner, WalletLike, DepositParams, DepositResult, RefundParams, RefundResult, DepositData } from "./types";
 /**
  * LoyalTransactionsClient - SDK for interacting with the Telegram Transfer program
  *
@@ -82,6 +82,25 @@ export declare class LoyalTransactionsClient {
      * console.log('Deposit amount:', result.deposit.amount);
      */
     deposit(params: DepositParams): Promise<DepositResult>;
+    /**
+     * Refund SOL from a deposit
+     *
+     * Withdraws the specified amount from the deposit back to the depositor's wallet.
+     * Only the original depositor can refund their deposit.
+     *
+     * @param params - Refund parameters
+     * @returns Transaction signature and updated deposit data
+     *
+     * @example
+     * const result = await client.refund({
+     *   username: 'alice',
+     *   amountLamports: 50_000_000, // 0.05 SOL
+     * });
+     *
+     * console.log('Signature:', result.signature);
+     * console.log('Remaining deposit:', result.deposit.amount);
+     */
+    refund(params: RefundParams): Promise<RefundResult>;
     /**
      * Get deposit data for a specific depositor and username
      *

package/dist/src/types.d.ts

@@ -36,6 +36,26 @@ export interface DepositResult {
     /** Updated deposit account data */
     deposit: DepositData;
 }
+/**
+ * Parameters for refunding SOL from a deposit
+ */
+export interface RefundParams {
+    /** Telegram username (without @, 5-32 characters) */
+    username: string;
+    /** Amount in lamports to refund */
+    amountLamports: number | bigint;
+    /** Transaction commitment level (default: 'confirmed') */
+    commitment?: Commitment;
+}
+/**
+ * Result of a successful refund transaction
+ */
+export interface RefundResult {
+    /** Transaction signature */
+    signature: string;
+    /** Updated deposit account data */
+    deposit: DepositData;
+}
 /**
  * Deposit account data structure
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loyal-labs/transactions",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "SDK for Telegram-based Solana deposits",
   "type": "module",
   "main": "./dist/index.js",
@@ -38,13 +38,13 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/loyal/solana-telegram-transactions.git",
+    "url": "https://github.com/loyal/loyal-app.git",
     "directory": "sdk/transactions"
   },
   "bugs": {
-    "url": "https://github.com/loyal/solana-telegram-transactions/issues"
+    "url": "https://github.com/loyal/loyal-app/issues"
   },
-  "homepage": "https://github.com/loyal/solana-telegram-transactions/tree/main/sdk/transactions#readme",
+  "homepage": "https://github.com/loyal/loyal-app/tree/main/sdk/transactions#readme",
   "peerDependencies": {
     "@coral-xyz/anchor": "^0.32.0",
     "@solana/web3.js": "^1.95.0"