@show-karma/karma-gap-sdk 0.3.4 → 0.3.6

package/core/types.ts

@@ -1,186 +0,0 @@
-import { BytesLike } from 'ethers';
-import {
-  AttestationRequestData,
-  EAS,
-  MultiAttestationRequest,
-  SchemaItem,
-} from '@ethereum-attestation-service/eas-sdk';
-import { SignerOrProvider as EASSigner } from '@ethereum-attestation-service/eas-sdk/dist/transaction';
-import { Attestation, GAP } from './class';
-import { Fetcher } from './class/Fetcher';
-export type Hex = `0x${string}`;
-
-export type SignerOrProvider = EASSigner & {
-  address?: Hex;
-  _address?: Hex;
-  getAddress?: () => Promise<Hex>;
-};
-
-export interface SchemaInterface<T extends string = string> {
-  name: string;
-  schema: SchemaItem[];
-  references?: T;
-  uid: Hex;
-  revocable?: boolean;
-}
-
-export interface MultiRevokeArgs {
-  uid: Hex;
-  schemaId: Hex;
-}
-
-export interface AttestArgs<T = unknown> {
-  to: Hex;
-  data: T;
-  refUID?: Hex;
-  signer: SignerOrProvider;
-}
-
-export type TSchemaName =
-  | 'Community'
-  | 'CommunityDetails'
-  | 'Grant'
-  | 'GrantDetails'
-  | 'GrantVerified'
-  | 'MemberOf'
-  | 'MemberDetails'
-  | 'Milestone'
-  | 'MilestoneCompleted'
-  | 'MilestoneApproved'
-  | 'Project'
-  | 'ProjectDetails'
-  | 'Details';
-
-export type TResolvedSchemaNames =
-  | 'Community'
-  | 'Grant'
-  | 'GrantVerified'
-  | 'MemberOf'
-  | 'MilestoneCompleted'
-  | 'MilestoneApproved'
-  | 'Project'
-  | 'Details';
-
-export type TExternalLink =
-  | 'twitter'
-  | 'github'
-  | 'website'
-  | 'linkedin'
-  | 'discord';
-
-export type TNetwork =
-  // | "mainnet"
-  // | "base-goerli"
-  | 'optimism'
-  | 'optimism-goerli'
-  | "arbitrum"
-  | 'sepolia';
-
-/**
- * Generic GAP Facade interface.
- * This supplies the GAP class with the necessary properties.
- */
-export abstract class Facade {
-  abstract readonly network: TNetwork;
-  abstract readonly schemas: SchemaInterface[];
-  abstract readonly fetch: Fetcher;
-  protected _eas: EAS;
-
-  get eas() {
-    return this._eas;
-  }
-}
-
-export interface RawAttestationPayload {
-  schema: Hex;
-  data: {
-    payload: AttestationRequestData;
-    raw: AttestationRequestData;
-  };
-}
-
-export interface RawMultiAttestPayload {
-  payload: MultiAttestData;
-  raw: MultiAttestData;
-}
-
-export interface MultiAttestData {
-  uid?: Hex;
-  multiRequest: MultiAttestationRequest;
-  refIdx: number;
-}
-
-export type MultiAttestPayload = [Attestation, RawMultiAttestPayload][];
-
-export interface EASNetworkConfig {
-  url: string;
-  rpcUrl: string;
-  chainId: number;
-  contracts: {
-    eas: Hex;
-    schema: Hex;
-    multicall: Hex;
-    projectResolver: Hex;
-  };
-  /**
-   * A tuple containing the schema name and it's UID for that network
-   */
-  schemas: Record<TResolvedSchemaNames, Hex>;
-}
-
-export type IGapSchema = SchemaInterface<TSchemaName>;
-
-export type JSONStr = string;
-
-export interface Schemata {
-  uid: Hex;
-  schema: string;
-}
-
-export interface SchemataRes {
-  schemata: Schemata[];
-}
-
-export interface IAttestation {
-  uid: Hex;
-  attester: Hex;
-  data: BytesLike;
-  decodedDataJson: JSONStr;
-  recipient: Hex;
-  revoked: boolean;
-  createdAt: number;
-  refUID?: Hex;
-  isOffchain: boolean;
-  revocable: boolean;
-  revocationTime?: number;
-  schemaId: Hex;
-}
-
-export interface AttestationRes {
-  attestation: IAttestation;
-}
-
-export interface AttestationsRes {
-  attestations: IAttestation[];
-}
-
-export interface SchemaRes {
-  schema: {
-    attestations: IAttestation[];
-  };
-}
-
-/**
- * Valid remote storage types
- */
-export const enum STORAGE_TYPE {
-  IPFS = 0,
-  ARWEAVE = 1,
-  SWARM = 2,
-  UNKNOWN = 3,
-}
-
-export type TRemoteStorageOutput<T = unknown> = {
-  hash: T;
-  storageType: number;
-};

