@frontiertower/frontier-sdk 0.9.0 → 0.11.0

package/README.md

@@ -28,7 +28,14 @@ if (!isInFrontierApp()) {
 }
 
 // Access wallet information
+/**
+ * The wallet balance is split into two types:
+ * - Frontier Dollar (FTD): Freely convertible to fiat currency.
+ * - Internal Frontier Dollar: Only convertible by Frontier Tower representatives;
+ *   designed for circulation within the Network Society.
+ */
 const balance = await sdk.getWallet().getBalance();
+console.log('Total FTD:', balance.total.toString());
 const address = await sdk.getWallet().getAddress();
 
 // Use persistent storage
@@ -50,6 +57,8 @@ Your app must declare required permissions in the Frontier app registry:
 - `wallet:approveERC20` - Approve ERC20 token spending
 - `wallet:transferNative` - Transfer native currency (ETH)
 - `wallet:transferFrontierDollar` - Transfer Frontier Dollars
+- `wallet:transferInternalFrontierDollar` - Transfer Internal Frontier Dollars
+- `wallet:transferOverallFrontierDollar` - Transfer Frontier Dollars with iFTD preferred
 - `wallet:executeCall` - Execute arbitrary contract calls
 - `wallet:executeBatchCall` - Execute multiple contract calls atomically
 - `wallet:getSupportedTokens` - Get list of supported tokens for swaps

package/dist/index.d.mts

@@ -19,6 +19,28 @@ interface SmartAccount {
     /** Creation timestamp */
     createdAt: string;
 }
+/**
+ * Wallet balance breakdown
+ */
+interface WalletBalance {
+    /** Total balance including both native and internal FTD */
+    total: bigint;
+    /** Native Frontier Dollar balance */
+    ftd: bigint;
+    /** Internal Frontier Dollar balance (for Network Society) */
+    internalFtd: bigint;
+}
+/**
+ * Formatted wallet balance breakdown
+ */
+interface WalletBalanceFormatted {
+    /** Total balance formatted with currency symbol */
+    total: string;
+    /** Native Frontier Dollar balance formatted with currency symbol */
+    ftd: string;
+    /** Internal Frontier Dollar balance formatted with currency symbol */
+    internalFtd: string;
+}
 /**
  * Transaction receipt from a user operation
  */
