fix: add oso-api-key argument (#5585)

Author: Jabolol

lib/oss-artifact-validators/src/onchain/contracts-v0.ts

@@ -1,14 +1,15 @@
-import { gql, request } from "graphql-request";
+import { gql, GraphQLClient } from "graphql-request";
 import { createPublicClient, http, PublicClient } from "viem";
 import { EVMNetworkValidator } from "./evm.js";
 
 const ANY_EVM = "ANY_EVM";
-const DEFAULT_API_URL = "https://www.opensource.observer/api/v1/graphql";
+const DEFAULT_API_URL = "https://www.oso.xyz/api/v1/graphql";
 
 export interface ContractsV0ValidatorOptions {
   apiUrl?: string;
   contractNamespace?: string;
   rpcUrl: string;
+  apiKey?: string;
 }
 
 interface ContractsV0Response {
@@ -24,16 +25,22 @@ interface ContractsV0Response {
 }
 
 export class ContractsV0Validator implements EVMNetworkValidator {
-  private readonly apiUrl: string;
+  private readonly graphqlClient: GraphQLClient;
   private readonly contractNamespace: string;
   private readonly client: PublicClient;
 
   constructor(options: ContractsV0ValidatorOptions) {
-    this.apiUrl = options.apiUrl ?? DEFAULT_API_URL;
+    const apiUrl = options.apiUrl ?? DEFAULT_API_URL;
     this.contractNamespace = options.contractNamespace ?? ANY_EVM;
     this.client = createPublicClient({
       transport: http(options.rpcUrl),
     });
+
+    const headers: Record<string, string> = {};
+    if (options.apiKey) {
+      headers.Authorization = `Bearer ${options.apiKey}`;
+    }
+    this.graphqlClient = new GraphQLClient(apiUrl, { headers });
   }
 
   private normalizeAddress(address: string): `0x${string}` {
@@ -106,8 +113,7 @@ export class ContractsV0Validator implements EVMNetworkValidator {
     variables: Record<string, string>,
   ): Promise<boolean> {
     try {
-      const response = await request<ContractsV0Response>(
-        this.apiUrl,
+      const response = await this.graphqlClient.request<ContractsV0Response>(
         query,
         variables,
       );
@@ -129,28 +135,37 @@ export class ContractsV0Validator implements EVMNetworkValidator {
 export const createContractsV0Validator = (
   rpcUrl: string,
   network?: string,
+  apiKey?: string,
 ): ContractsV0Validator => {
   const contractNamespace = network ?? ANY_EVM;
 
-  return new ContractsV0Validator({ contractNamespace, rpcUrl });
+  return new ContractsV0Validator({ contractNamespace, rpcUrl, apiKey });
 };
 
 export const EthereumContractsV0Validator = (
   rpcUrl: string,
-): ContractsV0Validator => createContractsV0Validator(rpcUrl, "ETHEREUM");
+  apiKey?: string,
+): ContractsV0Validator =>
+  createContractsV0Validator(rpcUrl, "ETHEREUM", apiKey);
 
 export const ArbitrumContractsV0Validator = (
   rpcUrl: string,
-): ContractsV0Validator => createContractsV0Validator(rpcUrl, "ARBITRUM");
+  apiKey?: string,
+): ContractsV0Validator =>
+  createContractsV0Validator(rpcUrl, "ARBITRUM", apiKey);
 
 export const BaseContractsV0Validator = (
   rpcUrl: string,
-): ContractsV0Validator => createContractsV0Validator(rpcUrl, "BASE");
+  apiKey?: string,
+): ContractsV0Validator => createContractsV0Validator(rpcUrl, "BASE", apiKey);
 
 export const OptimismContractsV0Validator = (
   rpcUrl: string,
-): ContractsV0Validator => createContractsV0Validator(rpcUrl, "OPTIMISM");
+  apiKey?: string,
+): ContractsV0Validator =>
+  createContractsV0Validator(rpcUrl, "OPTIMISM", apiKey);
 
 export const AnyEVMContractsV0Validator = (
   rpcUrl: string,
-): ContractsV0Validator => createContractsV0Validator(rpcUrl, ANY_EVM);
+  apiKey?: string,
+): ContractsV0Validator => createContractsV0Validator(rpcUrl, ANY_EVM, apiKey);

ops/external-prs/.env.example

@@ -12,4 +12,6 @@ PR_TOOLS_REPO=
 PR_TOOLS_MAINNET_RPC_URL=
 PR_TOOLS_ARBITRUM_RPC_URL=
 PR_TOOLS_BASE_RPC_URL=
-PR_TOOLS_OPTIMISM_RPC_URL=
+PR_TOOLS_OPTIMISM_RPC_URL=
+# API key for OSO
+PR_TOOLS_OSO_API_KEY=

ops/external-prs/README.md

@@ -50,11 +50,14 @@ Then `git clone` to 2 different paths on your filesystem,
 the oss-directory main branch
 and the PR branch to compare.
 
+> [!TIP]
+> In order to get an OSO API key, visit [`oso.xyz`](https://www.oso.xyz)
+
 You can run the app via:
 
 ```bash
 # Handle PR validations
-pnpm external-prs ossd validate-pr {pr_number} {commit_sha} {main_path} {pr_path}
+pnpm external-prs ossd validate-pr {pr_number} {commit_sha} {main_path} {pr_path} --oso-api-key {oso_api_key}
 ```
 
 If you've configured your GitHub secrets correctly,

ops/external-prs/src/ossd/index.ts

@@ -169,6 +169,11 @@ export function ossdSubcommands(yargs: Argv) {
             type: "string",
             description: "Optimism RPC URL",
             demandOption: true,
+          })
+          .option("oso-api-key", {
+            type: "string",
+            description: "OSO API Key",
+            demandOption: true,
           });
       },
       (args) => handleError(validatePR(args)),
@@ -205,6 +210,7 @@ interface RpcUrlArgs {
   arbitrumRpcUrl: string;
   baseRpcUrl: string;
   optimismRpcUrl: string;
+  osoApiKey: string;
 }
 
 type ValidatePRArgs = OSSDirectoryPullRequestArgs & RpcUrlArgs;
@@ -325,18 +331,23 @@ class OSSDirectoryPullRequest {
     this.defillamaValidator = new DefiLlamaValidator();
     this.blockchainValidators["any_evm"] = AnyEVMContractsV0Validator(
       urls.mainnetRpcUrl,
+      urls.osoApiKey,
     );
     this.blockchainValidators["mainnet"] = EthereumContractsV0Validator(
       urls.mainnetRpcUrl,
+      urls.osoApiKey,
     );
     this.blockchainValidators["arbitrum_one"] = ArbitrumContractsV0Validator(
       urls.arbitrumRpcUrl,
+      urls.osoApiKey,
     );
     this.blockchainValidators["base"] = BaseContractsV0Validator(
       urls.baseRpcUrl,
+      urls.osoApiKey,
     );
     this.blockchainValidators["optimism"] = OptimismContractsV0Validator(
       urls.optimismRpcUrl,
+      urls.osoApiKey,
     );
   }