package/core/utils/gelato/index.ts

@@ -1,3 +0,0 @@
-export * from './send-gelato-txn';
-export * from './sponsor-handler';
-export * from './watch-gelato-txn';

package/core/utils/gelato/send-gelato-txn.ts

@@ -1,114 +0,0 @@
-import axios from 'axios';
-import { GelatoRelay } from '@gelatonetwork/relay-sdk';
-import { watchGelatoTxn } from './watch-gelato-txn';
-import { GAP } from '../../class/GAP';
-import { Hex } from '../../types';
-
-async function sendByUrl(...params: Parameters<GelatoRelay['sponsoredCall']>) {
-  const { data } = await axios.post<string>(GAP.gelatoOpts.sponsorUrl, params);
-  return data;
-}
-
-/**
- * Send gelato using an explicit api key.
- *
- * > __This is not safe in the frontend.__
- *
- * @param params
- * @returns Gelato's task id and a wait function.
- */
-async function sendByApiKey(
-  ...params: Parameters<GelatoRelay['sponsoredCall']>
-) {
-  const { apiKey } = GAP?.gelatoOpts || {};
-
-  if (!apiKey && params[1] === '{apiKey}')
-    throw new Error('No api key provided.');
-
-  if (apiKey && params[1] === '{apiKey}') params[1] = apiKey;
-
-  const client = new GelatoRelay();
-  const relayResponse = await client.sponsoredCall(...params);
-
-  return {
-    taskId: relayResponse.taskId,
-    /**
-     * Waits for the transaction to be confirmed by Gelato.
-     * @param ttl interval between checks in ms
-     * @returns Txn id
-     */
-    wait: (ttl?: number) => watchGelatoTxn(relayResponse.taskId, ttl),
-  };
-}
-
-/**
- * Sends a sponsored call using GelatoRelay
- * @param payload
- * @returns txn hash
- */
-async function sendGelatoTxn(
-  ...params: Parameters<GelatoRelay['sponsoredCall']>
-) {
-  if (!GAP.gelatoOpts) throw new Error('Gelato opts not set.');
-  const { env_gelatoApiKey, sponsorUrl, useGasless, contained } =
-    GAP.gelatoOpts;
-
-  if (!useGasless) throw new Error('Gasless is not enabled.');
-
-  if (
-    (sponsorUrl && contained && env_gelatoApiKey) ||
-    (sponsorUrl && !contained)
-  ) {
-    return sendByUrl(...params);
-  }
-
-  const { wait } = await sendByApiKey(...params);
-  return wait();
-}
-
-/**
- * Builds the arguments for a sponsored call using GelatoRelay
- * @param data Populated contract call.
- * @param chainId
- * @param target target contract address (Hex)
- *
- * @example
- *
- * ```ts
- * const { data } = await contract.populateTransaction.transfer(
- *  recipient,
- *  amount
- * );
- * const args = buildArgs(data, chainId, target);
- * const txn = sendGelatoTxn(...args);
- * console.log(txn) // 0xabc..
- * ```
- */
-function buildArgs(
-  /**
-   * Populated transaction data.
-   */
-  data: string,
-  chainId: bigint,
-  target: Hex
-): Parameters<GelatoRelay['sponsoredCall']> {
-  return [
-    {
-      data,
-      chainId,
-      target,
-    },
-    '{apiKey}', // filled in the api
-    {
-      retries: 3,
-    },
-  ];
-}
-
-const Gelato = {
-  sendByApiKey,
-  sendByUrl,
-  buildArgs,
-};
-
-export { sendGelatoTxn, Gelato };