@@ -124,37 +146,38 @@ declare class WalletAccess {
     private sdk;
     constructor(sdk: FrontierSDK);
     /**
-     * Get the current wallet balance
+     * Get the current wallet balance breakdown
      *
-     * Returns the total USD stablecoin balance for the current network,
-     * normalized to 18 decimals for consistency.
+     * Returns the balance breakdown including total, native FTD,
+     * and internal FTD amounts.
      *
-     * @returns Balance as bigint (18 decimals)
+     * @returns Balance breakdown object
      * @throws {Error} If no wallet exists
      *
      * @example
      * ```typescript
      * const balance = await sdk.getWallet().getBalance();
-     * console.log('Balance:', balance.toString());
+     * console.log('Total Balance:', balance.total.toString());
+     * console.log('FTD Balance:', balance.ftd.toString());
      * ```
      */
-    getBalance(): Promise<bigint>;
+    getBalance(): Promise<WalletBalance>;
     /**
      * Get the current wallet balance formatted for display
      *
-     * Returns the total USD stablecoin balance as a formatted string
-     * with currency symbol (e.g., '$10.50').
+     * Returns the balance breakdown as formatted strings
+     * with currency symbol (e.g., { total: '$10.50', ... }).
      *
-     * @returns Formatted balance string with $ sign
+     * @returns Formatted balance breakdown object
      * @throws {Error} If no wallet exists
      *
      * @example
      * ```typescript
      * const balance = await sdk.getWallet().getBalanceFormatted();
-     * console.log('Balance:', balance); // '$10.50'
+     * console.log('Total:', balance.total); // '$10.50'
      * ```
      */
-    getBalanceFormatted(): Promise<string>;
+    getBalanceFormatted(): Promise<WalletBalanceFormatted>;
     /**
      * Get the wallet address for the current network
      *
@@ -310,6 +333,48 @@ declare class WalletAccess {
      * ```
      */
     transferFrontierDollar(to: string, amount: string, overrides?: GasOverrides): Promise<UserOperationReceipt>;
+    /**
+     * Transfer Internal Frontier Dollars to another address
+     *
+     * Sends Internal Frontier Dollars (for Network Society spending) to a recipient address.
+     * Requires biometric authentication and sufficient balance.
+     *
+     * @param to - Recipient address
+     * @param amount - Amount to send (as string, e.g., '10.5' for 10.5 Frontier Dollars)
+     * @param overrides - Optional gas overrides
+     * @returns User operation receipt with transaction details
+     * @throws {Error} If insufficient balance or transaction fails
+     *
+     * @example
+     * ```typescript
+     * const receipt = await sdk.getWallet().transferInternalFrontierDollar(
+     *   '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
+     *   '10.5' // 10.5 Internal Frontier Dollars
+     * );
+     * ```
+     */
+    transferInternalFrontierDollar(to: string, amount: string, overrides?: GasOverrides): Promise<UserOperationReceipt>;
+    /**
+     * Transfer Frontier Dollars with Internal Frontier Dollars (iFTD) preferred
+     *
+     * This method will use Internal Frontier Dollars first, and if insufficient,
+     * it will use regular Frontier Dollars to complete the transfer.
+     *
+     * @param to - Recipient address
+     * @param amount - Amount to send (as string, e.g., '10.5')
+     * @param overrides - Optional gas overrides
+     * @returns User operation receipt with transaction details
+     * @throws {Error} If insufficient total balance or transaction fails
+     *
+     * @example
+     * ```typescript
+     * const receipt = await sdk.getWallet().transferOverallFrontierDollar(
+     *   '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
+     *   '10.5'
+     * );
+     * ```
+     */
+    transferOverallFrontierDollar(to: string, amount: string, overrides?: GasOverrides): Promise<UserOperationReceipt>;
     /**
      * Execute multiple calls atomically with a single signature
      *
@@ -1501,4 +1566,4 @@ interface SDKResponse {
     error?: string;
 }
 
-export { type App, type AppPermission, type AppStatus, ChainAccess, type ChainConfig, type CreateAppRequest, type CreateSponsorPassRequest, type CreateWebhookRequest, type Developer, type ExecuteCall, FrontierSDK, type GasOverrides, type ListParams, type ListSponsorsParams, type PaginatedResponse, PartnershipsAccess, type ReferralDetails, type ReferralOverview, type RotateKeyResponse, type RotateWebhookKeyResponse, type SDKRequest, type SDKResponse, type SmartAccount, type Sponsor, type SponsorPass, StorageAccess, type SwapParams, type SwapQuote, type SwapResult, SwapResultStatus, ThirdPartyAccess, type UpdateAppRequest, type UpdateDeveloperRequest, type UpdateWebhookRequest, type User, UserAccess, type UserContact, type UserContactPayload, type UserOperationReceipt, type UserProfile, WalletAccess, type Webhook, type WebhookConfig, type WebhookEvent, type WebhookScope, type WebhookStatus };
+export { type App, type AppPermission, type AppStatus, ChainAccess, type ChainConfig, type CreateAppRequest, type CreateSponsorPassRequest, type CreateWebhookRequest, type Developer, type ExecuteCall, FrontierSDK, type GasOverrides, type ListParams, type ListSponsorsParams, type PaginatedResponse, PartnershipsAccess, type ReferralDetails, type ReferralOverview, type RotateKeyResponse, type RotateWebhookKeyResponse, type SDKRequest, type SDKResponse, type SmartAccount, type Sponsor, type SponsorPass, StorageAccess, type SwapParams, type SwapQuote, type SwapResult, SwapResultStatus, ThirdPartyAccess, type UpdateAppRequest, type UpdateDeveloperRequest, type UpdateWebhookRequest, type User, UserAccess, type UserContact, type UserContactPayload, type UserOperationReceipt, type UserProfile, WalletAccess, type WalletBalance, type WalletBalanceFormatted, type Webhook, type WebhookConfig, type WebhookEvent, type WebhookScope, type WebhookStatus };

package/dist/index.d.ts

@@ -19,6 +19,28 @@ interface SmartAccount {
     /** Creation timestamp */
     createdAt: string;
 }
+/**
+ * Wallet balance breakdown
+ */
+interface WalletBalance {
+    /** Total balance including both native and internal FTD */
+    total: bigint;
+    /** Native Frontier Dollar balance */
+    ftd: bigint;
+    /** Internal Frontier Dollar balance (for Network Society) */
+    internalFtd: bigint;
+}
+/**
+ * Formatted wallet balance breakdown
+ */
+interface WalletBalanceFormatted {
+    /** Total balance formatted with currency symbol */
+    total: string;
+    /** Native Frontier Dollar balance formatted with currency symbol */
+    ftd: string;
+    /** Internal Frontier Dollar balance formatted with currency symbol */
+    internalFtd: string;
+}
 /**
  * Transaction receipt from a user operation
  */
