@avaprotocol/sdk-js 0.6.0 → 0.6.1

package/jest.config.cjs

@@ -1,18 +0,0 @@
-require('dotenv').config();
-
-module.exports = {
-  preset: 'ts-jest/presets/default-esm',
-  testEnvironment: 'node',
-  moduleFileExtensions: ['ts', 'js'],
-  testMatch: ['**/__tests__/**/*.test.ts'],
-  transform: {
-    '^.+\\.ts$': ['ts-jest', {
-      useESM: true,
-    }],
-  },
-  extensionsToTreatAsEsm: ['.ts'],
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1',
-  },
-  setupFiles: ['dotenv/config'],
-};

package/scripts/signMessage.js

@@ -1,27 +0,0 @@
-import { ethers } from "ethers";
-import { getKeyRequestMessage } from "../dist/index.js";
-
-const mnemonic = process.env.TEST_MNEMONIC;
-const expiredAtEpoch = Math.floor(Date.now() / 1000) + 24 * 60 * 60;
-
-if (!mnemonic) {
-  throw new Error("Mnemonic is required; Please set the TEST_MNEMONIC environment variable.");
-}
-
-const wallet = ethers.Wallet.fromPhrase(mnemonic);
-
-console.log("Address:", wallet.address, "Expired at epoch:", expiredAtEpoch);
-console.log("Private key:", wallet.privateKey);
-
-// Generate the key request message
-const message = getKeyRequestMessage(wallet.address, expiredAtEpoch);
-
-async function main() {
-  const signature = await wallet.signMessage(message);
-  console.log("Message:", message);
-  console.log("Signature:", signature);
-}
-
-main()
-  .catch(console.error)
-  .finally(() => process.exit());

package/src/__tests__/Client.e2e.test.ts

