@avacuscc/sdk 0.1.0 → 0.2.1

package/packages/sdk/dist/index.js

@@ -22,11 +22,14 @@ var index_exports = {};
 __export(index_exports, {
   AVACUS_ENDPOINTS: () => AVACUS_ENDPOINTS,
   AvacusClient: () => AvacusClient,
+  BASE_CONNECT_SIGNED_MSG: () => BASE_CONNECT_SIGNED_MSG,
+  BASE_GAS_SPONSOR_SIGNED_MSG: () => BASE_GAS_SPONSOR_SIGNED_MSG,
+  BASE_REDIRECT_SIGNED_MSG: () => BASE_REDIRECT_SIGNED_MSG,
   BalancerService: () => BalancerService,
   DEFAULT_BASE_SIGNED_MESSAGE: () => DEFAULT_BASE_SIGNED_MESSAGE,
+  DEFAULT_REGISTER_WHITELIST_SPENDERS_VERSION: () => DEFAULT_REGISTER_WHITELIST_SPENDERS_VERSION,
   GAS_ACCOUNT_SERVICE_PATH: () => GAS_ACCOUNT_SERVICE_PATH,
   GasAccountService: () => GasAccountService,
-  HttpAdapter: () => HttpAdapter,
   SNS_SERVICE_PATH: () => SNS_SERVICE_PATH,
   SnsAuthClient: () => SnsAuthClient,
   SnsService: () => SnsService,
@@ -136,6 +139,49 @@ var HttpAdapter = class {
     });
     return this.parseResponse(response, "POST", path);
   }
+  /**
+   * Sends an HTTP PUT request with a JSON body to a path relative to this adapter base URL.
+   *
+   * @param path Relative endpoint path.
+   * @param body Serializable request payload.
+   * @param options Request behavior such as auth requirement and extra headers.
+   */
+  async put(path, body, options = {}) {
+    const response = await fetch(this.buildUrl(path), {
+      method: "PUT",
+      headers: this.buildHeaders({
+        ...options,
+        headers: {
+          "Content-Type": "application/json",
+          ...options.headers
+        }
+      }),
+      body: body === void 0 ? void 0 : JSON.stringify(body)
+    });
+    return this.parseResponse(response, "PUT", path);
+  }
+  /**
+   * Sends an HTTP DELETE request with an optional JSON body to a path relative to this adapter base URL.
+   *
+   * @param path Relative endpoint path.
+   * @param body Optional serializable request payload.
+   * @param options Request behavior such as auth requirement and extra headers.
+   */
+  async delete(path, body, options = {}) {
+    const headers = body === void 0 ? this.buildHeaders(options) : this.buildHeaders({
+      ...options,
+      headers: {
+        "Content-Type": "application/json",
+        ...options.headers
+      }
+    });
+    const response = await fetch(this.buildUrl(path), {
+      method: "DELETE",
+      headers,
+      body: body === void 0 ? void 0 : JSON.stringify(body)
+    });
+    return this.parseResponse(response, "DELETE", path);
+  }
   /**
    * Builds the final request headers by combining default headers, per-request
    * headers, and an authorization header when the request requires auth.
@@ -187,6 +233,14 @@ var BalancerService = class {
     this.http = http;
   }
   http;
+  /**
+   * Returns the list of balancer pools.
+   *
+   * @example
+   * ```ts
+   * const pools = await client.balancer.getPools();
+   * ```
+   */
   async getPools() {
     return this.http.get("balancer/pools");
   }
