@show-karma/karma-gap-sdk 0.1.36 → 0.1.38

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.
@@ -38,6 +38,15 @@ export declare abstract class Fetcher extends AxiosGQL {
      * @returns
      */
     abstract communities(search?: string): Promise<Community[]>;
+    /**
+     * Fetch all available communities with details for a grantee;
+     *
+     * If search is defined, will try to find communities by the search string.
+     * @param address grantee address
+     * @param withGrants if true, will get community grants.
+     * @returns
+     */
+    abstract communitiesOf(address: Hex, withGrants?: boolean): Promise<Community[]>;
     /**
      * Fetch a set of communities by their ids.
      * @param uids
@@ -129,4 +138,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

@@ -29,6 +29,7 @@ export declare class GapEasClient extends Fetcher {
      */
     dependentsOf(parentSchema: TSchemaName, parentUid: Hex): Promise<Attestation[]>;
     communities(search?: string): Promise<Community[]>;
+    communitiesOf(address?: Hex): Promise<Community[]>;
     communitiesByIds(uids: Hex[]): Promise<Community[]>;
     communitiesDetails(communities: Community[]): Promise<Community[]>;
     communityBySlug(slug: string): Promise<Community>;
@@ -59,5 +60,6 @@ export declare class GapEasClient extends Fetcher {
      * @param value
      */
     private getSearchFieldString;
+    grantsForExtProject(projectExtId: string): Promise<Grant[]>;
 }
 export {};

package/core/class/GraphQL/GapEasClient.js

@@ -82,6 +82,15 @@ class GapEasClient extends Fetcher_1.Fetcher {
             return [];
         return this.communitiesDetails(communities);
     }
+    async communitiesOf(address) {
+        const [community] = GapSchema_1.GapSchema.findMany(['Community']);
+        const query = gql_queries_1.gqlQueries.attestationsTo(community.uid, address);
+        const { schema: { attestations }, } = await this.query(query);
+        const communities = Attestation_1.Attestation.fromInterface(attestations);
+        if (!communities.length)
+            return [];
+        return this.communitiesDetails(communities);
+    }
     async communitiesByIds(uids) {
         if (!uids.length)
             return [];
@@ -416,5 +425,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,15 +1,16 @@
-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, Hex } 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[]>;
     attestationsOf(schemaName: TSchemaName, attester: `0x${string}`): Promise<IAttestation[]>;
     attestationsTo(schemaName: TSchemaName, recipient: `0x${string}`): Promise<IAttestation[]>;
     communities(search?: string): Promise<Community[]>;
+    communitiesOf(address: Hex, withGrants: boolean): Promise<Community[]>;
     communitiesByIds(uids: `0x${string}`[]): Promise<Community[]>;
     communityBySlug(slug: string): Promise<Community>;
     communityById(uid: `0x${string}`): Promise<Community>;
@@ -21,6 +22,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,28 @@ 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`,
+        communities: (address, withGrants) => `/grantees/${address}/communities${withGrants ? '?withGrants=true' : ''}`,
     },
     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 +38,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 +53,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 +65,17 @@ 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);
     }
+    async communitiesOf(address, withGrants) {
+        const { data } = await this.client.get(Endpoints.grantees.communities(address, withGrants));
+        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 +94,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 +119,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 +132,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/package.json

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