@show-karma/karma-gap-sdk 0.4.9 → 0.4.11

package/core/class/entities/ContributorProfile.d.ts

@@ -8,6 +8,7 @@ export interface IContributorProfile {
     github?: string;
     twitter?: string;
     linkedin?: string;
+    farcaster?: string;
 }
 export declare class ContributorProfile extends Attestation<IContributorProfile> implements IContributorProfile {
     name: string;
@@ -15,6 +16,7 @@ export declare class ContributorProfile extends Attestation<IContributorProfile>
     github?: string;
     twitter?: string;
     linkedin?: string;
+    farcaster?: string;
     constructor(data: AttestationArgs<IContributorProfile, GapSchema>);
     /**
      * Creates the payload for a multi-attestation.

package/core/class/entities/Grant.d.ts

@@ -4,16 +4,11 @@ import { IMilestone, Milestone } from "./Milestone";
 import { GapSchema } from "../GapSchema";
 import { Hex, MultiAttestPayload, SignerOrProvider, TNetwork } from "core/types";
 import { Community } from "./Community";
-import { IGrantResponse } from "../karma-indexer/api/types";
+import { IGrantResponse, IProjectResponse, ISummaryProject } from "../karma-indexer/api/types";
 import { GrantUpdate, IGrantUpdate } from "./GrantUpdate";
 export interface IGrant {
     communityUID: Hex;
 }
-export interface ISummaryProject {
-    title: string;
-    slug?: string;
-    uid: Hex;
-}
 export declare class Grant extends Attestation<IGrant> {
     details?: GrantDetails;
     communityUID: Hex;
@@ -24,7 +19,7 @@ export declare class Grant extends Attestation<IGrant> {
     updates: GrantUpdate[];
     members: string[];
     completed?: GrantCompleted;
-    project?: ISummaryProject;
+    project?: IProjectResponse | ISummaryProject;
     categories?: string[];
     verify(signer: SignerOrProvider): Promise<void>;
     /**

package/core/class/entities/GrantUpdate.d.ts

@@ -1,13 +1,11 @@
+import { IGrantUpdateBase } from "core/shared/types";
+import { Transaction } from "ethers";
 import { SignerOrProvider, TNetwork } from "../../../core/types";
 import { Attestation } from "../Attestation";
-import { Transaction } from "ethers";
 export interface _IGrantUpdate extends GrantUpdate {
 }
-export interface IGrantUpdate {
-    title: string;
-    text: string;
+export interface IGrantUpdate extends IGrantUpdateBase {
     type?: string;
-    proofOfWork?: string;
 }
 type IStatus = "verified";
 export interface IGrantUpdateStatus {

package/core/class/entities/GrantUpdate.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GrantUpdate = exports.GrantUpdateStatus = void 0;
+const consts_1 = require("../../../core/consts");
+const AllGapSchemas_1 = require("../AllGapSchemas");
 const Attestation_1 = require("../Attestation");
 const SchemaError_1 = require("../SchemaError");
-const AllGapSchemas_1 = require("../AllGapSchemas");
-const consts_1 = require("../../../core/consts");
 class GrantUpdateStatus extends Attestation_1.Attestation {
 }
 exports.GrantUpdateStatus = GrantUpdateStatus;

package/core/class/entities/Track.d.ts

@@ -0,0 +1,16 @@
+import { TNetwork } from "core/types";
+import { ITrackResponse } from "../karma-indexer/api/types";
+export declare class Track {
+    id: string;
+    name: string;
+    description?: string;
+    communityUID: string;
+    isArchived: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+    programId?: string;
+    isActive?: boolean;
+    network: TNetwork;
+    constructor(data: any, network: TNetwork);
+    static from(data: ITrackResponse[], network: TNetwork): Track[];
+}

package/core/class/entities/Track.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Track = void 0;
+class Track {
+    constructor(data, network) {
+        this.id = data.id;
+        this.name = data.name;
+        this.description = data.description;
+        this.communityUID = data.communityUID;
+        this.isArchived = data.isArchived ?? false;
+        this.createdAt = new Date(data.createdAt);
+        this.updatedAt = new Date(data.updatedAt);
+        this.programId = data.programId;
+        this.isActive = data.isActive;
+        this.network = network;
+    }
+    static from(data, network) {
+        return data.map((item) => new Track(item, network));
+    }
+}
+exports.Track = Track;

package/core/class/entities/index.d.ts

@@ -7,3 +7,4 @@ export * from "./GrantUpdate";
 export * from "./ProjectUpdate";
 export * from "./ProjectPointer";
 export * from "./ContributorProfile";
+export * from "./Track";

package/core/class/entities/index.js

@@ -23,3 +23,4 @@ __exportStar(require("./GrantUpdate"), exports);
 __exportStar(require("./ProjectUpdate"), exports);
 __exportStar(require("./ProjectPointer"), exports);
 __exportStar(require("./ContributorProfile"), exports);
+__exportStar(require("./Track"), exports);

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

@@ -2,7 +2,7 @@ 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 { Community, Project, Grant, Milestone, MemberOf, Track } from "../entities";
 import { Grantee } from "../types/attestations";
 import { ICommunityAdminsResponse } from "./api/types";
 import { ProjectMilestone } from "../entities/ProjectMilestone";
@@ -40,4 +40,27 @@ export declare class GapIndexerClient extends Fetcher {
     milestonesOf(grants: Grant[]): Promise<Milestone[]>;
     membersOf(projects: Project[]): Promise<MemberOf[]>;
     slugExists(slug: string): Promise<boolean>;
+    /**
+     * Track related methods
+     */
+    getTracks(communityUID: string, includeArchived?: boolean): Promise<Track[]>;
+    getTrackById(id: string): Promise<Track>;
+    createTrack(trackData: {
+        name: string;
+        description?: string;
+        communityUID: string;
+    }): Promise<Track>;
+    updateTrack(id: string, trackData: {
+        name?: string;
+        description?: string;
+        communityUID?: string;
+    }): Promise<Track>;
+    archiveTrack(id: string): Promise<Track>;
+    assignTracksToProgram(programId: string, trackIds: string[]): Promise<any[]>;
+    unassignTrackFromProgram(programId: string, trackId: string): Promise<any>;
+    getTracksForProgram(programId: string): Promise<Track[]>;
+    getTracksForProject(projectId: string, programId: string, activeOnly?: boolean): Promise<Track[]>;
+    assignTracksToProject(projectId: string, programId: string, trackIds: string[]): Promise<any[]>;
+    unassignTracksFromProject(projectId: string, programId: string, trackIds: string[]): Promise<any[]>;
+    getProjectsByTrack(communityId: string, programId: string, trackId?: string): Promise<any[]>;
 }

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