package/core/utils/gelato/sponsor-handler.ts

@@ -1,77 +0,0 @@
-import { GelatoRelay } from "@gelatonetwork/relay-sdk";
-import { GAP } from "../../class/GAP";
-import { Gelato, sendGelatoTxn } from "./send-gelato-txn";
-
-export interface ApiRequest {
-  method: string;
-  body: unknown;
-}
-
-export interface ApiResponse {
-  statusCode: number;
-  send: (body: unknown) => void;
-}
-
-const assertionObj = [
-  {
-    data: /0x[a-fA-F0-9]+/gim,
-    chainId: /\d+/,
-    target: /0x[a-fA-F0-9]{40}/gim,
-  },
-  /\{apiKey\}/,
-  {
-    retries: /\d+/,
-  },
-];
-
-function assert(body: any): body is Parameters<GelatoRelay["sponsoredCall"]> {
-  if (!Array.isArray(body) || body.length !== assertionObj.length)
-    throw new Error("Invalid request body");
-
-  assertionObj.forEach((item, index) => {
-    // check if objects from assertion Object are present in body
-    // and test them using the regexp from the assertion Object
-    if (typeof item === "object") {
-      Object.entries(item).forEach(([key, value]) => {
-        if (!body[index][key]?.toString().match(value))
-          throw new Error("Invalid request body");
-      });
-    }
-    // test other items as strings
-    else if (!body[index]?.toString().match(item))
-      throw new Error("Invalid request body");
-  });
-
-  return true;
-}
-
-export async function handler(
-  req: ApiRequest,
-  res: ApiResponse,
-  env_gelatoApiKey: string
-) {
-  if (req.method !== "POST") {
-    res.statusCode = 405;
-    res.send("Method not allowed");
-    return;
-  }
-  try {
-    const body = req.body as unknown;
-
-    if (!assert(body)) return;
-
-    const { [env_gelatoApiKey]: apiKey } = process.env;
-    if (!apiKey) throw new Error("Api key not provided.");
-    body[1] = apiKey;
-
-    const result = await Gelato.sendByApiKey(...body);
-    const txId = await result.wait();
-    res.send(txId);
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  } catch (error: any) {
-    // eslint-disable-next-line no-console
-    console.log(error);
-    res.statusCode = 400;
-    res.send(error.message);
-  }
-}

package/core/utils/gelato/watch-gelato-txn.ts

@@ -1,67 +0,0 @@
-import { GelatoRelay } from '@gelatonetwork/relay-sdk';
-
-enum TaskState {
-  CheckPending = 'CheckPending',
-  ExecPending = 'ExecPending',
-  ExecSuccess = 'ExecSuccess',
-  ExecReverted = 'ExecReverted',
-  WaitingForConfirmation = 'WaitingForConfirmation',
-  Blacklisted = 'Blacklisted',
-  Cancelled = 'Cancelled',
-  NotFound = 'NotFound',
-}
-
-/**
- * Waits for a transaction to be mined at Gelato Network
- * @param taskId
- * @returns
- */
-async function watchGelatoTxn(taskId: string, ttl = 500): Promise<string> {
-  const client = new GelatoRelay();
-  return new Promise((resolve, reject) => {
-    const loop = async () => {
-      const oneSecond = 1;
-      try {
-        while (oneSecond) {
-          const status = await client.getTaskStatus(taskId);
-          // print status :D so we can debug this for now
-          // eslint-disable-next-line no-console
-          console.log(status);
-          if (!status) {
-            reject(new Error('Transaction goes wrong.'));
-            break;
-          }
-          if (status && status.taskState === TaskState.ExecSuccess) {
-            resolve(status.transactionHash || '');
-            break;
-          } else if (
-            [
-              TaskState.Cancelled,
-              TaskState.ExecReverted,
-              TaskState.Blacklisted,
-            ].includes(status?.taskState)
-          ) {
-            reject(
-              new Error(
-                status.lastCheckMessage
-                  ?.split(/(RegisterDelegate)|(Execution error): /)
-                  .at(-1) || ''
-              )
-            );
-            break;
-          }
-
-          await new Promise((r) => setTimeout(r, ttl));
-        }
-      } catch {
-        // gelato may throw 429 error, so we need to retry
-        // Increase ttl to avoid too deadlocking
-        // Max ttl is 30s
-        ttl += Math.max(30000, ttl + 1000);
-      }
-    };
-    loop();
-  });
-}
-
-export { watchGelatoTxn };

