@show-karma/karma-gap-sdk 0.3.43 → 0.3.45

package/core/class/entities/ProjectMilestone.js

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectMilestone = exports.ProjectMilestoneStatus = void 0;
+const Attestation_1 = require("../Attestation");
+const SchemaError_1 = require("../SchemaError");
+const AllGapSchemas_1 = require("../AllGapSchemas");
+const consts_1 = require("../../../core/consts");
+const attestations_1 = require("../types/attestations");
+class ProjectMilestoneStatus extends Attestation_1.Attestation {
+}
+exports.ProjectMilestoneStatus = ProjectMilestoneStatus;
+class ProjectMilestone extends Attestation_1.Attestation {
+    constructor(data) {
+        data.data.type = "project-milestone";
+        super(data);
+        this.verified = [];
+    }
+    /**
+     * Attest the status of the update as approved, rejected or completed.
+     */
+    async attestStatus(signer, schema, callback) {
+        const eas = this.schema.gap.eas.connect(signer);
+        try {
+            if (callback)
+                callback("preparing");
+            const tx = await eas.attest({
+                schema: schema.uid,
+                data: {
+                    recipient: this.recipient,
+                    data: schema.encode(),
+                    refUID: this.uid,
+                    expirationTime: 0n,
+                    revocable: schema.revocable,
+                },
+            });
+            if (callback)
+                callback("pending");
+            const uid = await tx.wait();
+            if (callback)
+                callback("confirmed");
+            console.log(uid);
+            return {
+                tx: [
+                    {
+                        hash: tx.tx.hash,
+                    },
+                ],
+                uids: [uid],
+            };
+        }
+        catch (error) {
+            console.error(error);
+            throw new SchemaError_1.AttestationError("ATTEST_ERROR", error.message, error);
+        }
+    }
+    /**
+     * Verify this ProjectUpdate. If the ProjectUpdate is not already verified,
+     * it will throw an error.
+     * @param signer
+     * @param reason
+     */
+    async verify(signer, data, callback) {
+        console.log("Verifying");
+        const schema = this.schema.gap.findSchema("ProjectMilestoneStatus");
+        if (this.schema.isJsonSchema()) {
+            schema.setValue("json", JSON.stringify({
+                type: "verified",
+                reason: data?.reason || "",
+            }));
+        }
+        else {
+            schema.setValue("type", "project-milestone-verified");
+            schema.setValue("reason", data?.reason || "");
+        }
+        console.log("Before attest project milestone verified");
+        await this.attestStatus(signer, schema, callback);
+        console.log("After attest project milestone verified");
+        this.verified.push(new ProjectMilestoneStatus({
+            data: {
+                type: "project-milestone-verified",
+                reason: data?.reason || "",
+            },
+            refUID: this.uid,
+            schema: schema,
+            recipient: this.recipient,
+        }));
+    }
+    /**
+     * Marks a milestone as completed. If the milestone is already completed,
+     * it will throw an error.
+     * @param signer
+     * @param reason
+     */
+    async complete(signer, data, callback) {
+        console.log("Completing");
+        const schema = this.schema.gap.findSchema("ProjectMilestoneStatus");
+        if (this.schema.isJsonSchema()) {
+            schema.setValue("json", JSON.stringify({
+                type: "project-milestone-completed",
+                ...data,
+            }));
+        }
+        else {
+            schema.setValue("type", "project-milestone-completed");
+            schema.setValue("proofOfWork", data?.proofOfWork || "");
+            schema.setValue("reason", data?.reason || "");
+        }
+        console.log("Before attest project milestone completed");
+        const { tx, uids } = await this.attestStatus(signer, schema, callback);
+        console.log("After attest project milestone completed");
+        this.completed = new attestations_1.MilestoneCompleted({
+            data: {
+                reason: data?.reason || "",
+            },
+            refUID: this.uid,
+            schema: schema,
+            recipient: this.recipient,
+        });
+        return { tx, uids };
+    }
+    /**
+     * Revokes the completed status of the milestone. If the milestone is not completed,
+     * it will throw an error.
+     * @param signer
+     */
+    async revokeCompletion(signer, callback) {
+        if (!this.completed)
+            throw new SchemaError_1.AttestationError("ATTEST_ERROR", "Milestone is not completed");
+        const { tx, uids } = await this.completed.schema.multiRevoke(signer, [
+            {
+                schemaId: this.completed.schema.uid,
+                uid: this.completed.uid,
+            },
+        ], callback);
+        return { tx, uids };
+    }
+    static from(attestations, network) {
+        return attestations.map((attestation) => {
+            const projectMilestone = new ProjectMilestone({
+                ...attestation,
+                data: {
+                    ...attestation.data,
+                },
+                schema: new AllGapSchemas_1.AllGapSchemas().findSchema("ProjectMilestone", consts_1.chainIdToNetwork[attestation.chainID]),
+                chainID: attestation.chainID,
+            });
+            if (attestation.verified?.length > 0) {
+                projectMilestone.verified = attestation.verified.map((m) => new ProjectMilestoneStatus({
+                    ...m,
+                    data: {
+                        ...m.data,
+                        type: m.data.type === "completed"
+                            ? "project-milestone-completed"
+                            : "project-milestone-verified",
+                    },
+                    schema: new AllGapSchemas_1.AllGapSchemas().findSchema("ProjectMilestoneStatus", consts_1.chainIdToNetwork[attestation.chainID]),
+                    chainID: attestation.chainID,
+                }));
+            }
+            if (attestation.completed) {
+                projectMilestone.completed = new attestations_1.MilestoneCompleted({
+                    ...attestation.completed,
+                    data: {
+                        ...attestation.completed.data,
+                    },
+                    schema: new AllGapSchemas_1.AllGapSchemas().findSchema("MilestoneCompleted", consts_1.chainIdToNetwork[attestation.chainID]),
+                    chainID: attestation.chainID,
+                });
+            }
+            return projectMilestone;
+        });
+    }
+}
+exports.ProjectMilestone = ProjectMilestone;

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

