@fystack/sdk 0.1.2 → 0.1.4

package/src/api.ts

@@ -10,10 +10,10 @@ import {
   TransactionStatusResponse,
   CreateWalletResponse,
   WalletCreationStatusResponse,
-  WalletType,
   WalletAsset,
-  AddressType,
-  DepositAddressResponse
+  DepositAddressResponse,
+  RescanTransactionParams,
+  WalletByWorkspaceResponse
 } from './types'
 import {
   CreateCheckoutPayload,
@@ -23,6 +23,7 @@ import {
   GetCheckoutPaymentResponse,
   GetCheckoutResponse
 } from './payment'
+import { AddressType, DestinationType, WalletPurpose, WalletType } from './enum'
 
 interface APIResponse {
   data: any
@@ -45,9 +46,18 @@ export interface WalletDetail {
   Address: string
 }
 
+export interface SweepTaskParams {
+  minTriggerValueUsd: number
+  destinationWalletId: string
+  destinationType: DestinationType
+}
+
 export interface CreateWalletPayload {
   name: string
   walletType: WalletType
+  walletPurpose?: WalletPurpose
+  sweepTaskParams?: SweepTaskParams
+  sweepTaskId?: string
 }
 
 export interface PaymentServiceParams {
@@ -55,11 +65,6 @@ export interface PaymentServiceParams {
   environment: Environment
 }
 
-export enum WalletAddressType {
-  Evm = 'evm',
-  Sol = 'sol'
-}
-
 async function composeAPIHeaders(
   credentials: APICredentials,
   httpMethod: string,
@@ -109,10 +114,14 @@ export class APIService {
     this.API = createAPI(environment)
   }
 
-  async getWalletDetail(
-    addressType: WalletAddressType = WalletAddressType.Evm,
-    walletId?: string
-  ): Promise<WalletDetail> {
+  async getWallets(workspaceId: string): Promise<WalletByWorkspaceResponse[]> {
+    const endpoint = this.API.endpoints.getWallets(workspaceId)
+    const headers = await composeAPIHeaders(this.credentials, 'GET', endpoint)
+    const response = await get(endpoint, headers)
+    return response.data
+  }
+
+  async getWalletDetail(addressType = AddressType.Evm, walletId?: string): Promise<WalletDetail> {
     const endpoint = this.API.endpoints.getWalletDetail(walletId)
     const headers = await composeAPIHeaders(this.credentials, 'GET', endpoint)
     console.info('headers', headers)
@@ -201,6 +210,18 @@ export class APIService {
     const response = await get(endpoint, headers)
     return response.data
   }
+
+  /**
+   * Rescans a transaction on a specific network
+   * @param params Transaction hash and network ID
+   * @returns API response
+   */
+  async rescanTransaction(params: RescanTransactionParams): Promise<void> {
+    const endpoint = this.API.endpoints.rescanTransaction()
+    const transformedParams = transformRescanTransactionParams(params)
+    const headers = await composeAPIHeaders(this.credentials, 'POST', endpoint, transformedParams)
+    await post(endpoint, transformedParams, headers)
+  }
 }
 
 export class PaymentService {
@@ -329,7 +350,23 @@ export function transformWalletDetail(data: Record<string, string>): WalletDetai
 export function transformCreateWalletPayload(data: CreateWalletPayload) {
   return {
     name: data.name,
-    wallet_type: data.walletType
+    wallet_type: data.walletType,
+    ...(data.walletPurpose !== undefined && { wallet_purpose: data.walletPurpose }),
+    ...(data.sweepTaskParams !== undefined && {
+      sweep_task_params: {
+        min_trigger_value_usd: data.sweepTaskParams?.minTriggerValueUsd,
+        destination_wallet_id: data.sweepTaskParams?.destinationWalletId,
+        destination_type: data.sweepTaskParams?.destinationType
+      }
+    }),
+    ...(data.sweepTaskId !== undefined && { sweep_task_id: data.sweepTaskId })
+  }
+}
+
+export function transformRescanTransactionParams(data: RescanTransactionParams) {
+  return {
+    tx_hash: data.txHash,
+    network_id: data.networkId
   }
 }
 

package/src/config.ts

@@ -11,6 +11,7 @@ export interface APIEndpoints {
   getSignStatus: (walletId: string, transactionId: string) => string
   getTransactionStatus: (walletId: string, transactionId: string) => string
   getWalletDetail: (walletId?: string) => string
+  getWallets: (workspaceId: string) => string
   createWallet: () => string
   createCheckout: () => string
   getCheckout: (checkoutId: string) => string
@@ -19,6 +20,7 @@ export interface APIEndpoints {
   getWalletCreationStatus: (walletId: string) => string
   getWalletAssets: (walletId: string) => string
   getDepositAddress: (walletId: string, addressType: string) => string
+  rescanTransaction: () => string
 }
 
 const getBaseURL = (env: Environment): string => {
@@ -26,7 +28,7 @@ const getBaseURL = (env: Environment): string => {
     case Environment.Local:
       return 'http://localhost:8150'
     case Environment.Sandbox:
-      return 'https://apex.void.exchange'
+      return 'https://api-dev.fystack.io'
     case Environment.Production:
       return 'https://api.fystack.io'
   }
@@ -50,6 +52,7 @@ const createAPI = (env: Environment): APIConfig => {
         walletId
           ? withBaseURL(`/web3/wallet-detail/${walletId}`)
           : withBaseURL('/web3/wallet-detail'),
+      getWallets: (workspaceId: string) => withBaseURL(`/workspaces/${workspaceId}/wallets`),
       createWallet: () => withBaseURL('/wallets'),
       createCheckout: () => withBaseURL('/checkouts'),
       getCheckout: (checkoutId: string) => withBaseURL(`/checkouts/${checkoutId}`),
@@ -67,7 +70,8 @@ const createAPI = (env: Environment): APIConfig => {
         withBaseURL(`/wallets/creation-status/${walletId}`),
       getWalletAssets: (walletId: string) => withBaseURL(`/wallets/${walletId}/assets`),
       getDepositAddress: (walletId: string, addressType: string) =>
-        withBaseURL(`/wallets/${walletId}/deposit-address?address_type=${addressType}`)
+        withBaseURL(`/wallets/${walletId}/deposit-address?address_type=${addressType}`),
+      rescanTransaction: () => withBaseURL('/networks/rescan-transaction')
     }
   }
 }

package/src/enum.ts

@@ -0,0 +1,52 @@
+// Wallets
+export enum WalletType {
+  Standard = 'standard',
+  MPC = 'mpc'
+}
+
+export enum WalletPurpose {
+  General = 'general',
+  Gastank = 'gas_tank',
+  Deployment = 'deployment',
+  Custody = 'custody',
+  User = 'user',
+  Payment = 'payment'
+}
+
+export enum WalletCreationStatus {
+  Pending = 'pending',
+  Success = 'success',
+  Error = 'error'
+}
+
+export enum AddressType {
+  Evm = 'evm',
+  Solana = 'sol',
+  Tron = 'tron'
+}
+
+export enum DestinationType {
+  InternalWallet = 'internal_wallet',
+  AddressBook = 'address_book'
+}
+
+export enum TxStatus {
+  Pending = 'pending',
+  Completed = 'completed',
+  Confirmed = 'confirmed',
+  Failed = 'failed',
+  PendingApproval = 'pending_approval',
+  Rejected = 'rejected'
+}
+
+export enum TxApprovalStatus {
+  Pending = 'pending',
+  Approved = 'approved',
+  Rejected = 'rejected'
+}
+
+export enum WalletRole {
+  Admin = 'wallet_admin',
+  Signer = 'wallet_signer',
+  Viewer = 'wallet_viewer'
+}

package/src/index.ts

@@ -3,5 +3,6 @@ export * from './signer'
 export * from './solanaSigner'
 export * from './api'
 export * from './types'
+export * from './enum'
 export * from './config'
 export * from './utils/statusPoller'

package/src/sdk.ts

@@ -1,20 +1,22 @@
 import { APIService } from './api'
-import { APICredentials, CreateWalletOptions } from './types'
 import { Environment } from './config'
 import { StatusPoller } from './utils/statusPoller'
 import {
-  WalletCreationStatus,
   CreateWalletResponse,
   WalletCreationStatusResponse,
-  WalletType,
   WalletAsset,
-  AddressType,
-  DepositAddressResponse
+  DepositAddressResponse,
+  APICredentials,
+  CreateWalletOptions,
+  RescanTransactionParams,
+  WalletByWorkspaceResponse
 } from './types'
 import { validateUUID } from './utils'
+import { AddressType, WalletCreationStatus, WalletType } from './enum'
 
 export interface SDKOptions {
   credentials: APICredentials
+  workspaceId?: string
   environment?: Environment
   logger?: boolean
 }
@@ -22,11 +24,18 @@ export interface SDKOptions {
 export class FystackSDK {
   private apiService: APIService
   private enableLogging: boolean
+  private workspaceId?: string
 
   constructor(options: SDKOptions) {
-    const { credentials, environment = Environment.Production, logger = false } = options
+    const {
+      credentials,
+      workspaceId,
+      environment = Environment.Production,
+      logger = false
+    } = options
     this.apiService = new APIService(credentials, environment)
     this.enableLogging = logger
+    this.workspaceId = workspaceId
   }
 
   private log(message: string): void {
@@ -45,11 +54,20 @@ export class FystackSDK {
     options: CreateWalletOptions,
     waitForCompletion: boolean = true
   ): Promise<CreateWalletResponse> {
-    const { name, walletType = WalletType.Standard } = options
+    const {
+      name,
+      walletType = WalletType.Standard,
+      sweepTaskParams,
+      walletPurpose,
+      sweepTaskId
+    } = options
 
     const response = await this.apiService.createWallet({
       name,
-      walletType
+      walletType,
+      walletPurpose,
+      sweepTaskParams,
+      sweepTaskId
     })
 
     if (waitForCompletion && response.status === WalletCreationStatus.Pending) {
@@ -59,6 +77,19 @@ export class FystackSDK {
     return response
   }
 
+  /**
+   * Gets all wallets for the workspace
+   * @returns Promise with list of wallets
+   */
+  async getWallets(): Promise<WalletByWorkspaceResponse[]> {
+    if (!this.workspaceId) {
+      throw new Error('Workspace ID is required. Please set workspaceId in the constructor.')
+    }
+
+    const wallets = await this.apiService.getWallets(this.workspaceId)
+    return wallets
+  }
+
   /**
    * Gets the current status of a wallet creation process
    * @param walletId The ID of the wallet being created
@@ -137,4 +168,19 @@ export class FystackSDK {
     const depositAddressInfo = await this.apiService.getDepositAddress(walletId, addressType)
     return depositAddressInfo
   }
+
+  /**
+   * Rescans a transaction on a specific network
+   * @param params Transaction hash and network ID
+   * @returns Promise that resolves when the rescan is initiated
+   */
+  async rescanTransaction(params: RescanTransactionParams): Promise<void> {
+    validateUUID(params.networkId, 'networkId')
+
+    if (!params.txHash || params.txHash.trim() === '') {
+      throw new Error('Invalid transaction hash provided')
+    }
+
+    await this.apiService.rescanTransaction(params)
+  }
 }

package/src/signer.ts

@@ -15,10 +15,11 @@ import {
   Signature
 } from 'ethers'
 import { TransactionRequest } from 'ethers/src.ts/providers'
-import { APIService, WalletDetail, WalletAddressType } from './api'
-import { APICredentials, TransactionStatusResponse, TxStatus, TransactionError } from './types'
+import { APIService, WalletDetail } from './api'
+import { APICredentials, TransactionStatusResponse, TransactionError } from './types'
 import { Environment } from './config'
 import { StatusPoller, StatusPollerOptions } from './utils/statusPoller'
+import { AddressType, TxStatus } from './enum'
 
 export class EtherSigner extends AbstractSigner {
   private address!: string
@@ -73,7 +74,7 @@ export class EtherSigner extends AbstractSigner {
     }
 
     const detail: WalletDetail = await this.APIService.getWalletDetail(
-      WalletAddressType.Evm,
+      AddressType.Evm,
       this.walletDetail?.WalletID
     )
 
@@ -168,6 +169,14 @@ export class EtherSigner extends AbstractSigner {
     const startTime = new Date()
     console.log(`[WalletSDK] Transaction started at: ${startTime.toLocaleString()}`)
 
+    if (!this.address) {
+      await this.getAddress()
+    }
+
+    if (!this.walletDetail) {
+      this.walletDetail = await this.APIService.getWalletDetail()
+    }
+
     // Replace any Addressable or ENS name with an address
     const { to, from } = await resolveProperties({
       to: tx.to ? resolveAddress(tx.to, this.provider) : undefined,
@@ -229,6 +238,10 @@ export class EtherSigner extends AbstractSigner {
       await this.getAddress()
     }
 
+    if (!this.walletDetail) {
+      this.walletDetail = await this.APIService.getWalletDetail()
+    }
+
     checkProvider(this, 'sendTransaction')
 
     // Only populate if gas fees are not set

package/src/solanaSigner.ts

@@ -1,10 +1,11 @@
-import { APIService, WalletAddressType, WalletDetail } from './api'
-import { APICredentials, TransactionStatusResponse, TxStatus, TransactionError } from './types'
+import { APIService, WalletDetail } from './api'
+import { APICredentials, TransactionStatusResponse, TransactionError } from './types'
 import { Environment } from './config'
 import { StatusPoller, StatusPollerOptions } from './utils/statusPoller'
 import { Transaction, PublicKey, VersionedTransaction } from '@solana/web3.js'
 import bs58 from 'bs58'
 import { Buffer } from 'buffer'
+import { AddressType, TxStatus } from './enum'
 
 export class SolanaSigner {
   private address!: string
@@ -56,7 +57,7 @@ export class SolanaSigner {
     }
 
     const detail: WalletDetail = await this.APIService.getWalletDetail(
-      WalletAddressType.Sol,
+      AddressType.Solana,
       this.walletDetail?.WalletID
     )
 

package/src/types.ts

@@ -1,3 +1,6 @@
+import { SweepTaskParams } from './api'
+import { TxApprovalStatus, TxStatus, WalletCreationStatus, WalletPurpose, WalletRole, WalletType } from './enum'
+
 export class TransactionError extends Error {
   constructor(
     message: string,
@@ -9,20 +12,6 @@ export class TransactionError extends Error {
     this.name = 'TransactionError'
   }
 }
-export enum TxStatus {
-  Pending = 'pending',
-  Completed = 'completed',
-  Confirmed = 'confirmed',
-  Failed = 'failed',
-  PendingApproval = 'pending_approval',
-  Rejected = 'rejected'
-}
-
-export enum TxApprovalStatus {
-  Pending = 'pending',
-  Approved = 'approved',
-  Rejected = 'rejected'
-}
 
 export interface APICredentials {
   apiKey: string
@@ -79,20 +68,12 @@ export interface TransactionStatusResponse {
   failed_reason?: string
 }
 
-// Wallets
-export enum WalletType {
-  Standard = 'standard',
-  MPC = 'mpc'
-}
-
 export interface CreateWalletOptions {
   name: string
   walletType: WalletType
-}
-export enum WalletCreationStatus {
-  Pending = 'pending',
-  Success = 'success',
-  Error = 'error'
+  walletPurpose?: WalletPurpose
+  sweepTaskParams?: SweepTaskParams
+  sweepTaskId?: string
 }
 
 export interface CreateWalletResponse {
@@ -152,13 +133,35 @@ export interface WalletAsset {
   asset: WalletAssetDetail
 }
 
-export enum AddressType {
-  Evm = 'evm',
-  Solana = 'sol'
-}
-
 export interface DepositAddressResponse {
   asset_id?: string
   address: string
   qr_code: string
 }
+
+export interface RescanTransactionParams {
+  txHash: string
+  networkId: string
+}
+
+export interface WalletResponse {
+  id: string
+  name: string
+  value_usd: string
+  role: WalletRole
+}
+
+export interface TopAssets {
+  symbol: string
+  logo_url: string
+}
+
+export interface WalletByWorkspaceResponse {
+  id: string
+  name: string
+  role: string
+  wallet_type: string
+  value_usd: string
+  top_assets: TopAssets[]
+  wallet_purpose: string
+}

package/test.js

@@ -1,76 +0,0 @@
-import { TypedDataEncoder, verifyTypedData, Signature } from 'ethers'
-
-// 0x2f71f2595162eaca40708bf6d6327d437e760b27d26f3a933389ebdb4eedf3b167008df6f1d403503c82a6d58da5659b14c578019603d6b138b2c03729c92af701
-// 0xd77d10c530b25d1ea6a466eb2b3169138b5ca0d1320ff54bbad000d97f686d0a314c5233844d84da5adf3580afa38c82d9595c22a985acfea02ca722c55df48a00
-// Example usage
-const address = '0xFFe120Fd4D5AB5A9f25b25c30620ac8ee3E1EF21'
-const jsonData = {
-  domain: {
-    name: 'Permit2',
-    chainId: '8453',
-    verifyingContract: '0x000000000022d473030f116ddee9f6b43ac78ba3'
-  },
-  types: {
-    PermitSingle: [
-      { name: 'details', type: 'PermitDetails' },
-      { name: 'spender', type: 'address' },
-      { name: 'sigDeadline', type: 'uint256' }
-    ],
-    PermitDetails: [
-      { name: 'token', type: 'address' },
-      { name: 'amount', type: 'uint160' },
-      { name: 'expiration', type: 'uint48' },
-      { name: 'nonce', type: 'uint48' }
-    ]
-  },
-  message: {
-    details: {
-      token: '0x0b3e328455c4059eeb9e3f84b5543f74e24e7e1b',
-      amount: '1461501637330902918203684832716283019655932542975',
-      expiration: '1743496074',
-      nonce: '0'
-    },
-    spender: '0x6ff5693b99212da76ad316178a184ab56d299b43',
-    sigDeadline: '1740905874'
-  }
-}
-const signature =
-  '0x032f29648f9c2d9d2524aef755c225b96121f2c9b01beee5869a70ef95eb089548dc41f71126dac83c1632738dbea12bf5c925715068e32dda0064701bfc019e00'
-
-async function verifySignature(address, jsonData, signature) {
-  try {
-    // Step 1: Compute the EIP-712 hash
-    const computedHash = TypedDataEncoder.hash(jsonData.domain, jsonData.types, jsonData.message)
-    console.log('🔹 Computed EIP-712 Hash:', computedHash)
-
-    // Step 2: Recover the signer address
-    const recoveredAddress = verifyTypedData(
-      jsonData.domain,
-      jsonData.types,
-      jsonData.message,
-      signature
-    )
-
-    console.log('✅ Recovered Address:', recoveredAddress)
-    console.log('🔹 Expected Address:', address)
-
-    // Step 3: Compare the addresses
-    const isValid = recoveredAddress.toLowerCase() === address.toLowerCase()
-    console.log('🔹 Is Signature Valid?', isValid)
-
-    // Step 4: Debug signature parts (r, s, v)
-    const sig = Signature.from(signature)
-    console.log('🔹 Signature Parts:')
-    console.log('   r:', sig.r)
-    console.log('   s:', sig.s)
-    console.log('   v:', sig.v)
-
-    return isValid
-  } catch (error) {
-    console.error('❌ Signature Verification Failed:', error)
-    return false
-  }
-}
-
-// Run verification
-verifySignature(address, jsonData, signature)