@avacuscc/sdk 0.1.0 → 0.2.0

package/README.md

@@ -72,9 +72,29 @@ const client = new AvacusClient();
 const result = await client.sns.login({
   walletAddress,
   signMessage,
+  serviceName: 'connect', // optional: 'connect' | 'redirect' | 'gas-sponsor'
 });
+
+`client.sns.login()` now uses `POST /v2/public/users/request_auth_token` and,
+when `serviceName` is provided, builds the signed message with the matching base
+message:
+
+- omitted `serviceName`: Avacus Wallet message (`DEFAULT_BASE_SIGNED_MESSAGE`)
+- `connect`: `BASE_CONNECT_SIGNED_MSG`
+- `redirect`: `BASE_REDIRECT_SIGNED_MSG`
+- `gas-sponsor`: `BASE_GAS_SPONSOR_SIGNED_MSG`
 ```
 
+## Services
+
+`AvacusClient` exposes these service clients:
+
+- `client.sns`
+- `client.gasAccount`
+- `client.balancer`
+
+Most `gasAccount` APIs require a JWT token from `client.sns.login()` first.
+
 ### SNS create user
 
 ```ts
@@ -118,6 +138,232 @@ const profiles = await client.sns.getPublicProfiles({
 });
 ```
 
+## Gas Account service
+
+### Gas Account login prerequisite
+
+Authenticated gas-account APIs require SNS login first:
+
+```ts
+await client.sns.login({
+  walletAddress,
+  signMessage,
+});
+```
+
+### Gas Account summary
+
+```ts
+const summary = await client.gasAccount.getSummary();
+```
+
+### Gas Account stable tokens
+
+```ts
+const tokens = await client.gasAccount.getStableTokens();
+const bscTestnetTokens = await client.gasAccount.getStableTokens(97);
+```
+
+### Gas Account deposit vaults
+
+```ts
+const vaults = await client.gasAccount.getDepositVaults();
+```
+
+### Gas Account whitelist spenders
+
+Get current whitelist and nonce:
+
+```ts
+const whitelist = await client.gasAccount.getWhitelistSpenders();
+```
+
+Recommended helper for register flow:
+
+```ts
+await client.gasAccount.registerWhitelistSpendersWithEthers({
+  owner: wallet.address,
+  spenders: [
+    {
+      address: '0x9876543210987654321098765432109876543210',
+      expiresAt: 0,
+    },
+  ],
+  signer: wallet,
+});
+```
+
+Generic signer helper when you do not want to couple app code to `ethers`:
+
+```ts
+await client.gasAccount.registerWhitelistSpendersWithSignature({
+  owner: wallet.address,
+  spenders: [
+    {
+      address: '0x9876543210987654321098765432109876543210',
+      expiresAt: 0,
+    },
+  ],
+  signTypedData: (typedData) =>
+    wallet.signTypedData(
+      typedData.domain,
+      typedData.types,
+      typedData.message,
+    ),
+});
+```
+
+Low-level flow when you want full control:
+
+```ts
+const { data } = await client.gasAccount.getWhitelistSpenders();
+
+const typedData = client.gasAccount.buildRegisterWhitelistSpendersTypedData({
+  owner: wallet.address,
+  spenders: [
+    {
+      address: '0x9876543210987654321098765432109876543210',
+      expiresAt: 0,
+    },
+  ],
+  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: typedData.message.spenders,
+  nonce: typedData.message.nonce,
+  deadline: typedData.message.deadline,
+  signature,
+});
+```
+
+Remove spenders:
+
+```ts
+await client.gasAccount.removeWhitelistSpenders({
+  spenders: ['0x9876543210987654321098765432109876543210'],
+});
+```
+
+### Gas Account balances
+
+```ts
+const balance = await client.gasAccount.getBalance();
+const detailedBalance = await client.gasAccount.getDetailedBalance();
+const stats = await client.gasAccount.getBalanceStats();
+```
+
+Public batch balances:
+
+```ts
+const balances = await client.gasAccount.getBalances({
+  addresses: [
+    '0x3a0430580303f4De9C5320aC013f14cd92192bfA',
+    '0x610b463d2f57d2e0d9e785a7ff423fbae36f0624',
+  ],
+});
+```
+
+### Gas Account transactions
+
+List transactions:
+
+```ts
+const transactions = await client.gasAccount.listTransactions({
+  page: 1,
+  per: 10,
+  type: 'DEPOSIT',
+  status: 'CONFIRMED',
+});
+```
+
+Get transaction by ID:
+
+```ts
+const transaction = await client.gasAccount.getTransactionById(transactionId);
+```
+
+Create deposit:
+
+```ts
+await client.gasAccount.createDeposit({
+  chainId: 97,
+  amount: '100.00000000',
+  tokenAddress: '0x5bF5121A17e3329D07Ba43f758dEC271D9105132',
+  txHash: '0xe3844e7bc420b2d409058e6bf5534fdba69b917907d691abf65862654df749d7',
+  actor: walletAddress,
+  notes: 'Deposit from wallet',
+});
+```
+
+Use balance for gas:
+
+```ts
+await client.gasAccount.useBalance({
+  toAddress: '0x9876543210987654321098765432109876543210',
+  chainId: 97,
+  gasLimit: 21000,
+  gasPrice: 5,
+  notes: 'Gas for token transfer',
+});
+```
+
+Create sponsored transfer:
+
+```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',
+});
+```
+
+Cancel pending transaction:
+
+```ts
+await client.gasAccount.cancelTransaction(transactionId);
+```
+
+Internal funding request:
+
+```ts
+await client.gasAccount.createFundingRequest({
+  sourceAddress: '0x610b463d2f57d2e0d9e785a7ff423fbae36f0624',
+  toAddress: '0x9876543210987654321098765432109876543210',
+  chainId: 97,
+  gasLimit: 21000,
+  gasPrice: 5,
+  notes: 'Gas for token transfer',
+});
+```
+
+## Balancer service
+
+### Get balancer pools
+
+```ts
+const pools = await client.balancer.getPools();
+```
+
 ### SNS-only import
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avacuscc/sdk",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "SDK for interacting with services in the Wakumo ecosystem",
   "main": "./packages/sdk/dist/index.js",
   "module": "./packages/sdk/dist/index.mjs",

package/packages/sdk/dist/{chunk-T5BAFYHX.mjs → chunk-XWC6XZPN.mjs}

@@ -69,6 +69,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.
@@ -143,6 +186,14 @@ function resolveServiceUrl(baseUrl, servicePath) {
 
 // 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 {
   /**
@@ -176,7 +227,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.
@@ -253,7 +304,8 @@ var SnsService = class {
     return this.requestAuthToken({
       wallet_address: params.walletAddress,
       message: params.message,
-      signature: params.signature
+      signature: params.signature,
+      service_name: params.serviceName
     });
   }
   /**
@@ -267,14 +319,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) {
@@ -285,16 +338,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;
@@ -335,6 +388,9 @@ export {
   resolveServiceUrl,
   HttpAdapter,
   DEFAULT_BASE_SIGNED_MESSAGE,
+  BASE_CONNECT_SIGNED_MSG,
+  BASE_REDIRECT_SIGNED_MSG,
+  BASE_GAS_SPONSOR_SIGNED_MSG,
   SNS_SERVICE_PATH,
   SnsService,
   loginWithSns,