@@ -1,175 +0,0 @@
-import { describe, beforeAll, test, expect } from "@jest/globals";
-import Client from "../index";
-import dotenv from "dotenv";
-import path from "path";
-import { ethers } from "ethers";
-import { getKeyRequestMessage } from "../auth";
-import { getRpcEndpoint } from "../config";
-
-// Load environment variables from .env.test file
-dotenv.config({ path: path.resolve(__dirname, "../../.env.test") });
-
-const { TEST_JWT_TOKEN, TEST_PRIVATE_KEY } = process.env;
-const EXPIRED_AT = Math.floor(Date.now() / 1000) + 24 * 60 * 60;
-
-// Add signature generation logic
-async function getAddress(privateKey: string): Promise<string> {
-  const wallet = new ethers.Wallet(privateKey);
-
-  console.log("Wallet address:", wallet.address);
-  return wallet.address;
-}
-
-// Add signature generation logic
-async function generateSignature(
-  privateKey: string,
-  expiredAt: number
-): Promise<string> {
-  const wallet = new ethers.Wallet(privateKey);
-  const message = getKeyRequestMessage(wallet.address, expiredAt);
-
-  console.log("Signing message:", message, "Expired at:", expiredAt);
-
-  const signature = await wallet.signMessage(message);
-
-  return signature;
-}
-
-describe("Client E2E Tests", () => {
-  let client: Client;
-  let walletAddress: string; // Add this line to declare the variable
-
-  beforeAll(async () => {
-    // Initialize the client with test credentials
-    client = new Client({
-      endpoint: getRpcEndpoint("staging"),
-    });
-
-    if (!TEST_PRIVATE_KEY) {
-      throw new Error("TEST_PRIVATE_KEY is not set in the .env.test file");
-    }
-
-    // Generate the address here
-    const address = await getAddress(TEST_PRIVATE_KEY);
-    walletAddress = address;
-  });
-
-//   test("authWithJwtToken", async () => {
-//     if (!TEST_JWT_TOKEN) {
-//       throw new Error("TEST_JWT_TOKEN is not set in the .env.test file");
-//     }
-
-//     const response = await client.authWithJwtToken(
-//       walletAddress,
-//       TEST_JWT_TOKEN,
-//       EXPIRED_AT
-//     );
-
-//     console.log("authWithJwtToken response:", response);
-//     expect(response).toBeDefined();
-//   });
-
-  test("authWithSignature", async () => {
-    if (!TEST_PRIVATE_KEY) {
-      throw new Error("TEST_PRIVATE_KEY is not set in the .env.test file");
-    }
-
-    if (!EXPIRED_AT) {
-      throw new Error("EXPIRED_AT is not set.");
-    }
-
-    const signature = await generateSignature(TEST_PRIVATE_KEY, EXPIRED_AT);
-
-    if (!signature) {
-      throw new Error(
-        "Signature could not be generated. Make sure TEST_PRIVATE_KEY is set in the .env.test file"
-      );
-    }
-
-    const response = await client.authWithSignature(
-      walletAddress,
-      signature,
-      EXPIRED_AT
-    );
-
-    console.log("authWithSignature response:", response);
-
-    expect(response).toBeDefined();
-    expect(response).toHaveProperty("key");
-    expect(typeof response.key).toBe("string");
-
-    // Check if the key is a valid JWT token
-    const jwtParts = response.key.split(".");
-    expect(jwtParts).toHaveLength(3);
-
-    // Decode the base64 token and check the payload
-    const payload = JSON.parse(Buffer.from(jwtParts[1], "base64").toString());
-    expect(payload).toHaveProperty("iss", "AvaProtocol");
-    expect(payload).toHaveProperty("sub");
-    expect(payload.sub).toMatch(/^0x[a-fA-F0-9]{40}$/); // Ethereum address format
-    expect(payload).toHaveProperty("exp", EXPIRED_AT);
-  });
-
-//   describe("Authenticated Tests", () => {
-//     let walletAddress: string;
-//     let client: Client;
-
-//     beforeAll(async () => {
-//       // Initialize the client with test credentials
-//       client = new Client({
-//         endpoint: getRpcEndpoint("staging"),
-//       });
-
-//       if (!TEST_PRIVATE_KEY) {
-//         throw new Error("TEST_PRIVATE_KEY is not set in the .env.test file");
-//       }
-
-//       walletAddress = await getAddress(TEST_PRIVATE_KEY);
-
-//       if (!EXPIRED_AT) {
-//         throw new Error("EXPIRED_AT is not set");
-//       }
-
-//       const signature = await generateSignature(TEST_PRIVATE_KEY, EXPIRED_AT);
-
-//       if (!signature) {
-//         throw new Error(
-//           "Signature could not be generated. Make sure TEST_PRIVATE_KEY is set in the .env.test file"
-//         );
-//       }
-
-//       await client.authWithSignature(walletAddress, signature, EXPIRED_AT);
-//     });
-
-//     test("listTask", async () => {
-//       const result = await client.listTask();
-//       console.log("List task result:", result);
-//       expect(result).toBeDefined();
-//     //   expect(Array.isArray(result)).toBe(true);
-//     });
-
-//     test("getSmartWalletAddress", async () => {
-//       const result = await client.getSmartWalletAddress(walletAddress);
-//       console.log("Get smart wallet address result:", result);
-//       expect(result).toBeDefined();
-//       expect(result.getSmartAccountAddress()).toMatch(/^0x[a-fA-F0-9]{40}$/); // Ethereum address format
-//       expect(result).toHaveProperty("nonce");
-//     });
-
-//     test("getTask", async () => {
-//       // First, list tasks to get a valid task ID
-//       const listResult = await client.listTask();
-
-//       console.log("List task result:", listResult);
-//       if (listResult.getTasksList().length > 0) {
-//         const taskId = listResult.getTasksList()[0].getId();
-//         const result = await client.getTask(taskId);
-//         console.log("Get task result:", result);
-//         expect(result).toBeDefined();
-//         expect(result.getId()).toBe(taskId);
-//       } else {
-//         console.warn("No tasks available to test getTask");
-//       }
-//     });
-//   });
-});

package/src/auth.ts

@@ -1,3 +0,0 @@
-export const getKeyRequestMessage = (address: string, expiredAt: number): string => {
-  return `key request for ${address} expired at ${expiredAt}`;
-}

package/src/config.ts

