@show-karma/karma-gap-sdk 0.1.34 → 0.1.37

package/core/class/Fetcher.d.ts

@@ -1,8 +1,8 @@
-import { Hex, IAttestation, TSchemaName } from "core/types";
-import { Attestation } from "./Attestation";
-import { Community, Grant, MemberOf, Milestone, Project } from "./entities";
-import { Grantee } from "./types/attestations";
-import { AxiosGQL } from "./GraphQL/AxiosGQL";
+import { Hex, IAttestation, TSchemaName } from 'core/types';
+import { Attestation } from './Attestation';
+import { Community, Grant, MemberOf, Milestone, Project } from './entities';
+import { Grantee } from './types/attestations';
+import { AxiosGQL } from './GraphQL/AxiosGQL';
 export declare abstract class Fetcher extends AxiosGQL {
     /**
      * Fetch a single attestation by its UID.
@@ -129,4 +129,10 @@ export declare abstract class Fetcher extends AxiosGQL {
      * @returns
      */
     abstract slugExists(slug: string): Promise<boolean>;
+    /**
+     * Get grants for a project by an external uid
+     * > Works only for the indexed projects
+     * @param projectExtId
+     */
+    abstract grantsForExtProject(projectExtId: string): Promise<Grant[]>;
 }

package/core/class/GraphQL/GapEasClient.d.ts

@@ -59,5 +59,6 @@ export declare class GapEasClient extends Fetcher {
      * @param value
      */
     private getSearchFieldString;
+    grantsForExtProject(projectExtId: string): Promise<Grant[]>;
 }
 export {};

package/core/class/GraphQL/GapEasClient.js

@@ -416,5 +416,9 @@ class GapEasClient extends Fetcher_1.Fetcher {
             String.raw `\\\\\"${field}\\\\\": \\\\\"${value}\\\\\"`,
         ];
     }
+    async grantsForExtProject(projectExtId) {
+        console.error(new Error('Grants for external project is only supported by a custom indexer. Check https://github.com/show-karma/karma-gap-sdk for more information.'));
+        return [];
+    }
 }
 exports.GapEasClient = GapEasClient;

package/core/class/karma-indexer/GapIndexerClient.d.ts