package/core/utils/get-date.ts

@@ -1,3 +0,0 @@
-export function getDate(date: Date | number) {
-  return typeof date === "number" ? new Date(date * 1000) : date;
-}

package/core/utils/get-ipfs-data.ts

@@ -1,13 +0,0 @@
-import axios from 'axios';
-
-export async function getIPFSData<T>(cid: string): Promise<T> {
-  try {
-    const { data } = await axios.get(`https://ipfs.io/ipfs/${cid}`, {
-      timeout: 5000,
-    });
-    return data as T;
-  } catch (err) {
-    console.error(err);
-    throw new Error(`Error to retrive data for CID: ${cid}`);
-  }
-}

package/core/utils/get-web3-provider.ts

@@ -1,20 +0,0 @@
-import { Networks } from '../consts';
-import { ethers } from 'ethers';
-
-const providers: Record<number, ethers.providers.JsonRpcProvider> = {};
-
-export const getWeb3Provider = (
-  chainId: number
-): ethers.providers.JsonRpcProvider => {
-  const rpcUrl = Object.values(Networks).find((n) => n.chainId === chainId)
-    ?.rpcUrl;
-
-  if (!rpcUrl) {
-    throw new Error(`No rpcUrl found for chainId ${chainId}`);
-  }
-
-  if (!providers[chainId]) {
-    providers[chainId] = new ethers.providers.JsonRpcProvider(rpcUrl);
-  }
-  return providers[chainId];
-};

package/core/utils/gql-queries.ts

@@ -1,133 +0,0 @@
-import { nullRef } from "../consts";
-import { Hex } from "../types";
-
-const inStatement = (values: (string | number)[]) =>
-  `[${values.map((v) => `"${v}"`).join(",")}]`;
-
-const attestationFields = `
-    uid: id
-    attester
-    data
-    decodedDataJson
-    recipient
-    revoked
-    createdAt: timeCreated
-    refUID
-    isOffchain
-    revocable
-    revocationTime
-    schemaId
-`;
-
-const schemaQuery = (schemaId: Hex, content: string) =>
-  `{schema(where: {id: "${schemaId}"}) {${content}}}`;
-
-export const gqlQueries = {
-  attestation: (uid: Hex) => `
-    {
-      attestation(where: {
-        id: "${uid}"
-      }) {${attestationFields}}
-    }`,
-  attestations: (schemaId: Hex, uid: Hex) =>
-    schemaQuery(
-      schemaId,
-      `attestations(where: {
-        revoked: {equals: false}
-        decodedDataJson: {contains: "${uid}"}
-      }) {${attestationFields}}`
-    ),
-  attestationsIn: (uids: Hex[], search?: string) => `
-    {
-      attestations(where: {
-        id:{in: ${inStatement(uids)}}
-        revoked:{equals:false}
-        ${
-          search
-            ? `decodedDataJson:{contains:"${search}",mode:insensitive}`
-            : ""
-        }
-      }) {${attestationFields}}
-    }`,
-  attestationsFrom: (schemaId: Hex, attester: Hex) =>
-    schemaQuery(
-      schemaId,
-      `attestations(orderBy:{timeCreated: desc},
-        where:{attester:{equals:"${attester}"}
-        revoked:{equals:false}
-      }){${attestationFields}}`
-    ),
-  attestationsTo: (schemaId: Hex, recipient: Hex) =>
-    schemaQuery(
-      schemaId,
-      `attestations(orderBy:{timeCreated: desc},
-        where:{
-          recipient:{equals:"${recipient}"}
-          revoked:{equals:false}
-        }){${attestationFields}}`
-    ),
-  attestationPairs: (schemaId: Hex, attester: Hex, recipient: Hex) =>
-    schemaQuery(
-      schemaId,
-      `attestations(where: {
-          attester: {equals: "${attester}"}
-          recipient: {equals: "${recipient}"}
-          revoked: {equals: false}
-        }) {${attestationFields}}`
-    ),
-  attestationsOf: (
-    schemaId: Hex,
-    search?: string[] | string,
-    refUids?: Hex[]
-  ) =>
-    schemaQuery(
-      schemaId,
-      `attestations(orderBy:{timeCreated: desc},
-        where: {
-          revoked:{equals:false}
-          ${
-            refUids && refUids.length
-              ? `refUID:{in: ${inStatement(refUids)}}`
-              : ""
-          }
-          ${
-            search
-              ? `OR: [
-                ${[search]
-                  .flat()
-                  .map(
-                    (s) =>
-                      `{decodedDataJson:{contains:"${s}",mode:insensitive}}`
-                  )
-                  .join(",")}
-              ]`
-              : ""
-          }
-        })
-        {${attestationFields}}`
-    ),
-
-  dependentsOf: (
-    refs: Hex | Hex[],
-    schemaIds: Hex[],
-    attesters: Hex[] = []
-  ) => `
-    {
-      attestations(
-        orderBy:{timeCreated: desc},
-        where: {
-          refUID:{in: ${inStatement([refs].flat())}}
-          revoked:{equals: false}
-          schemaId:{in: ${inStatement(schemaIds)}}
-          ${attesters.length ? `attester:{in:${inStatement(attesters)}}` : ""}
-      }){${attestationFields}}
-    }
-  `,
-  schemata: (creator: Hex) => `
-    {
-        schemata(where: {creator: {equals: "${creator}"}}) {
-            uid: id
-            schema
-        }
-    }`,
-};