@@ -152,5 +152,56 @@ class GapIndexerClient extends Fetcher_1.Fetcher {
     async slugExists(slug) {
         return await this.apiClient.slugExists(slug);
     }
+    /**
+     * Track related methods
+     */
+    async getTracks(communityUID, includeArchived = false) {
+        const { data } = await this.apiClient.getTracks(communityUID, includeArchived);
+        return entities_1.Track.from(data, this.gap.network);
+    }
+    async getTrackById(id) {
+        const { data } = await this.apiClient.getTrackById(id);
+        return entities_1.Track.from([data], this.gap.network)[0];
+    }
+    async createTrack(trackData) {
+        const { data } = await this.apiClient.createTrack(trackData);
+        return entities_1.Track.from([data], this.gap.network)[0];
+    }
+    async updateTrack(id, trackData) {
+        const { data } = await this.apiClient.updateTrack(id, trackData);
+        return entities_1.Track.from([data], this.gap.network)[0];
+    }
+    async archiveTrack(id) {
+        const { data } = await this.apiClient.archiveTrack(id);
+        return entities_1.Track.from([data], this.gap.network)[0];
+    }
+    async assignTracksToProgram(programId, trackIds) {
+        const { data } = await this.apiClient.assignTracksToProgram(programId, trackIds);
+        return data;
+    }
+    async unassignTrackFromProgram(programId, trackId) {
+        const { data } = await this.apiClient.unassignTrackFromProgram(programId, trackId);
+        return data;
+    }
+    async getTracksForProgram(programId) {
+        const { data } = await this.apiClient.getTracksForProgram(programId);
+        return entities_1.Track.from(data, this.gap.network);
+    }
+    async getTracksForProject(projectId, programId, activeOnly = true) {
+        const { data } = await this.apiClient.getTracksForProject(projectId, programId, activeOnly);
+        return entities_1.Track.from(data, this.gap.network);
+    }
+    async assignTracksToProject(projectId, programId, trackIds) {
+        const { data } = await this.apiClient.assignTracksToProject(projectId, programId, trackIds);
+        return data;
+    }
+    async unassignTracksFromProject(projectId, programId, trackIds) {
+        const { data } = await this.apiClient.unassignTracksFromProject(projectId, programId, trackIds);
+        return data;
+    }
+    async getProjectsByTrack(communityId, programId, trackId) {
+        const { data } = await this.apiClient.getProjectsByTrack(communityId, programId, trackId);
+        return data;
+    }
 }
 exports.GapIndexerClient = GapIndexerClient;

