@frontiertower/frontier-sdk 0.11.1 → 0.12.0

package/dist/index.js

@@ -49,8 +49,8 @@ var WalletAccess = class {
   /**
    * Get the current wallet balance breakdown
    * 
-   * Returns the balance breakdown including total, native FTD,
-   * and internal FTD amounts.
+   * Returns the balance breakdown including total, native FND,
+   * and internal FND amounts.
    * 
    * @returns Balance breakdown object
    * @throws {Error} If no wallet exists
@@ -59,7 +59,7 @@ var WalletAccess = class {
    * ```typescript
    * const balance = await sdk.getWallet().getBalance();
    * console.log('Total Balance:', balance.total.toString());
-   * console.log('FTD Balance:', balance.ftd.toString());
+   * console.log('FND Balance:', balance.fnd.toString());
    * ```
    */
   async getBalance() {
@@ -229,7 +229,7 @@ var WalletAccess = class {
    * import { encodeFunctionData } from 'viem';
    * 
    * const receipt = await sdk.getWallet().executeCall({
-   *   to: '0xContractAddress',
+   *   target: '0xContractAddress',
    *   value: 0n,
    *   data: encodeFunctionData({
    *     abi: contractABI,
@@ -301,7 +301,7 @@ var WalletAccess = class {
     });
   }
   /**
-   * Transfer Frontier Dollars with Internal Frontier Dollars (iFTD) preferred
+   * Transfer Frontier Dollars with Internal Frontier Network Dollars (iFND) preferred
    * 
    * This method will use Internal Frontier Dollars first, and if insufficient,
    * it will use regular Frontier Dollars to complete the transfer.
@@ -344,12 +344,12 @@ var WalletAccess = class {
    * 
    * const receipt = await sdk.getWallet().executeBatchCall([
    *   {
-   *     to: '0xToken1',
+   *     target: '0xToken1',
    *     value: 0n,
    *     data: encodeFunctionData({ abi: erc20Abi, functionName: 'approve', args: [...] })
    *   },
    *   {
-   *     to: '0xProtocol',
+   *     target: '0xProtocol',
    *     value: 0n,
    *     data: encodeFunctionData({ abi: protocolAbi, functionName: 'deposit', args: [...] })
    *   }
@@ -368,12 +368,12 @@ var WalletAccess = class {
    * Returns an array of token symbols that are supported for swaps
    * and other operations on the current network.
    * 
-   * @returns Array of token symbols (e.g., ['FTD', 'USDC', 'WETH'])
+   * @returns Array of token symbols (e.g., ['FND', 'USDC', 'WETH'])
    * 
    * @example
    * ```typescript
    * const tokens = await sdk.getWallet().getSupportedTokens();
-   * console.log('Supported tokens:', tokens); // ['FTD', 'USDC', 'WETH']
+   * console.log('Supported tokens:', tokens); // ['FND', 'USDC', 'WETH']
    * ```
    */
   async getSupportedTokens() {
@@ -447,6 +447,179 @@ var WalletAccess = class {
       amount
     });
   }
+  /**
+   * Get USD deposit instructions for fiat on-ramp
+   * 
+   * Returns US bank details where user should send their USD deposit.
+   * The deposited fiat will be converted to stablecoins and sent to
+   * the user's wallet address.
+   * 
+   * Requires approved KYC verification.
+   * 
+   * @returns Bank details including routing number, account number, and beneficiary info
+   * @throws {Error} If KYC is not approved
+   * 
+   * @example
+   * ```typescript
+   * const instructions = await sdk.getWallet().getUsdDepositInstructions();
+   * console.log('Bank:', instructions.depositInstructions.bankName);
+   * console.log('Routing:', instructions.depositInstructions.bankRoutingNumber);
+   * console.log('Account:', instructions.depositInstructions.bankAccountNumber);
+   * console.log('Beneficiary:', instructions.depositInstructions.bankBeneficiaryName);
+   * ```
+   */
+  async getUsdDepositInstructions() {
+    return this.sdk.request("wallet:getUsdDepositInstructions");
+  }
+  /**
+   * Get EUR deposit instructions for fiat on-ramp (SEPA)
+   * 
+   * Returns SEPA bank details where user should send their EUR deposit.
+   * The deposited fiat will be converted to stablecoins and sent to
+   * the user's wallet address.
+   * 
+   * Requires approved KYC verification.
+   * 
+   * @returns SEPA bank details including IBAN, BIC, and beneficiary info
+   * @throws {Error} If KYC is not approved
+   * 
+   * @example
+   * ```typescript
+   * const instructions = await sdk.getWallet().getEurDepositInstructions();
+   * console.log('IBAN:', instructions.depositInstructions.iban);
+   * console.log('BIC:', instructions.depositInstructions.bic);
+   * console.log('Bank:', instructions.depositInstructions.bankName);
+   * console.log('Beneficiary:', instructions.depositInstructions.beneficiaryName);
+   * ```
+   */
+  async getEurDepositInstructions() {
+    return this.sdk.request("wallet:getEurDepositInstructions");
+  }
+  /**
+   * Get all linked bank accounts for withdrawals (off-ramp)
+   * 
+   * Returns a list of bank accounts that have been linked for
+   * withdrawing stablecoins to fiat.
+   * 
+   * Requires approved KYC verification.
+   * 
+   * @returns List of linked bank accounts with withdrawal addresses
+   * @throws {Error} If KYC is not approved
+   * 
+   * @example
+   * ```typescript
+   * const { banks } = await sdk.getWallet().getLinkedBanks();
+   * banks.forEach(bank => {
+   *   console.log(`${bank.bankName} (****${bank.last4})`);
+   * });
+   * ```
+   */
+  async getLinkedBanks() {
+    return this.sdk.request("wallet:getLinkedBanks");
+  }
+  /**
+   * Link a US bank account for withdrawals (off-ramp)
+   * 
+   * Links a US bank account (checking or savings) for withdrawing
+   * stablecoins to USD via ACH transfer.
+   * 
+   * Requires approved KYC verification.
+   * 
+   * @param accountOwnerName - Full name of the account owner
+   * @param bankName - Name of the bank (e.g., 'Chase', 'Bank of America')
+   * @param routingNumber - Bank routing number (9 digits)
+   * @param accountNumber - Bank account number
+   * @param checkingOrSavings - Account type: 'checking' or 'savings'
+   * @param address - Billing address for the account
+   * @returns Linked bank details with withdrawal address
+   * @throws {Error} If KYC is not approved or bank details are invalid
+   * 
+   * @example
+   * ```typescript
+   * const result = await sdk.getWallet().linkUsBankAccount(
+   *   'John Doe',
+   *   'Chase',
+   *   '121000248',
+   *   '1234567890',
+   *   'checking',
+   *   {
+   *     streetLine1: '123 Main St',
+   *     city: 'San Francisco',
+   *     state: 'CA',
+   *     postalCode: '94102',
+   *     country: 'USA'
+   *   }
+   * );
+   * console.log('Linked bank:', result.bankName);
+   * ```
+   */
+  async linkUsBankAccount(accountOwnerName, bankName, routingNumber, accountNumber, checkingOrSavings, address) {
+    return this.sdk.request("wallet:linkUsBankAccount", {
+      accountOwnerName,
+      bankName,
+      routingNumber,
+      accountNumber,
+      checkingOrSavings,
+      address
+    });
+  }
+  /**
+   * Link a EUR/IBAN bank account for withdrawals (off-ramp)
+   * 
+   * Links a European bank account via IBAN for withdrawing
+   * stablecoins to EUR via SEPA transfer.
+   * 
+   * Requires approved KYC verification.
+   * 
+   * @param accountOwnerName - Full name of the account owner
+   * @param accountOwnerType - Type of account owner: 'individual' or 'business'
+   * @param firstName - First name of the account owner
+   * @param lastName - Last name of the account owner
+   * @param ibanAccountNumber - IBAN account number
+   * @param bic - Optional BIC/SWIFT code
+   * @returns Linked bank details with withdrawal address
+   * @throws {Error} If KYC is not approved or bank details are invalid
+   * 
+   * @example
+   * ```typescript
+   * const result = await sdk.getWallet().linkEuroAccount(
+   *   'Hans Mueller',
+   *   'individual',
+   *   'Hans',
+   *   'Mueller',
+   *   'DE89370400440532013000',
+   *   'COBADEFFXXX' // optional BIC
+   * );
+   * console.log('Linked bank:', result.bankName);
+   * ```
+   */
+  async linkEuroAccount(accountOwnerName, accountOwnerType, firstName, lastName, ibanAccountNumber, bic) {
+    return this.sdk.request("wallet:linkEuroAccount", {
+      accountOwnerName,
+      accountOwnerType,
+      firstName,
+      lastName,
+      ibanAccountNumber,
+      bic
+    });
+  }
+  /**
+   * Delete a linked bank account
+   * 
+   * Removes a previously linked bank account from the user's off-ramp options.
+   * 
+   * @param bankId - The ID of the linked bank account to delete
+   * @throws {Error} If the bank account doesn't exist or deletion fails
+   * 
+   * @example
+   * ```typescript
+   * await sdk.getWallet().deleteLinkedBank('bank_abc123');
+   * console.log('Bank account deleted');
+   * ```
+   */
+  async deleteLinkedBank(bankId) {
+    return this.sdk.request("wallet:deleteLinkedBank", { bankId });
+  }
 };
 
 // src/access/storage.ts
@@ -673,6 +846,33 @@ var UserAccess = class {
   async addUserContact(data) {
     return this.sdk.request("user:addUserContact", data);
   }
+  /**
+   * Get or create KYC status
+   * 
+   * Returns the current KYC verification status. If KYC has not been started,
+   * it will be initiated and the response will include a URL to complete verification.
+   * 
+   * @param redirectUri - Optional URL to redirect user after KYC completion
+   * @returns KycStatusResponse with status and verification link if applicable
+   * @throws {Error} If user is not authenticated
+   * 
+   * @example
+   * ```typescript
+   * const kyc = await sdk.getUser().getOrCreateKyc();
+   * if (kyc.status === 'not_started' && kyc.kycLinkUrl) {
+   *   // Redirect user to complete KYC
+   *   window.open(kyc.kycLinkUrl, '_blank');
+   * } else if (kyc.isApproved) {
+   *   console.log('KYC approved!');
+   * }
+   * 
+   * // With redirect URI
+   * const kycWithRedirect = await sdk.getUser().getOrCreateKyc('https://myapp.com/callback');
+   * ```
+   */
+  async getOrCreateKyc(redirectUri) {
+    return this.sdk.request("user:getOrCreateKyc", redirectUri);
+  }
 };
 
 // src/access/partnerships.ts

package/dist/index.mjs

@@ -18,8 +18,8 @@ var WalletAccess = class {
   /**
    * Get the current wallet balance breakdown
    * 
-   * Returns the balance breakdown including total, native FTD,
-   * and internal FTD amounts.
+   * Returns the balance breakdown including total, native FND,
+   * and internal FND amounts.
    * 
    * @returns Balance breakdown object
    * @throws {Error} If no wallet exists
@@ -28,7 +28,7 @@ var WalletAccess = class {
    * ```typescript
    * const balance = await sdk.getWallet().getBalance();
    * console.log('Total Balance:', balance.total.toString());
-   * console.log('FTD Balance:', balance.ftd.toString());
+   * console.log('FND Balance:', balance.fnd.toString());
    * ```
    */
   async getBalance() {
@@ -198,7 +198,7 @@ var WalletAccess = class {
    * import { encodeFunctionData } from 'viem';
    * 
    * const receipt = await sdk.getWallet().executeCall({
-   *   to: '0xContractAddress',
+   *   target: '0xContractAddress',
    *   value: 0n,
    *   data: encodeFunctionData({
    *     abi: contractABI,
@@ -270,7 +270,7 @@ var WalletAccess = class {
     });
   }
   /**
-   * Transfer Frontier Dollars with Internal Frontier Dollars (iFTD) preferred
+   * Transfer Frontier Dollars with Internal Frontier Network Dollars (iFND) preferred
    * 
    * This method will use Internal Frontier Dollars first, and if insufficient,
    * it will use regular Frontier Dollars to complete the transfer.
@@ -313,12 +313,12 @@ var WalletAccess = class {
    * 
    * const receipt = await sdk.getWallet().executeBatchCall([
    *   {
-   *     to: '0xToken1',
+   *     target: '0xToken1',
    *     value: 0n,
    *     data: encodeFunctionData({ abi: erc20Abi, functionName: 'approve', args: [...] })
    *   },
    *   {
-   *     to: '0xProtocol',
+   *     target: '0xProtocol',
    *     value: 0n,
    *     data: encodeFunctionData({ abi: protocolAbi, functionName: 'deposit', args: [...] })
    *   }
@@ -337,12 +337,12 @@ var WalletAccess = class {
    * Returns an array of token symbols that are supported for swaps
    * and other operations on the current network.
    * 
-   * @returns Array of token symbols (e.g., ['FTD', 'USDC', 'WETH'])
+   * @returns Array of token symbols (e.g., ['FND', 'USDC', 'WETH'])
    * 
    * @example
    * ```typescript
    * const tokens = await sdk.getWallet().getSupportedTokens();
-   * console.log('Supported tokens:', tokens); // ['FTD', 'USDC', 'WETH']
+   * console.log('Supported tokens:', tokens); // ['FND', 'USDC', 'WETH']
    * ```
    */
   async getSupportedTokens() {
@@ -416,6 +416,179 @@ var WalletAccess = class {
       amount
     });
   }
+  /**
+   * Get USD deposit instructions for fiat on-ramp
+   * 
+   * Returns US bank details where user should send their USD deposit.
+   * The deposited fiat will be converted to stablecoins and sent to
+   * the user's wallet address.
+   * 
+   * Requires approved KYC verification.
+   * 
+   * @returns Bank details including routing number, account number, and beneficiary info
+   * @throws {Error} If KYC is not approved
+   * 
+   * @example
+   * ```typescript
+   * const instructions = await sdk.getWallet().getUsdDepositInstructions();
+   * console.log('Bank:', instructions.depositInstructions.bankName);
+   * console.log('Routing:', instructions.depositInstructions.bankRoutingNumber);
+   * console.log('Account:', instructions.depositInstructions.bankAccountNumber);
+   * console.log('Beneficiary:', instructions.depositInstructions.bankBeneficiaryName);
+   * ```
+   */
+  async getUsdDepositInstructions() {
+    return this.sdk.request("wallet:getUsdDepositInstructions");
+  }
+  /**
+   * Get EUR deposit instructions for fiat on-ramp (SEPA)
+   * 
+   * Returns SEPA bank details where user should send their EUR deposit.
+   * The deposited fiat will be converted to stablecoins and sent to
+   * the user's wallet address.
+   * 
+   * Requires approved KYC verification.
+   * 
+   * @returns SEPA bank details including IBAN, BIC, and beneficiary info
+   * @throws {Error} If KYC is not approved
+   * 
+   * @example
+   * ```typescript
+   * const instructions = await sdk.getWallet().getEurDepositInstructions();
+   * console.log('IBAN:', instructions.depositInstructions.iban);
+   * console.log('BIC:', instructions.depositInstructions.bic);
+   * console.log('Bank:', instructions.depositInstructions.bankName);
+   * console.log('Beneficiary:', instructions.depositInstructions.beneficiaryName);
+   * ```
+   */
+  async getEurDepositInstructions() {
+    return this.sdk.request("wallet:getEurDepositInstructions");
+  }
+  /**
+   * Get all linked bank accounts for withdrawals (off-ramp)
+   * 
+   * Returns a list of bank accounts that have been linked for
+   * withdrawing stablecoins to fiat.
+   * 
+   * Requires approved KYC verification.
+   * 
+   * @returns List of linked bank accounts with withdrawal addresses
+   * @throws {Error} If KYC is not approved
+   * 
+   * @example
+   * ```typescript
+   * const { banks } = await sdk.getWallet().getLinkedBanks();
+   * banks.forEach(bank => {
+   *   console.log(`${bank.bankName} (****${bank.last4})`);
+   * });
+   * ```
+   */
+  async getLinkedBanks() {
+    return this.sdk.request("wallet:getLinkedBanks");
+  }
+  /**
+   * Link a US bank account for withdrawals (off-ramp)
+   * 
+   * Links a US bank account (checking or savings) for withdrawing
+   * stablecoins to USD via ACH transfer.
+   * 
+   * Requires approved KYC verification.
+   * 
+   * @param accountOwnerName - Full name of the account owner
+   * @param bankName - Name of the bank (e.g., 'Chase', 'Bank of America')
+   * @param routingNumber - Bank routing number (9 digits)
+   * @param accountNumber - Bank account number
+   * @param checkingOrSavings - Account type: 'checking' or 'savings'
+   * @param address - Billing address for the account
+   * @returns Linked bank details with withdrawal address
+   * @throws {Error} If KYC is not approved or bank details are invalid
+   * 
+   * @example
+   * ```typescript
+   * const result = await sdk.getWallet().linkUsBankAccount(
+   *   'John Doe',
+   *   'Chase',
+   *   '121000248',
+   *   '1234567890',
+   *   'checking',
+   *   {
+   *     streetLine1: '123 Main St',
+   *     city: 'San Francisco',
+   *     state: 'CA',
+   *     postalCode: '94102',
+   *     country: 'USA'
+   *   }
+   * );
+   * console.log('Linked bank:', result.bankName);
+   * ```
+   */
+  async linkUsBankAccount(accountOwnerName, bankName, routingNumber, accountNumber, checkingOrSavings, address) {
+    return this.sdk.request("wallet:linkUsBankAccount", {
+      accountOwnerName,
+      bankName,
+      routingNumber,
+      accountNumber,
+      checkingOrSavings,
+      address
+    });
+  }
+  /**
+   * Link a EUR/IBAN bank account for withdrawals (off-ramp)
+   * 
+   * Links a European bank account via IBAN for withdrawing
+   * stablecoins to EUR via SEPA transfer.
+   * 
+   * Requires approved KYC verification.
+   * 
+   * @param accountOwnerName - Full name of the account owner
+   * @param accountOwnerType - Type of account owner: 'individual' or 'business'
+   * @param firstName - First name of the account owner
+   * @param lastName - Last name of the account owner
+   * @param ibanAccountNumber - IBAN account number
+   * @param bic - Optional BIC/SWIFT code
+   * @returns Linked bank details with withdrawal address
+   * @throws {Error} If KYC is not approved or bank details are invalid
+   * 
+   * @example
+   * ```typescript
+   * const result = await sdk.getWallet().linkEuroAccount(
+   *   'Hans Mueller',
+   *   'individual',
+   *   'Hans',
+   *   'Mueller',
+   *   'DE89370400440532013000',
+   *   'COBADEFFXXX' // optional BIC
+   * );
+   * console.log('Linked bank:', result.bankName);
+   * ```
+   */
+  async linkEuroAccount(accountOwnerName, accountOwnerType, firstName, lastName, ibanAccountNumber, bic) {
+    return this.sdk.request("wallet:linkEuroAccount", {
+      accountOwnerName,
+      accountOwnerType,
+      firstName,
+      lastName,
+      ibanAccountNumber,
+      bic
+    });
+  }
+  /**
+   * Delete a linked bank account
+   * 
+   * Removes a previously linked bank account from the user's off-ramp options.
+   * 
+   * @param bankId - The ID of the linked bank account to delete
+   * @throws {Error} If the bank account doesn't exist or deletion fails
+   * 
+   * @example
+   * ```typescript
+   * await sdk.getWallet().deleteLinkedBank('bank_abc123');
+   * console.log('Bank account deleted');
+   * ```
+   */
+  async deleteLinkedBank(bankId) {
+    return this.sdk.request("wallet:deleteLinkedBank", { bankId });
+  }
 };
 
 // src/access/storage.ts
@@ -642,6 +815,33 @@ var UserAccess = class {
   async addUserContact(data) {
     return this.sdk.request("user:addUserContact", data);
   }
+  /**
+   * Get or create KYC status
+   * 
+   * Returns the current KYC verification status. If KYC has not been started,
+   * it will be initiated and the response will include a URL to complete verification.
+   * 
+   * @param redirectUri - Optional URL to redirect user after KYC completion
+   * @returns KycStatusResponse with status and verification link if applicable
+   * @throws {Error} If user is not authenticated
+   * 
+   * @example
+   * ```typescript
+   * const kyc = await sdk.getUser().getOrCreateKyc();
+   * if (kyc.status === 'not_started' && kyc.kycLinkUrl) {
+   *   // Redirect user to complete KYC
+   *   window.open(kyc.kycLinkUrl, '_blank');
+   * } else if (kyc.isApproved) {
+   *   console.log('KYC approved!');
+   * }
+   * 
+   * // With redirect URI
+   * const kycWithRedirect = await sdk.getUser().getOrCreateKyc('https://myapp.com/callback');
+   * ```
+   */
+  async getOrCreateKyc(redirectUri) {
+    return this.sdk.request("user:getOrCreateKyc", redirectUri);
+  }
 };
 
 // src/access/partnerships.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontiertower/frontier-sdk",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "description": "SDK for building apps on Frontier Wallet",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -47,5 +47,8 @@
     "type": "git",
     "url": "git+https://github.com/BerlinhouseLabs/frontier-sdk.git"
   },
-  "readme": "README.md"
+  "readme": "README.md",
+  "dependencies": {
+    "qrcode.react": "^4.2.0"
+  }
 }