@@ -1,27 +0,0 @@
-import { Environment } from "./types";
-
-export const DEFAULT_JWT_EXPIRATION = 24 * 60 * 60; // 24 hours
-interface Config {
-  endpoint: string;
-}
-
-// Define the configs object with typed keys
-const configs: Record<Environment, Config> = {
-  development: {
-    endpoint: process.env.AVS_RPC_URL || "localhost:2206",
-  },
-  staging: {
-    endpoint: "aggregator-holesky.avaprotocol.org:2206",
-  },
-  production: {
-    endpoint: "aggregator.avaprotocol.org:2206",
-  },
-};
-
-// Function to get RPC endpoint with improved type safety
-export function getRpcEndpoint(env: Environment): string {
-  return configs[env].endpoint;
-}
-
-// Export the configs only
-export { configs };

package/src/index.ts

@@ -1,198 +0,0 @@
-import * as grpc from "@grpc/grpc-js";
-import { Metadata } from "@grpc/grpc-js";
-import { DEFAULT_JWT_EXPIRATION, getRpcEndpoint } from "./config";
-import { Environment } from "./types";
-import { getKeyRequestMessage } from "./auth";
-import { AggregatorClient } from "../grpc_codegen/avs_grpc_pb";
-import {
-  AddressRequest,
-  AddressResp,
-  GetKeyReq,
-  KeyResp,
-  ListTasksReq,
-  ListTasksResp,
-  Task,
-  UUID,
-} from "../grpc_codegen/avs_pb";
-
-const grpcMetadata = new Metadata();
-
-// Move interfaces to a separate file, e.g., types.ts
-import { KeyExchangeResp, ClientParams } from "./types";
-
-class BaseClient {
-  readonly endpoint: string;
-  readonly rpcClient: AggregatorClient;
-  // protected owner?: string;
-  // readonly opts: ClientParams;
-  protected adminToken?: string; // A JWT token for admin operations
-  // protected wallet?: any;
-
-  constructor(config: ClientParams) {
-    // if (!config.jwtApiKey && !config.owner) {
-    //   throw new Error("missing jwtApiKey or owner");
-    // }
-
-    this.endpoint = config.endpoint;
-    this.rpcClient = new AggregatorClient(
-      config.endpoint,
-      grpc.credentials.createInsecure()
-    );
-
-    // this.opts = clientConfig;
-    // this.owner = clientConfig.owner ?? undefined;
-  }
-
-  // async authWithJwtToken(
-  //   address: string,
-  //   jwtToken: string,
-  //   expiredAt?: number
-  // ): Promise<KeyExchangeResp> {
-  //   console.log("Authenticating with JWT token: ", jwtToken);
-
-  //   const expirationTime =
-  //     expiredAt || Math.floor(Date.now() / 1000) + DEFAULT_JWT_EXPIRATION;
-
-  //   const method = this.rpcClient.getKey.bind(this.rpcClient) as (
-  //     request: GetKeyReq,
-  //     metadata: Metadata | undefined,
-  //     callback: (error: grpc.ServiceError | null, response: KeyResp) => void
-  //   ) => grpc.ClientUnaryCall;
-
-  //   const request = new GetKeyReq()
-  //     .setOwner(address)
-  //     .setExpiredAt(expirationTime)
-  //     .setSignature(jwtToken);
-
-  //   const response = await this._callRPC<KeyResp, GetKeyReq>(method, request);
-
-  //   console.log("response:", response.getKey());
-  //   return { key: response.getKey() };
-  // }
-
-  async authWithSignature(
-    address: string,
-    signature: string,
-    expiredAtEpoch: number
-  ): Promise<KeyExchangeResp> {
-    console.log(
-      "Authenticating with signature:",
-      signature,
-      "Expired at epoch:",
-      expiredAtEpoch
-    );
-
-    const request = new GetKeyReq()
-      .setOwner(address)
-      .setExpiredAt(expiredAtEpoch)
-      .setSignature(signature);
-
-    console.log("request:", request);
-
-    const response = await this._callRPC<KeyResp, GetKeyReq>("getKey", request);
-
-    console.log("response:", response.getKey());
-    return { key: response.getKey() };
-  }
-
-  // protected async sendRequest<TResponse, TRequest extends object = {}>(
-  //   method: string,
-  //   request: TRequest = {} as TRequest,
-  //   metadata?: Metadata
-  // ): Promise<TResponse> {
-  //   if (metadata === undefined) {
-  //     metadata = new grpc.Metadata();
-  //   }
-
-  //   if (!this.adminToken) {
-  //     throw new Error(
-  //       "Authentication required. Please call authWithJwtToken() or authWithSignature() before making requests."
-  //     );
-  //   }
-
-  //   metadata.add("adminToken", this.adminToken);
-
-  //   return this._callRPC<TResponse, TRequest>(
-  //     method as (
-  //       request: TRequest,
-  //       metadata: grpc.Metadata | undefined,
-  //       callback: (error: grpc.ServiceError | null, response: TResponse) => void
-  //     ),
-  //     request,
-  //     metadata
-  //   );
-  // }
-
-  public isAuthenticated(): boolean {
-    return !!this.adminToken;
-  }
-
-  protected _callRPC<TResponse, TRequest extends object = {}>(
-    methodName: string,
-    request: TRequest,
-  ): Promise<TResponse> {
-    return new Promise((resolve, reject) => {
-
-      const method = (this.rpcClient as any)[methodName] as (
-        request: TRequest,
-        metadata: grpc.Metadata | undefined,
-        callback: (error: grpc.ServiceError | null, response: TResponse) => void
-      ) => grpc.ClientUnaryCall;
-
-      method.call(
-        this.rpcClient,
-        request,
-        grpcMetadata,
-        (error: grpc.ServiceError | null, response: TResponse) => {
-          if (error) {
-            reject(error);
-          } else {
-            resolve(response);
-          }
-        }
-      );
-    });
-  }
-}
-
-export default class Client extends BaseClient {
-  constructor(config: ClientParams) {
-    super(config);
-  }
-
-  async listTask(): Promise<ListTasksResp> {
-    console.log("Listing tasks");
-
-    const request = new ListTasksReq();
-
-    const response = await this._callRPC<ListTasksResp, ListTasksReq>(
-      "listTasks",
-      request
-    );
-
-    console.log("response:", response);
-    return response;
-  }
-
-  async getSmartWalletAddress(address: string): Promise<AddressResp> {
-    const request = new AddressRequest().setOwner(address);
-    const response = await this._callRPC<AddressResp, AddressRequest>(
-      "getSmartAccountAddress",
-      request
-    );
-
-    return response;
-  }
-
-  async getTask(taskId: string): Promise<any> {
-    const request = new UUID().setBytes(taskId);
-    const response = await this._callRPC<Task, UUID>("getTask", request);
-    return response;
-  }
-}
-
-// Export types for easier use
-export * from "./types";
-
-// Add this line at the end of the file
-export { getKeyRequestMessage };