package/core/utils/index.ts

@@ -1,7 +0,0 @@
-export * from './gelato';
-export * from './get-date';
-export * from './gql-queries';
-export * from './map-filter';
-export * from './serialize-bigint';
-export * from './to-unix';
-export * from './get-ipfs-data';

package/core/utils/map-filter.ts

@@ -1,21 +0,0 @@
-/**
- * Filters an array by its condition then maps it to the desired format.
- * @param arr
- * @param condition
- * @param mapTo
- * @returns
- */
-export function mapFilter<T = unknown, U = unknown>(
-  arr: U[],
-  condition: (item: U) => boolean,
-  mapTo: (item: U) => T
-): T[] {
-  const newArray: T[] = [];
-
-  for (const item of arr) {
-    if (condition(item)) {
-      newArray.push(mapTo(item));
-    }
-  }
-  return newArray;
-}

package/core/utils/serialize-bigint.ts

@@ -1,7 +0,0 @@
-export function serializeWithBigint(value: unknown) {
-  return JSON.stringify(
-    value,
-    (this,
-    (key, value) => (typeof value === "bigint" ? value.toString() : value))
-  );
-}

package/core/utils/to-unix.ts

@@ -1,18 +0,0 @@
-export function toUnix(value: number | Date | string) {
-  switch (typeof value) {
-    case "number":
-      value = Math.round(value);
-      if (value.toString().length > 13)
-        throw new Error("Invalid timestamp length");
-      if (value.toString().length === 10) return value;
-      return Math.floor(value / 1000);
-    case "string":
-      if (/\D/.test(value)) return null;
-      return toUnix(+value);
-    case "object":
-      if (value instanceof Date) return toUnix(value.getTime());
-      return null;
-    default:
-      return null;
-  }
-}

package/csv-upload/example.csv

@@ -1,2 +0,0 @@
-URL,Owner,Twitter,Github,Website,"Project Description","If you've participated in past grant rounds, please share any new updates or milestones from the prior months",How do you measure the impact of your project?
-https://explorer.gitcoin.co/#/round/424/0x222ea76664ed77d18d4416d2b2e77937b76f0a35/0x222ea76664ed77d18d4416d2b2e77937b76f0a35-5,ethdotlimo.eth,https://eth.limo,https://github.com/ethlimo,https://eth.limo,"eth.limo is a privacy-preserving ENS gateway, enabling users to access Ethereum-native dApps and content. LIMO represents a shift in dweb adoption by providing an alternative means of accessing ENS resolvable domains.","Support for .art ENS domain resolution, maintained 100% uptime, 1w3.eth content pinning - this ensures fast and reliable access to ENS domain data, with multiple storage locations and a streamlined gateway to IPFS for improved speed and availability. We're also working on some back-end improvements.",