package/core/class/karma-indexer/api/GapIndexerApi.d.ts

@@ -1,5 +1,5 @@
 import { AxiosGQL } from "../../GraphQL/AxiosGQL";
-import { Hex, IAttestationResponse, ICommunityResponse, ICommunityAdminsResponse, IGrantResponse, IProjectResponse, ISearchResponse, IProjectMilestoneResponse } from "./types";
+import { Hex, IAttestationResponse, ICommunityResponse, ICommunityAdminsResponse, IGrantResponse, IProjectResponse, ISearchResponse, IProjectMilestoneResponse, ITrackResponse, ITrackAssignmentResponse, IProjectTrackResponse } from "./types";
 export declare class GapIndexerApi extends AxiosGQL {
     constructor(url: string);
     attestation(uid: Hex): Promise<import("axios").AxiosResponse<IAttestationResponse, any>>;
@@ -47,4 +47,27 @@ export declare class GapIndexerApi extends AxiosGQL {
      */
     milestonesOf(uid: Hex): Promise<import("axios").AxiosResponse<any, any>>;
     slugExists(slug: string): Promise<boolean>;
+    /**
+     * Tracks
+     */
+    getTracks(communityUID: string, includeArchived?: boolean): Promise<import("axios").AxiosResponse<ITrackResponse[], any>>;
+    getTrackById(id: string): Promise<import("axios").AxiosResponse<ITrackResponse, any>>;
+    createTrack(data: {
+        name: string;
+        description?: string;
+        communityUID: string;
+    }): Promise<import("axios").AxiosResponse<ITrackResponse, any>>;
+    updateTrack(id: string, data: {
+        name?: string;
+        description?: string;
+        communityUID?: string;
+    }): Promise<import("axios").AxiosResponse<ITrackResponse, any>>;
+    archiveTrack(id: string): Promise<import("axios").AxiosResponse<ITrackResponse, any>>;
+    assignTracksToProgram(programId: string, trackIds: string[]): Promise<import("axios").AxiosResponse<ITrackAssignmentResponse[], any>>;
+    unassignTrackFromProgram(programId: string, trackId: string): Promise<import("axios").AxiosResponse<ITrackAssignmentResponse, any>>;
+    getTracksForProgram(programId: string): Promise<import("axios").AxiosResponse<ITrackResponse[], any>>;
+    getTracksForProject(projectId: string, programId: string, activeOnly?: boolean): Promise<import("axios").AxiosResponse<ITrackResponse[], any>>;
+    assignTracksToProject(projectId: string, programId: string, trackIds: string[]): Promise<import("axios").AxiosResponse<any[], any>>;
+    unassignTracksFromProject(projectId: string, programId: string, trackIds: string[]): Promise<import("axios").AxiosResponse<any[], any>>;
+    getProjectsByTrack(communityId: string, programId: string, trackId?: string): Promise<import("axios").AxiosResponse<IProjectTrackResponse[], any>>;
 }

package/core/class/karma-indexer/api/GapIndexerApi.js

@@ -28,6 +28,7 @@ const Endpoints = {
     },
     project: {
         all: () => "/projects",
+        checkSlug: (slug) => `/projects/check-slug/${slug}`,
         byUidOrSlug: (uidOrSlug) => `/projects/${uidOrSlug}`,
         grants: (uidOrSlug) => `/projects/${uidOrSlug}/grants`,
         milestones: (uidOrSlug) => `/projects/${uidOrSlug}/milestones`,
@@ -36,6 +37,26 @@ const Endpoints = {
     search: {
         all: () => "/search",
     },
+    tracks: {
+        all: () => "/tracks",
+        byId: (id) => `/tracks/${id}`,
+        byCommunity: (communityUID, includeArchived = false) => `/tracks?communityUID=${communityUID}${includeArchived ? "&includeArchived=true" : ""}`,
+    },
+    programs: {
+        tracks: {
+            all: (programId) => `/programs/${programId}/tracks`,
+            assign: (programId) => `/programs/${programId}/tracks`,
+            remove: (programId, trackId) => `/programs/${programId}/tracks/${trackId}`,
+        },
+    },
+    projectTracks: {
+        all: (projectId, programId, activeOnly = true) => `/programs/${programId}/projects/${projectId}/tracks${activeOnly ? "" : "?activeOnly=false"}`,
+        assign: (projectId) => `/projects/${projectId}/tracks`,
+        remove: (programId, projectId) => `/programs/${programId}/project/${projectId}/tracks`,
+    },
+    community: {
+        programProjects: (communityId, programId, trackId) => `/community/${communityId}/program/${programId}/projects${trackId ? `?trackId=${trackId}` : ""}`,
+    },
 };
 class GapIndexerApi extends AxiosGQL_1.AxiosGQL {
     constructor(url) {
@@ -173,12 +194,63 @@ class GapIndexerApi extends AxiosGQL_1.AxiosGQL {
     }
     async slugExists(slug) {
         try {
-            await this.client.get(Endpoints.project.byUidOrSlug(slug));
+            await this.client.get(Endpoints.project.checkSlug(slug));
             return true;
         }
         catch (err) {
             return false;
         }
     }
+    /**
+     * Tracks
+     */
+    async getTracks(communityUID, includeArchived = false) {
+        const response = await this.client.get(Endpoints.tracks.byCommunity(communityUID, includeArchived));
+        return response;
+    }
+    async getTrackById(id) {
+        const response = await this.client.get(Endpoints.tracks.byId(id));
+        return response;
+    }
+    async createTrack(data) {
+        const response = await this.client.post(Endpoints.tracks.all(), data);
+        return response;
+    }
+    async updateTrack(id, data) {
+        const response = await this.client.put(Endpoints.tracks.byId(id), data);
+        return response;
+    }
+    async archiveTrack(id) {
+        const response = await this.client.delete(Endpoints.tracks.byId(id));
+        return response;
+    }
+    async assignTracksToProgram(programId, trackIds) {
+        const response = await this.client.post(Endpoints.programs.tracks.assign(programId), { trackIds });
+        return response;
+    }
+    async unassignTrackFromProgram(programId, trackId) {
+        const response = await this.client.delete(Endpoints.programs.tracks.remove(programId, trackId));
+        return response;
+    }
+    async getTracksForProgram(programId) {
+        const response = await this.client.get(Endpoints.programs.tracks.all(programId));
+        return response;
+    }
+    async getTracksForProject(projectId, programId, activeOnly = true) {
+        const response = await this.client.get(Endpoints.projectTracks.all(projectId, programId, activeOnly));
+        return response;
+    }
+    async assignTracksToProject(projectId, programId, trackIds) {
+        const response = await this.client.post(Endpoints.projectTracks.assign(projectId), { trackIds, programId });
+        return response;
+    }
+    async unassignTracksFromProject(projectId, programId, trackIds) {
+        const response = await this.client.delete(Endpoints.projectTracks.remove(programId, projectId), { data: { trackIds } });
+        return response;
+    }
+    async getProjectsByTrack(communityId, programId, trackId) {
+        const response = await this.client.get(Endpoints.community.programProjects(communityId, programId, trackId));
+        return response;
+    }
 }
 exports.GapIndexerApi = GapIndexerApi;

package/core/class/karma-indexer/api/types.d.ts

@@ -1,3 +1,4 @@
+import { IGrantUpdateBase } from "core/shared/types";
 export type Hex = `0x${string}`;
 export type JSONStr = string;
 export type ExternalLink = {
@@ -63,11 +64,8 @@ export interface IGrantUpdateStatus extends IAttestationResponse {
     };
 }
 export interface IGrantUpdate extends IAttestationResponse {
-    data: {
-        text: string;
-        title: string;
+    data: IGrantUpdateBase & {
         type: "grant-update";
-        proofOfWork?: string;
     };
     verified?: IGrantUpdateStatus[];
 }
@@ -140,6 +138,7 @@ export interface IGrantDetails extends IAttestationResponse {
         programId?: string;
         type: "grant-details";
         fundUsage?: string;
+        selectedTrackIds?: string[];
     };
 }
 export interface IGrantResponse extends IAttestationResponse {
@@ -150,7 +149,7 @@ export interface IGrantResponse extends IAttestationResponse {
     details?: IGrantDetails;
     milestones: IMilestoneResponse[];
     completed?: IGrantUpdate;
-    project: ISummaryProject;
+    project: IProjectResponse;
     updates: IGrantUpdate[];
     community: ICommunityResponse;
     members: Hex[];
@@ -263,4 +262,34 @@ export interface ISearchResponse {
     projects: IProjectResponse[];
     communities: ICommunityResponse[];
 }
+export interface ITrackResponse {
+    id: string;
+    name: string;
+    description?: string;
+    communityUID: string;
+    isArchived: boolean;
+    createdAt: string;
+    updatedAt: string;
+    programId?: string;
+    isActive?: boolean;
+    chainID?: number;
+}
+export interface ITrackAssignmentResponse {
+    id: string;
+    programId: string;
+    chainID: number;
+    trackId: string;
+    track: ITrackResponse;
+}
+export interface IProjectTrackResponse {
+    projectUID: string;
+    chainID: number;
+    programId: string;
+    track: ITrackResponse;
+    project: {
+        uid: string;
+        chainID: number;
+        details: any;
+    };
+}
 export {};

package/core/class/types/attestations.d.ts

@@ -45,6 +45,7 @@ export interface IGrantDetails {
     startDate?: number;
     programId?: string;
     fundUsage?: string;
+    selectedTrackIds?: string[];
 }
 export declare class GrantDetails extends Attestation<IGrantDetails> implements IGrantDetails {
     title: string;
@@ -60,6 +61,7 @@ export declare class GrantDetails extends Attestation<IGrantDetails> implements
     type: string;
     startDate?: number;
     fundUsage?: string;
+    selectedTrackIds?: string[];
 }
 export interface IGrantRound {
     name: string;

package/core/shared/types.d.ts

@@ -0,0 +1,6 @@
+export interface IGrantUpdateBase {
+    title: string;
+    text: string;
+    proofOfWork?: string;
+    completionPercentage?: string;
+}

package/core/shared/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/core/types.d.ts

@@ -29,7 +29,7 @@ export interface AttestArgs<T = unknown> {
 }
 export type TSchemaName = "Community" | "CommunityDetails" | "Grant" | "GrantDetails" | "GrantVerified" | "MemberOf" | "MemberDetails" | "Milestone" | "MilestoneCompleted" | "MilestoneApproved" | "Project" | "ProjectDetails" | "Details" | "ProjectImpact" | "ProjectUpdate" | "ProjectUpdateStatus" | "ProjectPointer" | "GrantUpdate" | "GrantUpdateStatus" | "ProjectEndorsement" | "ProjectMilestone" | "ProjectMilestoneStatus" | "ContributorProfile";
 export type TResolvedSchemaNames = "Community" | "Grant" | "GrantVerified" | "MemberOf" | "MilestoneCompleted" | "MilestoneApproved" | "Project" | "Details" | "ProjectUpdateStatus" | "GrantUpdateStatus" | "ProjectUpdateStatus" | "ProjectMilestoneStatus" | "ContributorProfile";
-export type TExternalLink = "twitter" | "github" | "website" | "linkedin" | "discord";
+export type TExternalLink = "twitter" | "github" | "website" | "linkedin" | "discord" | "pitchDeck" | "demoVideo" | "farcaster";
 export type TNetwork = "optimism" | "celo" | "optimism-sepolia" | "arbitrum" | "sepolia" | "sei" | "sei-testnet" | "base-sepolia";
 /**
  * Generic GAP Facade interface.

package/package.json

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

package/core/abi/AlloCaller.json

@@ -1,117 +0,0 @@
-[
-    {
-        "inputs": [
-            {
-                "internalType": "bytes32",
-                "name": "_profileId",
-                "type": "bytes32"
-            },
-            {
-                "internalType": "address",
-                "name": "_strategy",
-                "type": "address"
-            },
-            {
-                "internalType": "bytes",
-                "name": "_initStrategyData",
-                "type": "bytes"
-            },
-            {
-                "internalType": "address",
-                "name": "_token",
-                "type": "address"
-            },
-            {
-                "internalType": "uint256",
-                "name": "_amount",
-                "type": "uint256"
-            },
-            {
-                "components": [
-                    {
-                        "internalType": "uint256",
-                        "name": "protocol",
-                        "type": "uint256"
-                    },
-                    {
-                        "internalType": "string",
-                        "name": "pointer",
-                        "type": "string"
-                    }
-                ],
-                "internalType": "struct IAllo.Metadata",
-                "name": "_metadata",
-                "type": "tuple"
-            },
-            {
-                "internalType": "address[]",
-                "name": "_managers",
-                "type": "address[]"
-            }
-        ],
-        "name": "createPool",
-        "outputs": [
-            {
-                "internalType": "uint256",
-                "name": "poolId",
-                "type": "uint256"
-            }
-        ],
-        "stateMutability": "payable",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "uint256",
-                "name": "_poolId",
-                "type": "uint256"
-            },
-            {
-                "components": [
-                    {
-                        "internalType": "uint256",
-                        "name": "protocol",
-                        "type": "uint256"
-                    },
-                    {
-                        "internalType": "string",
-                        "name": "pointer",
-                        "type": "string"
-                    }
-                ],
-                "internalType": "struct IAllo.Metadata",
-                "name": "_metadata",
-                "type": "tuple"
-            }
-        ],
-        "name": "updatePoolMetadata",
-        "outputs": [],
-        "stateMutability": "nonpayable",
-        "type": "function"
-    },
-    {
-        "inputs": [
-            {
-                "internalType": "address",
-                "name": "_alloAddress",
-                "type": "address"
-            }
-        ],
-        "stateMutability": "nonpayable",
-        "type": "constructor"
-    },
-    {
-        "inputs": [],
-        "name": "allo",
-        "outputs": [
-            {
-                "internalType": "contract IAllo",
-                "name": "",
-                "type": "address"
-            }
-        ],
-        "stateMutability": "view",
-        "type": "function"
-    }
-]