package/src/types.ts

@@ -1,31 +0,0 @@
-// Define the environment type
-export type Environment = "production" | "development" | "staging";
-
-export interface KeyExchangeResp {
-  key: string;
-}
-
-export interface ClientParams {
-  // used primary in backend where owner own the key
-  // privateKey?: string;
-
-  // used in automated manner where this key can schedule job on behalf of other user. this jwtApiKey is generated from aggregator CLI. It's a long live key.
-  // This currently used in our telegram bot, because the bot can schedule and manage tasks for any user
-  // It is just require the user to prove they own the wallet in initial onboarding.
-  adminToken?: string;
-
-  // used in front-end app where front-end generate the signature
-  // presignSignature?: string;
-  // signatureExpiredAt?: number;
-
-  // env?: Environment;
-  endpoint: string;
-  // owner?: string;
-}
-export interface TransactionResp {
-  hash: string;
-}
-
-export interface BalanceResp {
-  balance: string;
-}

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "ESNext",
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "strict": true,
-    "outDir": "./dist",
-    "declaration": true,
-    "rootDir": "src",
-    "paths": {
-      "@avaprotocol/*": ["./packages/*"]
-    }
-  },
-  "include": ["src/**/*"],
-  "ts-node": {
-    "esm": true
-  }
-}