@@ -194,6 +248,30 @@ var BalancerService = class {
 
 // packages/sdk/src/services/gasAccount.ts
 var GAS_ACCOUNT_SERVICE_PATH = "1/gas-account/";
+var DEFAULT_REGISTER_WHITELIST_SPENDERS_VERSION = "1";
+var REGISTER_WHITELIST_SPENDERS_TYPED_DATA = {
+  domain: {
+    name: "AvacusGasAccount"
+  },
+  types: {
+    SpenderEntry: [
+      { name: "address", type: "address" },
+      { name: "expiresAt", type: "uint256" }
+    ],
+    RegisterSpenders: [
+      { name: "owner", type: "address" },
+      { name: "spenders", type: "SpenderEntry[]" },
+      { name: "nonce", type: "uint256" },
+      { name: "deadline", type: "uint256" }
+    ]
+  },
+  primaryType: "RegisterSpenders"
+};
+function toMutableTypedDataTypes(types) {
+  return Object.fromEntries(
+    Object.entries(types).map(([key, fields]) => [key, [...fields]])
+  );
+}
 var GasAccountService = class {
   /**
    * Creates the gas-account service using a service-scoped HTTP adapter.
@@ -207,21 +285,452 @@ var GasAccountService = class {
   /**
    * Returns the deposit vault address mapping keyed by chain ID.
    * Requires a JWT token from a successful SNS login.
+   *
+   * @example
+   * ```ts
+   * await client.sns.login({
+   *   walletAddress,
+   *   signMessage,
+   * });
+   *
+   * const vaults = await client.gasAccount.getDepositVaults();
+   * ```
    */
   async getDepositVaults() {
     return this.http.get("deposit_vaults", { auth: true });
   }
   /**
-   * Returns the authenticated gas-account service status payload.
-   * Requires a JWT token from a successful SNS login.
+   * Returns the authenticated user's gas account summary, including balances,
+   * recent transactions, and pending transactions.
+   *
+   * @example
+   * ```ts
+   * const summary = await client.gasAccount.getSummary();
+   * ```
+   */
+  async getSummary() {
+    return this.http.get("summary", { auth: true });
+  }
+  /**
+   * Returns supported stable tokens, optionally filtered by chain ID.
+   *
+   * @param chainId Optional network chain ID used to filter supported tokens.
+    *
+    * @example
+    * ```ts
+    * const tokens = await client.gasAccount.getStableTokens();
+    * const bscTestnetTokens = await client.gasAccount.getStableTokens(97);
+    * ```
+   */
+  async getStableTokens(chainId) {
+    const searchParams = new URLSearchParams();
+    if (chainId !== void 0) {
+      searchParams.set("chainId", String(chainId));
+    }
+    const path = searchParams.size > 0 ? `stable_tokens?${searchParams.toString()}` : "stable_tokens";
+    return this.http.get(path, { auth: true });
+  }
+  /**
+   * Returns the authenticated user's current whitelist spender entries and nonce.
+    *
+    * @example
+    * ```ts
+    * const whitelist = await client.gasAccount.getWhitelistSpenders();
+    * ```
+   */
+  async getWhitelistSpenders() {
+    return this.http.get("whitelist-spenders", { auth: true });
+  }
+  /**
+   * Adds or updates whitelist spender entries using a signed EIP-712 payload.
+   *
+   * @param params Spenders, signature, nonce, and deadline for registration.
+    *
+    * @example
+    * ```ts
+    * const { data } = await client.gasAccount.getWhitelistSpenders();
+    * const typedData = client.gasAccount.buildRegisterWhitelistSpendersTypedData({
+    *   owner: wallet.address,
+    *   spenders,
+    *   nonce: data.nonce,
+    *   deadline: Math.floor(Date.now() / 1000) + 600,
+    * });
+    *
+    * const signature = await wallet.signTypedData(
+    *   typedData.domain,
+    *   typedData.types,
+    *   typedData.message,
+    * );
+    *
+    * await client.gasAccount.registerWhitelistSpenders({
+    *   spenders,
+    *   nonce: data.nonce,
+    *   deadline: typedData.message.deadline,
+    *   signature,
+    * });
+    * ```
+   */
+  async registerWhitelistSpenders(params) {
+    return this.http.post("whitelist-spenders", params, {
+      auth: true
+    });
+  }
+  /**
+   * Convenience helper that fetches the current whitelist nonce, builds the
+   * typed-data payload, asks the caller to sign it, and submits the request.
+   *
+   * @param params Owner address, spender entries, optional deadline, and a typed-data signer.
+    *
+    * @example
+    * ```ts
+    * await client.gasAccount.registerWhitelistSpendersWithSignature({
+    *   owner: wallet.address,
+    *   spenders,
+    *   signTypedData: (typedData) =>
+    *     wallet.signTypedData(
+    *       typedData.domain,
+    *       typedData.types,
+    *       typedData.message,
+    *     ),
+    * });
+    * ```
+   */
+  async registerWhitelistSpendersWithSignature(params) {
+    const { data } = await this.getWhitelistSpenders();
+    const nonce = data.nonce;
+    const deadline = params.deadline ?? Math.floor(Date.now() / 1e3) + 600;
+    const typedData = this.buildRegisterWhitelistSpendersTypedData({
+      owner: params.owner,
+      spenders: params.spenders,
+      version: params.version,
+      nonce,
+      deadline
+    });
+    const signature = await params.signTypedData(typedData);
+    return this.registerWhitelistSpenders({
+      spenders: params.spenders,
+      signature,
+      nonce,
+      deadline
+    });
+  }
+  /**
+   * Convenience helper for ethers-compatible signers.
+   *
+   * @param params Owner address, spender entries, optional domain version/deadline, and an ethers-compatible signer.
+   *
+   * @example
+   * ```ts
+   * await client.gasAccount.registerWhitelistSpendersWithEthers({
+   *   owner: wallet.address,
+   *   spenders,
+   *   signer: wallet,
+   * });
+   * ```
+   */
+  async registerWhitelistSpendersWithEthers(params) {
+    return this.registerWhitelistSpendersWithSignature({
+      owner: params.owner,
+      spenders: params.spenders,
+      version: params.version,
+      deadline: params.deadline,
+      signTypedData: (typedData) => params.signer.signTypedData(
+        typedData.domain,
+        toMutableTypedDataTypes(typedData.types),
+        typedData.message
+      )
+    });
+  }
+  /**
+   * Builds the EIP-712 typed-data payload required by whitelist registration.
+   *
+   * @param params Owner, spenders, nonce, and deadline used in the signature payload.
+    *
+    * @example
+    * ```ts
+    * const typedData = client.gasAccount.buildRegisterWhitelistSpendersTypedData({
+    *   owner: wallet.address,
+    *   spenders,
+    *   nonce: 0,
+    *   deadline: Math.floor(Date.now() / 1000) + 600,
+    * });
+    * ```
+   */
+  buildRegisterWhitelistSpendersTypedData(params) {
+    return {
+      ...REGISTER_WHITELIST_SPENDERS_TYPED_DATA,
+      domain: {
+        ...REGISTER_WHITELIST_SPENDERS_TYPED_DATA.domain,
+        version: params.version ?? DEFAULT_REGISTER_WHITELIST_SPENDERS_VERSION
+      },
+      message: {
+        owner: params.owner,
+        spenders: params.spenders,
+        nonce: params.nonce,
+        deadline: params.deadline
+      }
+    };
+  }
+  /**
+   * Removes one or more whitelist spender addresses from the authenticated account.
+   *
+   * @param params Spender addresses to revoke.
+    *
+    * @example
+    * ```ts
+    * await client.gasAccount.removeWhitelistSpenders({
+    *   spenders: ['0x9876543210987654321098765432109876543210'],
+    * });
+    * ```
+   */
+  async removeWhitelistSpenders(params) {
+    return this.http.delete("whitelist-spenders", params, {
+      auth: true
+    });
+  }
+  /**
+   * Returns the authenticated user's balance summary.
+    *
+    * @example
+    * ```ts
+    * const balance = await client.gasAccount.getBalance();
+    * ```
+   */
+  async getBalance() {
+    return this.http.get("gas-account-balance", { auth: true });
+  }
+  /**
+   * Returns the authenticated user's balance summary with pending transaction lists.
+    *
+    * @example
+    * ```ts
+    * const detailedBalance = await client.gasAccount.getDetailedBalance();
+    * ```
+   */
+  async getDetailedBalance() {
+    return this.http.get("gas-account-balance/detailed", {
+      auth: true
+    });
+  }
+  /**
+   * Returns balance statistics for the authenticated user's gas account.
+    *
+    * @example
+    * ```ts
+    * const stats = await client.gasAccount.getBalanceStats();
+    * ```
+   */
+  async getBalanceStats() {
+    return this.http.get("gas-account-balance/stats", {
+      auth: true
+    });
+  }
+  /**
+   * Returns balances for a batch of addresses through the public balances endpoint.
+   *
+   * @param params Address batch to query.
+    *
+    * @example
+    * ```ts
+    * const balances = await client.gasAccount.getBalances({
+    *   addresses: [
+    *     '0x3a0430580303f4De9C5320aC013f14cd92192bfA',
+    *     '0x610b463d2f57d2e0d9e785a7ff423fbae36f0624',
+    *   ],
+    * });
+    * ```
+   */
+  async getBalances(params) {
+    return this.http.put("gas-account-balance/balances", params);
+  }
+  /**
+   * Returns a paginated transaction list for the authenticated user's gas account.
+   *
+   * @param params Optional pagination and filter parameters.
+    *
+    * @example
+    * ```ts
+    * const transactions = await client.gasAccount.listTransactions({
+    *   page: 1,
+    *   per: 10,
+    *   type: 'DEPOSIT',
+    *   status: 'CONFIRMED',
+    * });
+    * ```
+   */
+  async listTransactions(params = {}) {
+    const searchParams = new URLSearchParams();
+    if (params.page !== void 0) {
+      searchParams.set("page", String(params.page));
+    }
+    if (params.per !== void 0) {
+      searchParams.set("per", String(params.per));
+    }
+    if (params.type) {
+      searchParams.set("type", params.type);
+    }
+    if (params.status) {
+      searchParams.set("status", params.status);
+    }
+    const path = searchParams.size > 0 ? `gas-account-transaction?${searchParams.toString()}` : "gas-account-transaction";
+    return this.http.get(path, { auth: true });
+  }
+  /**
+   * Returns detailed data for a specific transaction ID.
+   *
+   * @param transactionId Transaction UUID.
+    *
+    * @example
+    * ```ts
+    * const transaction = await client.gasAccount.getTransactionById(transactionId);
+    * ```
    */
-  async getStatus() {
-    return this.http.get("status", { auth: true });
+  async getTransactionById(transactionId) {
+    return this.http.get(
+      `gas-account-transaction/${transactionId}`,
+      { auth: true }
+    );
+  }
+  /**
+   * Creates a pending deposit transaction for the authenticated user.
+   *
+   * @param params Deposit payload.
+    *
+    * @example
+    * ```ts
+    * await client.gasAccount.createDeposit({
+    *   chainId: 97,
+    *   amount: '100.00000000',
+    *   tokenAddress: '0x5bF5121A17e3329D07Ba43f758dEC271D9105132',
+    *   txHash: '0xe3844e7bc420b2d409058e6bf5534fdba69b917907d691abf65862654df749d7',
+    *   actor: walletAddress,
+    *   notes: 'Deposit from wallet',
+    * });
+    * ```
+   */
+  async createDeposit(params) {
+    return this.http.post("gas-account-transaction/deposit", params, {
+      auth: true
+    });
+  }
+  /**
+   * Creates a gas-usage request against the caller's balance or a whitelisted source address.
+    * When `sourceAddress` is provided, the caller spends from another owner's
+    * gas account and therefore must already be registered as a whitelist spender
+    * for that source account.
+   *
+   * @param params Usage request payload.
+    *
+    * @example
+    * ```ts
+    * await client.gasAccount.useBalance({
+    *   toAddress: '0x9876543210987654321098765432109876543210',
+    *   chainId: 97,
+    *   gasLimit: 21000,
+    *   gasPrice: 5,
+    *   notes: 'Gas for token transfer',
+    * });
+    *
+    * await client.gasAccount.useBalance({
+    *   toAddress: '0x9876543210987654321098765432109876543210',
+    *   chainId: 97,
+    *   gasLimit: 21000,
+    *   gasPrice: 5,
+    *   sourceAddress: '0x610b463d2f57d2e0d9e785a7ff423fbae36f0624',
+    *   notes: 'Use gas from delegated source account',
+    * });
+    * ```
+   */
+  async useBalance(params) {
+    return this.http.post("gas-account-transaction/use-balance", params, {
+      auth: true
+    });
+  }
+  /**
+   * Creates a sponsored transfer request.
+   *
+   * @param params Sponsored transfer payload.
+    *
+    * @example
+    * ```ts
+    * await client.gasAccount.createSponsoredTransfer({
+    *   transactions: [
+    *     {
+    *       tokenAddress: '0x409E7b65eF7B243529e3F97be2A122123c55DE63',
+    *       from: '0x1234567890123456789012345678901234567890',
+    *       to: '0x9876543210987654321098765432109876543210',
+    *       value: '1000000000000000000',
+    *       validBefore: 1735689600,
+    *       validAfter: 0,
+    *       nonce: '0x0000000000000000000000000000000000000000000000000000000000000001',
+    *       signature: '0x...',
+    *     },
+    *   ],
+    *   chainId: 97,
+    *   type: 'ADMIN',
+    *   notes: 'JPYC transfer sponsorship',
+    * });
+    * ```
+   */
+  async createSponsoredTransfer(params) {
+    return this.http.post(
+      "gas-account-transaction/sponsored-transfers",
+      params,
+      { auth: true }
+    );
+  }
+  /**
+   * Cancels a pending gas-account transaction that has not yet been broadcast.
+   *
+   * @param transactionId Transaction UUID.
+    *
+    * @example
+    * ```ts
+    * await client.gasAccount.cancelTransaction(transactionId);
+    * ```
+   */
+  async cancelTransaction(transactionId) {
+    return this.http.put(
+      `gas-account-transaction/${transactionId}/cancel`,
+      void 0,
+      { auth: true }
+    );
+  }
+  /**
+   * Creates an internal funding request on behalf of another service.
+   *
+   * @param params Funding request payload.
+    *
+    * @example
+    * ```ts
+    * await client.gasAccount.createFundingRequest({
+    *   sourceAddress: '0x610b463d2f57d2e0d9e785a7ff423fbae36f0624',
+    *   toAddress: '0x9876543210987654321098765432109876543210',
+    *   chainId: 97,
+    *   gasLimit: 21000,
+    *   gasPrice: 5,
+    *   notes: 'Gas for token transfer',
+    * });
+    * ```
+   */
+  async createFundingRequest(params) {
+    return this.http.post(
+      "internal/gas-account-transaction/funding-requests",
+      params
+    );
   }
 };
 
 // packages/sdk/src/services/sns.ts
 var DEFAULT_BASE_SIGNED_MESSAGE = "Hi there from Avacus Wallet! Please sign this message to prove that you can access to secure chat. To stop hackers access to your secure chat, do not sign this message outside Avacus Wallet, and here's a unique message ID they can't guess: ";
+var BASE_CONNECT_SIGNED_MSG = "Hi there from Avacus Connect! Please sign this message to prove that you can access our service. For security reasons, do not sign this message outside Avacus Connect, and here's a unique message ID they can't guess: ";
+var BASE_REDIRECT_SIGNED_MSG = "Hi there from Avacus Redirect! Please sign this message to prove that you can access our service. For security reasons, do not sign this message outside Avacus Redirect, and here's a unique message ID they can't guess: ";
+var BASE_GAS_SPONSOR_SIGNED_MSG = "Hi there from Avacus Gas Sponsor! Please sign this message to prove that you can access our service. For security reasons, do not sign this message outside Avacus Gas Sponsor, and here's a unique message ID they can't guess: ";
+var BASE_SIGNED_MESSAGE_BY_SERVICE = {
+  connect: BASE_CONNECT_SIGNED_MSG,
+  redirect: BASE_REDIRECT_SIGNED_MSG,
+  "gas-sponsor": BASE_GAS_SPONSOR_SIGNED_MSG
+};
 var SNS_SERVICE_PATH = "1/secure-chat/";
 var SnsService = class {
   /**
@@ -255,7 +764,7 @@ var SnsService = class {
    * @param params Payload expected by the SNS auth API.
    */
   async requestAuthToken(params) {
-    return this.http.post("v1/public/users/request_auth_token", params);
+    return this.http.post("v2/public/users/request_auth_token", params);
   }
   /**
    * Returns public user profiles for a batch of wallet addresses and/or user IDs.
@@ -332,7 +841,8 @@ var SnsService = class {
     return this.requestAuthToken({
       wallet_address: params.walletAddress,
       message: params.message,
-      signature: params.signature
+      signature: params.signature,
+      service_name: params.serviceName
     });
   }
   /**
@@ -346,14 +856,15 @@ var SnsService = class {
    * @param params Wallet address and async signing callback.
    */
   async login(params) {
-    const { walletAddress, signMessage } = params;
+    const { walletAddress, signMessage, serviceName } = params;
     const { nonce } = await this.getNonce({ walletAddress });
-    const message = this.buildLoginMessage(nonce);
+    const message = this.buildLoginMessage(nonce, serviceName);
     const signature = await signMessage(message);
     const result = await this.authenticate({
       walletAddress,
       message,
-      signature
+      signature,
+      serviceName
     });
     const accessToken = extractAccessToken(result);
     if (accessToken) {
@@ -364,16 +875,16 @@ var SnsService = class {
   /**
    * Builds the exact message string that the wallet must sign during login.
    */
-  buildLoginMessage(nonce) {
-    return `${this.options.baseSignedMessage ?? DEFAULT_BASE_SIGNED_MESSAGE}${nonce}`;
+  buildLoginMessage(nonce, serviceName) {
+    const baseMessage = serviceName != null ? BASE_SIGNED_MESSAGE_BY_SERVICE[serviceName] : this.options.baseSignedMessage ?? DEFAULT_BASE_SIGNED_MESSAGE;
+    return `${baseMessage}${nonce}`;
   }
 };
 function extractAccessToken(result) {
-  const candidateKeys = ["access_token", "accessToken", "token", "jwt"];
-  for (const key of candidateKeys) {
-    const value = result[key];
-    if (typeof value === "string" && value.length > 0) {
-      return value;
+  if ("data" in result && typeof result.data === "object" && result.data !== null) {
+    const token = result.data.token;
+    if (typeof token === "string" && token.length > 0) {
+      return token;
     }
   }
   return void 0;
@@ -444,11 +955,14 @@ var SnsAuthClient = class extends SnsService {
 0 && (module.exports = {
   AVACUS_ENDPOINTS,
   AvacusClient,
+  BASE_CONNECT_SIGNED_MSG,
+  BASE_GAS_SPONSOR_SIGNED_MSG,
+  BASE_REDIRECT_SIGNED_MSG,
   BalancerService,
   DEFAULT_BASE_SIGNED_MESSAGE,
+  DEFAULT_REGISTER_WHITELIST_SPENDERS_VERSION,
   GAS_ACCOUNT_SERVICE_PATH,
   GasAccountService,
-  HttpAdapter,
   SNS_SERVICE_PATH,
   SnsAuthClient,
   SnsService,