@@ -1,9 +1,9 @@
-import { TSchemaName, IAttestation } from "core/types";
-import { Attestation } from "../Attestation";
-import { GapSchema } from "../GapSchema";
-import { Fetcher } from "../Fetcher";
-import { Community, Project, Grant, Milestone, MemberOf } from "../entities";
-import { Grantee } from "../types/attestations";
+import { TSchemaName, IAttestation } from 'core/types';
+import { Attestation } from '../Attestation';
+import { GapSchema } from '../GapSchema';
+import { Fetcher } from '../Fetcher';
+import { Community, Project, Grant, Milestone, MemberOf } from '../entities';
+import { Grantee } from '../types/attestations';
 export declare class GapIndexerClient extends Fetcher {
     attestation<T = unknown>(uid: `0x${string}`): Promise<Attestation<T, GapSchema>>;
     attestations(schemaName: TSchemaName, search?: string): Promise<IAttestation[]>;
@@ -21,6 +21,7 @@ export declare class GapIndexerClient extends Fetcher {
     grantees(): Promise<Grantee[]>;
     grantsOf(grantee: `0x${string}`, withCommunity?: boolean): Promise<Grant[]>;
     grantsFor(projects: Project[], withCommunity?: boolean): Promise<Grant[]>;
+    grantsForExtProject(projectExtId: string): Promise<Grant[]>;
     grantsByCommunity(uid: `0x${string}`): Promise<Grant[]>;
     milestonesOf(grants: Grant[]): Promise<Milestone[]>;
     membersOf(projects: Project[]): Promise<MemberOf[]>;

package/core/class/karma-indexer/GapIndexerClient.js

@@ -7,26 +7,27 @@ const Fetcher_1 = require("../Fetcher");
 const entities_1 = require("../entities");
 const Endpoints = {
     attestations: {
-        all: () => "/attestations",
+        all: () => '/attestations',
         byUid: (uid) => `/attestations/${uid}`,
     },
     communities: {
-        all: () => "/communities",
+        all: () => '/communities',
         byUidOrSlug: (uidOrSlug) => `/communities/${uidOrSlug}`,
         grants: (uidOrSlug) => `/communities/${uidOrSlug}/grants`,
     },
     grantees: {
-        all: () => "/grantees",
+        all: () => '/grantees',
         byAddress: (address) => `/grantees/${address}`,
         grants: (address) => `/grantees/${address}/grants`,
         projects: (address) => `/grantees/${address}/projects`,
     },
     grants: {
-        all: () => "/grants",
+        all: () => '/grants',
         byUid: (uid) => `/grants/${uid}`,
+        byExternalId: (id) => `/grants/external-id/${id}`,
     },
     project: {
-        all: () => "/projects",
+        all: () => '/projects',
         byUidOrSlug: (uidOrSlug) => `/projects/${uidOrSlug}`,
         grants: (uidOrSlug) => `/projects/${uidOrSlug}/grants`,
         milestones: (uidOrSlug) => `/projects/${uidOrSlug}/milestones`,
@@ -36,14 +37,14 @@ class GapIndexerClient extends Fetcher_1.Fetcher {
     async attestation(uid) {
         const { data } = await this.client.get(Endpoints.attestations.byUid(uid));
         if (!data)
-            throw new Error("Attestation not found");
+            throw new Error('Attestation not found');
         return Attestation_1.Attestation.fromInterface([data])[0];
     }
     async attestations(schemaName, search) {
         const { data } = await this.client.get(Endpoints.attestations.all(), {
             params: {
-                "filter[schemaUID]": GapSchema_1.GapSchema.get(schemaName).uid,
-                "filter[data]": search,
+                'filter[schemaUID]': GapSchema_1.GapSchema.get(schemaName).uid,
+                'filter[data]': search,
             },
         });
         return data || [];
@@ -51,8 +52,8 @@ class GapIndexerClient extends Fetcher_1.Fetcher {
     async attestationsOf(schemaName, attester) {
         const { data } = await this.client.get(Endpoints.attestations.all(), {
             params: {
-                "filter[schemaUID]": GapSchema_1.GapSchema.get(schemaName).uid,
-                "filter[recipient]": attester,
+                'filter[schemaUID]': GapSchema_1.GapSchema.get(schemaName).uid,
+                'filter[recipient]': attester,
             },
         });
         return data || [];
@@ -63,13 +64,13 @@ class GapIndexerClient extends Fetcher_1.Fetcher {
     async communities(search) {
         const { data } = await this.client.get(Endpoints.communities.all(), {
             params: {
-                "filter[name]": search,
+                'filter[name]': search,
             },
         });
         return entities_1.Community.from(data);
     }
     communitiesByIds(uids) {
-        throw new Error("Method not implemented.");
+        throw new Error('Method not implemented.');
     }
     async communityBySlug(slug) {
         const { data } = await this.client.get(Endpoints.communities.byUidOrSlug(slug));
@@ -88,7 +89,7 @@ class GapIndexerClient extends Fetcher_1.Fetcher {
     async projects(name) {
         const { data } = await this.client.get(Endpoints.project.all(), {
             params: {
-                "filter[title]": name,
+                'filter[title]': name,
             },
         });
         return entities_1.Project.from(data);
@@ -113,6 +114,10 @@ class GapIndexerClient extends Fetcher_1.Fetcher {
         const { data } = await this.client.get(Endpoints.project.grants(projects[0].uid));
         return entities_1.Grant.from(data);
     }
+    async grantsForExtProject(projectExtId) {
+        const { data } = await this.client.get(Endpoints.grants.byExternalId(projectExtId));
+        return entities_1.Grant.from(data);
+    }
     async grantsByCommunity(uid) {
         const { data } = await this.client.get(Endpoints.communities.grants(uid));
         return entities_1.Grant.from(data);
@@ -122,7 +127,7 @@ class GapIndexerClient extends Fetcher_1.Fetcher {
         return entities_1.Milestone.from(data);
     }
     async membersOf(projects) {
-        throw new Error("Method not implemented.");
+        throw new Error('Method not implemented.');
     }
     async slugExists(slug) {
         try {

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

@@ -1,6 +1,6 @@
-import { GelatoRelay } from "@gelatonetwork/relay-sdk";
-import { Hex } from "../../types";
-declare function sendByUrl(...params: Parameters<GelatoRelay["sponsoredCall"]>): Promise<string>;
+import { GelatoRelay } from '@gelatonetwork/relay-sdk';
+import { Hex } from '../../types';
+declare function sendByUrl(...params: Parameters<GelatoRelay['sponsoredCall']>): Promise<string>;
 /**
  * Send gelato using an explicit api key.
  *
@@ -9,20 +9,21 @@ declare function sendByUrl(...params: Parameters<GelatoRelay["sponsoredCall"]>):
  * @param params
  * @returns Gelato's task id and a wait function.
  */
-declare function sendByApiKey(...params: Parameters<GelatoRelay["sponsoredCall"]>): Promise<{
+declare function sendByApiKey(...params: Parameters<GelatoRelay['sponsoredCall']>): Promise<{
     taskId: string;
     /**
      * Waits for the transaction to be confirmed by Gelato.
+     * @param ttl interval between checks in ms
      * @returns Txn id
      */
-    wait: () => Promise<string>;
+    wait: (ttl?: number) => Promise<string>;
 }>;
 /**
  * Sends a sponsored call using GelatoRelay
  * @param payload
  * @returns txn hash
  */
-declare function sendGelatoTxn(...params: Parameters<GelatoRelay["sponsoredCall"]>): Promise<string>;
+declare function sendGelatoTxn(...params: Parameters<GelatoRelay['sponsoredCall']>): Promise<string>;
 /**
  * Builds the arguments for a sponsored call using GelatoRelay
  * @param data Populated contract call.
@@ -45,7 +46,7 @@ declare function buildArgs(
 /**
  * Populated transaction data.
  */
-data: string, chainId: bigint, target: Hex): Parameters<GelatoRelay["sponsoredCall"]>;
+data: string, chainId: bigint, target: Hex): Parameters<GelatoRelay['sponsoredCall']>;
 declare const Gelato: {
     sendByApiKey: typeof sendByApiKey;
     sendByUrl: typeof sendByUrl;

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

@@ -22,9 +22,9 @@ async function sendByUrl(...params) {
  */
 async function sendByApiKey(...params) {
     const { apiKey } = GAP_1.GAP?.gelatoOpts || {};
-    if (!apiKey && params[1] === "{apiKey}")
-        throw new Error("No api key provided.");
-    if (apiKey && params[1] === "{apiKey}")
+    if (!apiKey && params[1] === '{apiKey}')
+        throw new Error('No api key provided.');
+    if (apiKey && params[1] === '{apiKey}')
         params[1] = apiKey;
     const client = new relay_sdk_1.GelatoRelay();
     const relayResponse = await client.sponsoredCall(...params);
@@ -32,9 +32,10 @@ async function sendByApiKey(...params) {
         taskId: relayResponse.taskId,
         /**
          * Waits for the transaction to be confirmed by Gelato.
+         * @param ttl interval between checks in ms
          * @returns Txn id
          */
-        wait: () => (0, watch_gelato_txn_1.watchGelatoTxn)(relayResponse.taskId),
+        wait: (ttl) => (0, watch_gelato_txn_1.watchGelatoTxn)(relayResponse.taskId, ttl),
     };
 }
 /**
@@ -44,10 +45,10 @@ async function sendByApiKey(...params) {
  */
 async function sendGelatoTxn(...params) {
     if (!GAP_1.GAP.gelatoOpts)
-        throw new Error("Gelato opts not set.");
+        throw new Error('Gelato opts not set.');
     const { env_gelatoApiKey, sponsorUrl, useGasless, contained } = GAP_1.GAP.gelatoOpts;
     if (!useGasless)
-        throw new Error("Gasless is not enabled.");
+        throw new Error('Gasless is not enabled.');
     if ((sponsorUrl && contained && env_gelatoApiKey) ||
         (sponsorUrl && !contained)) {
         return sendByUrl(...params);
@@ -85,7 +86,7 @@ data, chainId, target) {
             chainId,
             target,
         },
-        "{apiKey}",
+        '{apiKey}',
         {
             retries: 3,
         },

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

@@ -3,5 +3,5 @@
  * @param taskId
  * @returns
  */
-declare function watchGelatoTxn(taskId: string): Promise<string>;
+declare function watchGelatoTxn(taskId: string, ttl?: number): Promise<string>;
 export { watchGelatoTxn };

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

@@ -18,35 +18,43 @@ var TaskState;
  * @param taskId
  * @returns
  */
-async function watchGelatoTxn(taskId) {
+async function watchGelatoTxn(taskId, ttl = 500) {
     const client = new relay_sdk_1.GelatoRelay();
     return new Promise((resolve, reject) => {
         const loop = async () => {
             const oneSecond = 1;
-            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;
+            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));
                 }
-                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, 500));
+            }
+            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();

package/package.json

@@ -3,7 +3,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.1.34",
+    "version": "0.1.37",
     "description": "Simple and easy interface between EAS and Karma GAP.",
     "main": "dist/index.js",
     "author": "KarmaHQ",