@@ -124,37 +146,38 @@ declare class WalletAccess {
     private sdk;
     constructor(sdk: FrontierSDK);
     /**
-     * Get the current wallet balance
+     * Get the current wallet balance breakdown
      *
-     * Returns the total USD stablecoin balance for the current network,
-     * normalized to 18 decimals for consistency.
+     * Returns the balance breakdown including total, native FTD,
+     * and internal FTD amounts.
      *
-     * @returns Balance as bigint (18 decimals)
+     * @returns Balance breakdown object
      * @throws {Error} If no wallet exists
      *
      * @example
      * ```typescript
      * const balance = await sdk.getWallet().getBalance();
-     * console.log('Balance:', balance.toString());
+     * console.log('Total Balance:', balance.total.toString());
+     * console.log('FTD Balance:', balance.ftd.toString());
      * ```
      */
-    getBalance(): Promise<bigint>;
+    getBalance(): Promise<WalletBalance>;
     /**
      * Get the current wallet balance formatted for display
      *
-     * Returns the total USD stablecoin balance as a formatted string
-     * with currency symbol (e.g., '$10.50').
+     * Returns the balance breakdown as formatted strings
+     * with currency symbol (e.g., { total: '$10.50', ... }).
      *
-     * @returns Formatted balance string with $ sign
+     * @returns Formatted balance breakdown object
      * @throws {Error} If no wallet exists
      *
      * @example
      * ```typescript
      * const balance = await sdk.getWallet().getBalanceFormatted();
-     * console.log('Balance:', balance); // '$10.50'
+     * console.log('Total:', balance.total); // '$10.50'
      * ```
      */
-    getBalanceFormatted(): Promise<string>;
+    getBalanceFormatted(): Promise<WalletBalanceFormatted>;
     /**
      * Get the wallet address for the current network
      *
@@ -310,6 +333,48 @@ declare class WalletAccess {
      * ```
      */
     transferFrontierDollar(to: string, amount: string, overrides?: GasOverrides): Promise<UserOperationReceipt>;
+    /**
+     * Transfer Internal Frontier Dollars to another address
+     *
+     * Sends Internal Frontier Dollars (for Network Society spending) to a recipient address.
+     * Requires biometric authentication and sufficient balance.
+     *
+     * @param to - Recipient address
+     * @param amount - Amount to send (as string, e.g., '10.5' for 10.5 Frontier Dollars)
+     * @param overrides - Optional gas overrides
+     * @returns User operation receipt with transaction details
+     * @throws {Error} If insufficient balance or transaction fails
+     *
+     * @example
+     * ```typescript
+     * const receipt = await sdk.getWallet().transferInternalFrontierDollar(
+     *   '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
+     *   '10.5' // 10.5 Internal Frontier Dollars
+     * );
+     * ```
+     */
+    transferInternalFrontierDollar(to: string, amount: string, overrides?: GasOverrides): Promise<UserOperationReceipt>;
+    /**
+     * Transfer Frontier Dollars with Internal Frontier Dollars (iFTD) preferred
+     *
+     * This method will use Internal Frontier Dollars first, and if insufficient,
+     * it will use regular Frontier Dollars to complete the transfer.
+     *
+     * @param to - Recipient address
+     * @param amount - Amount to send (as string, e.g., '10.5')
+     * @param overrides - Optional gas overrides
+     * @returns User operation receipt with transaction details
+     * @throws {Error} If insufficient total balance or transaction fails
+     *
+     * @example
+     * ```typescript
+     * const receipt = await sdk.getWallet().transferOverallFrontierDollar(
+     *   '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
+     *   '10.5'
+     * );
+     * ```
+     */
+    transferOverallFrontierDollar(to: string, amount: string, overrides?: GasOverrides): Promise<UserOperationReceipt>;
     /**
      * Execute multiple calls atomically with a single signature
      *
@@ -1501,4 +1566,4 @@ interface SDKResponse {
     error?: string;
 }
 
-export { type App, type AppPermission, type AppStatus, ChainAccess, type ChainConfig, type CreateAppRequest, type CreateSponsorPassRequest, type CreateWebhookRequest, type Developer, type ExecuteCall, FrontierSDK, type GasOverrides, type ListParams, type ListSponsorsParams, type PaginatedResponse, PartnershipsAccess, type ReferralDetails, type ReferralOverview, type RotateKeyResponse, type RotateWebhookKeyResponse, type SDKRequest, type SDKResponse, type SmartAccount, type Sponsor, type SponsorPass, StorageAccess, type SwapParams, type SwapQuote, type SwapResult, SwapResultStatus, ThirdPartyAccess, type UpdateAppRequest, type UpdateDeveloperRequest, type UpdateWebhookRequest, type User, UserAccess, type UserContact, type UserContactPayload, type UserOperationReceipt, type UserProfile, WalletAccess, type Webhook, type WebhookConfig, type WebhookEvent, type WebhookScope, type WebhookStatus };
+export { type App, type AppPermission, type AppStatus, ChainAccess, type ChainConfig, type CreateAppRequest, type CreateSponsorPassRequest, type CreateWebhookRequest, type Developer, type ExecuteCall, FrontierSDK, type GasOverrides, type ListParams, type ListSponsorsParams, type PaginatedResponse, PartnershipsAccess, type ReferralDetails, type ReferralOverview, type RotateKeyResponse, type RotateWebhookKeyResponse, type SDKRequest, type SDKResponse, type SmartAccount, type Sponsor, type SponsorPass, StorageAccess, type SwapParams, type SwapQuote, type SwapResult, SwapResultStatus, ThirdPartyAccess, type UpdateAppRequest, type UpdateDeveloperRequest, type UpdateWebhookRequest, type User, UserAccess, type UserContact, type UserContactPayload, type UserOperationReceipt, type UserProfile, WalletAccess, type WalletBalance, type WalletBalanceFormatted, type Webhook, type WebhookConfig, type WebhookEvent, type WebhookScope, type WebhookStatus };

package/dist/index.js

@@ -46,18 +46,19 @@ var WalletAccess = class {
     this.sdk = sdk;
   }
   /**
-   * Get the current wallet balance
+   * Get the current wallet balance breakdown
    * 
-   * Returns the total USD stablecoin balance for the current network,
-   * normalized to 18 decimals for consistency.
+   * Returns the balance breakdown including total, native FTD,
+   * and internal FTD amounts.
    * 
-   * @returns Balance as bigint (18 decimals)
+   * @returns Balance breakdown object
    * @throws {Error} If no wallet exists
    * 
    * @example
    * ```typescript
    * const balance = await sdk.getWallet().getBalance();
-   * console.log('Balance:', balance.toString());
+   * console.log('Total Balance:', balance.total.toString());
+   * console.log('FTD Balance:', balance.ftd.toString());
    * ```
    */
   async getBalance() {
@@ -66,16 +67,16 @@ var WalletAccess = class {
   /**
    * Get the current wallet balance formatted for display
    * 
-   * Returns the total USD stablecoin balance as a formatted string
-   * with currency symbol (e.g., '$10.50').
+   * Returns the balance breakdown as formatted strings
+   * with currency symbol (e.g., { total: '$10.50', ... }).
    * 
-   * @returns Formatted balance string with $ sign
+   * @returns Formatted balance breakdown object
    * @throws {Error} If no wallet exists
    * 
    * @example
    * ```typescript
    * const balance = await sdk.getWallet().getBalanceFormatted();
-   * console.log('Balance:', balance); // '$10.50'
+   * console.log('Total:', balance.total); // '$10.50'
    * ```
    */
   async getBalanceFormatted() {
@@ -271,6 +272,60 @@ var WalletAccess = class {
       overrides
     });
   }
+  /**
+   * Transfer Internal Frontier Dollars to another address
+   * 
+   * Sends Internal Frontier Dollars (for Network Society spending) to a recipient address.
+   * Requires biometric authentication and sufficient balance.
+   * 
+   * @param to - Recipient address
+   * @param amount - Amount to send (as string, e.g., '10.5' for 10.5 Frontier Dollars)
+   * @param overrides - Optional gas overrides
+   * @returns User operation receipt with transaction details
+   * @throws {Error} If insufficient balance or transaction fails
+   * 
+   * @example
+   * ```typescript
+   * const receipt = await sdk.getWallet().transferInternalFrontierDollar(
+   *   '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
+   *   '10.5' // 10.5 Internal Frontier Dollars
+   * );
+   * ```
+   */
+  async transferInternalFrontierDollar(to, amount, overrides) {
+    return this.sdk.request("wallet:transferInternalFrontierDollar", {
+      to,
+      amount,
+      overrides
+    });
+  }
+  /**
+   * Transfer Frontier Dollars with Internal Frontier Dollars (iFTD) preferred
+   * 
+   * This method will use Internal Frontier Dollars first, and if insufficient,
+   * it will use regular Frontier Dollars to complete the transfer.
+   * 
+   * @param to - Recipient address
+   * @param amount - Amount to send (as string, e.g., '10.5')
+   * @param overrides - Optional gas overrides
+   * @returns User operation receipt with transaction details
+   * @throws {Error} If insufficient total balance or transaction fails
+   * 
+   * @example
+   * ```typescript
+   * const receipt = await sdk.getWallet().transferOverallFrontierDollar(
+   *   '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
+   *   '10.5'
+   * );
+   * ```
+   */
+  async transferOverallFrontierDollar(to, amount, overrides) {
+    return this.sdk.request("wallet:transferOverallFrontierDollar", {
+      to,
+      amount,
+      overrides
+    });
+  }
   /**
    * Execute multiple calls atomically with a single signature
    * 

package/dist/index.mjs

@@ -16,18 +16,19 @@ var WalletAccess = class {
     this.sdk = sdk;
   }
   /**
-   * Get the current wallet balance
+   * Get the current wallet balance breakdown
    * 
-   * Returns the total USD stablecoin balance for the current network,
-   * normalized to 18 decimals for consistency.
+   * Returns the balance breakdown including total, native FTD,
+   * and internal FTD amounts.
    * 
-   * @returns Balance as bigint (18 decimals)
+   * @returns Balance breakdown object
    * @throws {Error} If no wallet exists
    * 
    * @example
    * ```typescript
    * const balance = await sdk.getWallet().getBalance();
-   * console.log('Balance:', balance.toString());
+   * console.log('Total Balance:', balance.total.toString());
+   * console.log('FTD Balance:', balance.ftd.toString());
    * ```
    */
   async getBalance() {
@@ -36,16 +37,16 @@ var WalletAccess = class {
   /**
    * Get the current wallet balance formatted for display
    * 
-   * Returns the total USD stablecoin balance as a formatted string
-   * with currency symbol (e.g., '$10.50').
+   * Returns the balance breakdown as formatted strings
+   * with currency symbol (e.g., { total: '$10.50', ... }).
    * 
-   * @returns Formatted balance string with $ sign
+   * @returns Formatted balance breakdown object
    * @throws {Error} If no wallet exists
    * 
    * @example
    * ```typescript
    * const balance = await sdk.getWallet().getBalanceFormatted();
-   * console.log('Balance:', balance); // '$10.50'
+   * console.log('Total:', balance.total); // '$10.50'
    * ```
    */
   async getBalanceFormatted() {
@@ -241,6 +242,60 @@ var WalletAccess = class {
       overrides
     });
   }
+  /**
+   * Transfer Internal Frontier Dollars to another address
+   * 
+   * Sends Internal Frontier Dollars (for Network Society spending) to a recipient address.
+   * Requires biometric authentication and sufficient balance.
+   * 
+   * @param to - Recipient address
+   * @param amount - Amount to send (as string, e.g., '10.5' for 10.5 Frontier Dollars)
+   * @param overrides - Optional gas overrides
+   * @returns User operation receipt with transaction details
+   * @throws {Error} If insufficient balance or transaction fails
+   * 
+   * @example
+   * ```typescript
+   * const receipt = await sdk.getWallet().transferInternalFrontierDollar(
+   *   '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
+   *   '10.5' // 10.5 Internal Frontier Dollars
+   * );
+   * ```
+   */
+  async transferInternalFrontierDollar(to, amount, overrides) {
+    return this.sdk.request("wallet:transferInternalFrontierDollar", {
+      to,
+      amount,
+      overrides
+    });
+  }
+  /**
+   * Transfer Frontier Dollars with Internal Frontier Dollars (iFTD) preferred
+   * 
+   * This method will use Internal Frontier Dollars first, and if insufficient,
+   * it will use regular Frontier Dollars to complete the transfer.
+   * 
+   * @param to - Recipient address
+   * @param amount - Amount to send (as string, e.g., '10.5')
+   * @param overrides - Optional gas overrides
+   * @returns User operation receipt with transaction details
+   * @throws {Error} If insufficient total balance or transaction fails
+   * 
+   * @example
+   * ```typescript
+   * const receipt = await sdk.getWallet().transferOverallFrontierDollar(
+   *   '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
+   *   '10.5'
+   * );
+   * ```
+   */
+  async transferOverallFrontierDollar(to, amount, overrides) {
+    return this.sdk.request("wallet:transferOverallFrontierDollar", {
+      to,
+      amount,
+      overrides
+    });
+  }
   /**
    * Execute multiple calls atomically with a single signature
    * 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontiertower/frontier-sdk",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "SDK for building apps on Frontier Wallet",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",