@@ -9,12 +9,14 @@ export interface IProjectUpdate {
 }
 type IStatus = "verified";
 export interface IProjectUpdateStatus {
-    type: `project-update-${IStatus}`;
+    type?: `project-update-${IStatus}`;
     reason?: string;
+    proofOfWork?: string;
 }
 export declare class ProjectUpdateStatus extends Attestation<IProjectUpdateStatus> implements IProjectUpdateStatus {
     type: `project-update-${IStatus}`;
     reason?: string;
+    proofOfWork?: string;
 }
 export declare class ProjectUpdate extends Attestation<IProjectUpdate> implements IProjectUpdate {
     title: string;
@@ -30,7 +32,7 @@ export declare class ProjectUpdate extends Attestation<IProjectUpdate> implement
      * @param signer
      * @param reason
      */
-    verify(signer: SignerOrProvider, reason?: string, callback?: Function): Promise<void>;
+    verify(signer: SignerOrProvider, data?: IProjectUpdateStatus, callback?: Function): Promise<void>;
     static from(attestations: _IProjectUpdate[], network: TNetwork): ProjectUpdate[];
 }
 export {};

package/core/class/entities/ProjectUpdate.js

@@ -37,10 +37,18 @@ class ProjectUpdate extends Attestation_1.Attestation {
             if (callback)
                 callback("confirmed");
             console.log(uid);
+            return {
+                tx: [
+                    {
+                        hash: tx.tx.hash,
+                    },
+                ],
+                uids: [uid],
+            };
         }
         catch (error) {
             console.error(error);
-            throw new SchemaError_1.AttestationError("ATTEST_ERROR", error.message);
+            throw new SchemaError_1.AttestationError("ATTEST_ERROR", error.message, error);
         }
     }
     /**
@@ -49,18 +57,26 @@ class ProjectUpdate extends Attestation_1.Attestation {
      * @param signer
      * @param reason
      */
-    async verify(signer, reason = "", callback) {
+    async verify(signer, data, callback) {
         console.log("Verifying");
         const schema = this.schema.gap.findSchema("ProjectUpdateStatus");
-        schema.setValue("type", "project-update-verified");
-        schema.setValue("reason", reason);
+        if (this.schema.isJsonSchema()) {
+            schema.setValue("json", JSON.stringify({
+                type: "verified",
+                reason: data?.reason || "",
+            }));
+        }
+        else {
+            schema.setValue("type", "project-update-verified");
+            schema.setValue("reason", data?.reason || "");
+        }
         console.log("Before attest project update verified");
         await this.attestStatus(signer, schema, callback);
         console.log("After attest project update verified");
         this.verified.push(new ProjectUpdateStatus({
             data: {
                 type: "project-update-verified",
-                reason,
+                reason: data?.reason || "",
             },
             refUID: this.uid,
             schema: schema,

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

@@ -1,10 +1,11 @@
-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';
-import { ICommunityAdminsResponse } from './api/types';
+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";
+import { ICommunityAdminsResponse } from "./api/types";
+import { ProjectMilestone } from "../entities/ProjectMilestone";
 export declare class GapIndexerClient extends Fetcher {
     private apiClient;
     constructor(params: any);
@@ -29,6 +30,7 @@ export declare class GapIndexerClient extends Fetcher {
     searchProjects(query: string): Promise<Project[]>;
     projects(name?: string): Promise<Project[]>;
     projectsOf(grantee: `0x${string}`): Promise<Project[]>;
+    projectMilestones(uidOrSlug: string): Promise<ProjectMilestone[]>;
     grantee(address: `0x${string}`): Promise<Grantee>;
     grantees(): Promise<Grantee[]>;
     grantsOf(grantee: `0x${string}`, withCommunity?: boolean): Promise<Grant[]>;

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

@@ -5,31 +5,32 @@ const Attestation_1 = require("../Attestation");
 const Fetcher_1 = require("../Fetcher");
 const entities_1 = require("../entities");
 const GapIndexerApi_1 = require("./api/GapIndexerApi");
+const ProjectMilestone_1 = require("../entities/ProjectMilestone");
 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' : ''}`,
-        communitiesAdmin: (address, withGrants) => `/grantees/${address}/communities/admin${withGrants ? '?withGrants=true' : ''}`,
+        communities: (address, withGrants) => `/grantees/${address}/communities${withGrants ? "?withGrants=true" : ""}`,
+        communitiesAdmin: (address, withGrants) => `/grantees/${address}/communities/admin${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`,
@@ -43,7 +44,7 @@ class GapIndexerClient extends Fetcher_1.Fetcher {
     async attestation(uid) {
         const { data } = await this.apiClient.attestation(uid);
         if (!data)
-            throw new Error('Attestation not found');
+            throw new Error("Attestation not found");
         return Attestation_1.Attestation.fromInterface([data], this.gap.network)[0];
     }
     async attestations(schemaName, search) {
@@ -76,7 +77,7 @@ class GapIndexerClient extends Fetcher_1.Fetcher {
         return entities_1.Community.from(data, this.gap.network);
     }
     communitiesByIds(uids) {
-        throw new Error('Method not implemented.');
+        throw new Error("Method not implemented.");
     }
     async communityBySlug(slug) {
         const { data } = await this.apiClient.communityBySlug(slug);
@@ -112,6 +113,10 @@ class GapIndexerClient extends Fetcher_1.Fetcher {
         const { data } = await this.apiClient.projectsOf(grantee);
         return entities_1.Project.from(data, this.gap.network);
     }
+    async projectMilestones(uidOrSlug) {
+        const { data } = await this.apiClient.projectMilestones(uidOrSlug);
+        return ProjectMilestone_1.ProjectMilestone.from(data, this.gap.network);
+    }
     async grantee(address) {
         const { data } = await this.apiClient.grantee(address);
         return data;
@@ -141,7 +146,7 @@ class GapIndexerClient extends Fetcher_1.Fetcher {
         return entities_1.Milestone.from(data, this.gap.network);
     }
     async membersOf(projects) {
-        throw new Error('Method not implemented.');
+        throw new Error("Method not implemented.");
     }
     async slugExists(slug) {
         return await this.apiClient.slugExists(slug);

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 } from "./types";
+import { Hex, IAttestationResponse, ICommunityResponse, ICommunityAdminsResponse, IGrantResponse, IProjectResponse, ISearchResponse, IProjectMilestoneResponse } from "./types";
 export declare class GapIndexerApi extends AxiosGQL {
     constructor(url: string);
     attestation(uid: Hex): Promise<import("axios").AxiosResponse<IAttestationResponse, any>>;
@@ -21,6 +21,7 @@ export declare class GapIndexerApi extends AxiosGQL {
     searchProjects(query: string): Promise<import("axios").AxiosResponse<IProjectResponse[], any>>;
     projects(name?: string): Promise<import("axios").AxiosResponse<IProjectResponse[], any>>;
     projectsOf(grantee: Hex): Promise<import("axios").AxiosResponse<IProjectResponse[], any>>;
+    projectMilestones(uidOrSlug: string): Promise<import("axios").AxiosResponse<IProjectMilestoneResponse[], any>>;
     /**
      * Grantee
      */
@@ -37,6 +38,7 @@ export declare class GapIndexerApi extends AxiosGQL {
     grantsOf(grantee: Hex, withCommunity?: boolean): Promise<import("axios").AxiosResponse<IGrantResponse[], any>>;
     grantsFor(uid: string, withCommunity?: boolean): Promise<import("axios").AxiosResponse<IGrantResponse[], any>>;
     grantsForExtProject(projectExtId: string): Promise<import("axios").AxiosResponse<IGrantResponse[], any>>;
+    grantBySlug(slug: Hex): Promise<import("axios").AxiosResponse<IGrantResponse, any>>;
     grantsByCommunity(uid: Hex): Promise<import("axios").AxiosResponse<IGrantResponse[], any>>;
     /**
      * Milestone

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

@@ -31,6 +31,7 @@ const Endpoints = {
         byUidOrSlug: (uidOrSlug) => `/projects/${uidOrSlug}`,
         grants: (uidOrSlug) => `/projects/${uidOrSlug}/grants`,
         milestones: (uidOrSlug) => `/projects/${uidOrSlug}/milestones`,
+        projectMilestones: (uidOrSlug) => `/projects/${uidOrSlug}/project-milestones`,
     },
     search: {
         all: () => "/search",
@@ -124,6 +125,10 @@ class GapIndexerApi extends AxiosGQL_1.AxiosGQL {
         const response = await this.client.get(Endpoints.grantees.projects(grantee));
         return response;
     }
+    async projectMilestones(uidOrSlug) {
+        const response = await this.client.get(Endpoints.project.projectMilestones(uidOrSlug));
+        return response;
+    }
     /**
      * Grantee
      */
@@ -151,6 +156,10 @@ class GapIndexerApi extends AxiosGQL_1.AxiosGQL {
         const response = await this.client.get(Endpoints.grants.byExternalId(projectExtId));
         return response;
     }
+    async grantBySlug(slug) {
+        const response = await this.client.get(Endpoints.grants.byUid(slug));
+        return response;
+    }
     async grantsByCommunity(uid) {
         const response = await this.client.get(Endpoints.communities.grants(uid));
         return response;

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

@@ -36,6 +36,7 @@ export interface IMilestoneCompleted extends IAttestationResponse {
     data: {
         type: "approved" | "rejected" | "completed";
         reason?: string;
+        proofOfWork?: string;
     };
 }
 export interface IMilestoneResponse extends IAttestationResponse {
@@ -65,6 +66,7 @@ export interface IGrantUpdate extends IAttestationResponse {
         text: string;
         title: string;
         type: "grant-update";
+        proofOfWork?: string;
     };
     verified?: IGrantUpdateStatus[];
 }
@@ -84,6 +86,23 @@ export interface IProjectUpdate extends IAttestationResponse {
     };
     verified?: IProjectUpdateStatus[];
 }
+export interface IProjectMilestoneStatus extends IAttestationResponse {
+    type: `project-milestone-verified`;
+    reason?: string;
+    data: {
+        type: "approved" | "rejected" | "completed";
+        reason?: string;
+    };
+}
+export interface IProjectMilestoneResponse extends IAttestationResponse {
+    data: {
+        text: string;
+        title: string;
+        type: "project-milestone";
+    };
+    verified?: IProjectMilestoneStatus[];
+    completed?: IMilestoneCompleted;
+}
 export interface IProjectPointer extends IAttestationResponse {
     data: {
         ogProjectUID: string;
@@ -105,6 +124,7 @@ export interface IGrantDetails extends IAttestationResponse {
             explanation: string;
         }[];
         startDate: number;
+        programId?: string;
         type: "grant-details";
     };
 }
@@ -191,6 +211,7 @@ export interface IProjectResponse extends IAttestationResponse {
     pointers: IProjectPointer[];
     symlinks: Hex[];
     endorsements: IProjectEndorsement[];
+    milestones: IProjectMilestoneResponse[];
 }
 export interface ICommunityDetails extends IAttestationResponse {
     type: "CommunityDetails";

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

@@ -3,7 +3,12 @@ import { Hex } from "core/types";
 import { Project } from "../entities/Project";
 import { GapSchema } from "../GapSchema";
 import { GrantUpdate } from "../entities/GrantUpdate";
+import { Transaction } from "ethers";
 /** Attestation interfaces */
+export type AttestationWithTx = {
+    uids: Hex[];
+    tx: Transaction[];
+};
 export type ExternalLink = {
     type: string;
     url: string;
@@ -38,10 +43,12 @@ export interface IGrantDetails {
     questions?: IGrantDetailsQuestion[];
     type?: string;
     startDate?: number;
+    programId?: string;
 }
 export declare class GrantDetails extends Attestation<IGrantDetails> implements IGrantDetails {
     title: string;
     proposalURL: string;
+    programId?: string;
     payoutAddress?: Hex;
     amount?: string;
     assetAndChainId?: [Hex, number];
@@ -73,12 +80,14 @@ export declare class MemberDetails extends Attestation<IMemberDetails> implement
     profilePictureURL: string;
 }
 export interface IMilestoneCompleted {
-    type: "approved" | "rejected" | "completed" | "verified";
+    type?: "approved" | "rejected" | "completed" | "verified";
     reason?: string;
+    proofOfWork?: string;
 }
 export declare class MilestoneCompleted extends Attestation<IMilestoneCompleted> implements IMilestoneCompleted {
     type: "approved" | "rejected" | "completed" | "verified";
     reason?: string;
+    proofOfWork?: string;
 }
 export interface ITag {
     name: string;
@@ -143,3 +152,13 @@ export declare class ProjectEndorsement extends Attestation<IProjectEndorsement>
     type?: string;
     constructor(data: AttestationArgs<IProjectEndorsement, GapSchema>);
 }
+export interface IProjectMilestoneCompleted {
+    type?: "approved" | "rejected" | "completed" | "verified";
+    reason?: string;
+    proofOfWork?: string;
+}
+export declare class ProjectMilestoneCompleted extends Attestation<IProjectMilestoneCompleted> implements IProjectMilestoneCompleted {
+    type: "approved" | "rejected" | "completed" | "verified";
+    reason?: string;
+    proofOfWork?: string;
+}

package/core/class/types/attestations.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProjectEndorsement = exports.GrantCompleted = exports.Grantee = exports.ProjectDetails = exports.Tag = exports.MilestoneCompleted = exports.MemberDetails = exports.GrantVerified = exports.GrantRound = exports.GrantDetails = exports.CommunityDetails = void 0;
+exports.ProjectMilestoneCompleted = exports.ProjectEndorsement = exports.GrantCompleted = exports.Grantee = exports.ProjectDetails = exports.Tag = exports.MilestoneCompleted = exports.MemberDetails = exports.GrantVerified = exports.GrantRound = exports.GrantDetails = exports.CommunityDetails = void 0;
 const Attestation_1 = require("../Attestation");
 const GrantUpdate_1 = require("../entities/GrantUpdate");
 class CommunityDetails extends Attestation_1.Attestation {
@@ -61,3 +61,6 @@ class ProjectEndorsement extends Attestation_1.Attestation {
     }
 }
 exports.ProjectEndorsement = ProjectEndorsement;
+class ProjectMilestoneCompleted extends Attestation_1.Attestation {
+}
+exports.ProjectMilestoneCompleted = ProjectMilestoneCompleted;