@show-karma/karma-gap-sdk 0.3.44 → 0.3.46

package/core/abi/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.abis = void 0;
+const AirdropNFT_json_1 = __importDefault(require("./AirdropNFT.json"));
+const Allo_json_1 = __importDefault(require("./Allo.json"));
+const AlloRegistry_json_1 = __importDefault(require("./AlloRegistry.json"));
+const CommunityResolverABI_json_1 = __importDefault(require("./CommunityResolverABI.json"));
+const Donations_json_1 = __importDefault(require("./Donations.json"));
+const EAS_json_1 = __importDefault(require("./EAS.json"));
+const MultiAttester_json_1 = __importDefault(require("./MultiAttester.json"));
+const ProjectResolver_json_1 = __importDefault(require("./ProjectResolver.json"));
+const SchemaRegistry_json_1 = __importDefault(require("./SchemaRegistry.json"));
+exports.abis = {
+    AirdropNFT: AirdropNFT_json_1.default,
+    Allo: Allo_json_1.default,
+    AlloRegistry: AlloRegistry_json_1.default,
+    CommunityResolverABI: CommunityResolverABI_json_1.default,
+    Donations: Donations_json_1.default,
+    EAS: EAS_json_1.default,
+    MultiAttester: MultiAttester_json_1.default,
+    ProjectResolver: ProjectResolver_json_1.default,
+    SchemaRegistry: SchemaRegistry_json_1.default,
+};

package/core/class/GAP.js

@@ -81,18 +81,23 @@ class GAP extends types_1.Facade {
         this.generateSlug = async (text) => {
             let slug = text
                 .toLowerCase()
+                // Remove emojis
+                .replace(/([\uE000-\uF8FF]|\uD83C[\uDF00-\uDFFF]|\uD83D[\uDC00-\uDDFF])/g, '')
+                // Remove basic text emoticons
+                .replace(/[:;=][()DP]/g, '')
                 .replace(/ /g, "-")
-                .replace(/[^\w-]+/g, "");
-            const slugExists = await this.fetch.slugExists(slug);
-            if (slugExists) {
-                const parts = slug.split("-");
-                const counter = parts.pop();
-                slug = /\d+/g.test(counter) ? parts.join("-") : slug;
-                // eslint-disable-next-line no-param-reassign
-                const nextSlug = `${slug}-${counter && /\d+/g.test(counter) ? +counter + 1 : 1}`;
-                return this.generateSlug(nextSlug);
-            }
-            return slug.toLowerCase();
+                .replace(/[^\w-]+/g, "")
+                .trim()
+                .replace(/^-+|-+$/g, ''); // Remove leading and trailing hyphens
+            const checkSlug = async (currentSlug, counter = 0) => {
+                const slugToCheck = counter === 0 ? currentSlug : `${currentSlug}-${counter}`;
+                const slugExists = await this.fetch.slugExists(slugToCheck);
+                if (slugExists) {
+                    return checkSlug(currentSlug, counter + 1);
+                }
+                return slugToCheck.toLowerCase();
+            };
+            return checkSlug(slug);
         };
         const schemas = args.schemas || Object.values((0, consts_1.MountEntities)(consts_1.Networks[args.network]));
         this.network = args.network;

package/core/class/Schema.js

@@ -345,9 +345,8 @@ class Schema {
             gasLimit: 5000000n,
         });
         callback?.("pending");
-        tx.wait().then(() => {
-            callback?.("confirmed");
-        });
+        await tx.wait();
+        callback?.("confirmed");
         return {
             tx: [{ hash: tx.tx.hash }],
             uids: payload.map((p) => p.data.map((d) => d.uid)).flat(),

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

@@ -0,0 +1,39 @@
+import { Attestation, AttestationArgs } from "../Attestation";
+import { AttestationWithTx } from "../types/attestations";
+import { GapSchema } from "../GapSchema";
+import { MultiAttestPayload, SignerOrProvider, TNetwork } from "core/types";
+export interface IContributorProfile {
+    name: string;
+    aboutMe?: string;
+    github?: string;
+    twitter?: string;
+    linkdin?: number;
+}
+export declare class ContributorProfile extends Attestation<IContributorProfile> implements IContributorProfile {
+    name: string;
+    aboutMe?: string;
+    github?: string;
+    twitter?: string;
+    linkdin?: number;
+    constructor(data: AttestationArgs<IContributorProfile, GapSchema>);
+    /**
+     * Creates the payload for a multi-attestation.
+     *
+     * > if Current payload is set, it'll be used as the base payload
+     * and the project should refer to an index of the current payload,
+     * usually the community position.
+     *
+     * @param payload
+     * @param refIdx
+     */
+    multiAttestPayload(): Promise<MultiAttestPayload>;
+    /**
+     * Attest a community with its details.
+     *
+     * If the community exists, it will not be revoked but its details will be updated.
+     * @param signer
+     * @param details
+     */
+    attest(signer: SignerOrProvider, callback?: Function): Promise<AttestationWithTx>;
+    static from(attestation: ContributorProfile, network: TNetwork): ContributorProfile;
+}

package/core/class/entities/ContributorProfile.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContributorProfile = void 0;
+const Attestation_1 = require("../Attestation");
+const consts_1 = require("../../consts");
+const SchemaError_1 = require("../SchemaError");
+const AllGapSchemas_1 = require("../AllGapSchemas");
+class ContributorProfile extends Attestation_1.Attestation {
+    constructor(data) {
+        data.data.type = "contributor-profile";
+        super(data);
+    }
+    /**
+     * Creates the payload for a multi-attestation.
+     *
+     * > if Current payload is set, it'll be used as the base payload
+     * and the project should refer to an index of the current payload,
+     * usually the community position.
+     *
+     * @param payload
+     * @param refIdx
+     */
+    async multiAttestPayload() {
+        const payload = [[this, await this.payloadFor(0)]];
+        return payload;
+    }
+    /**
+     * Attest a community with its details.
+     *
+     * If the community exists, it will not be revoked but its details will be updated.
+     * @param signer
+     * @param details
+     */
+    async attest(signer, callback) {
+        console.log("Attesting ContributorProfile");
+        try {
+            if (callback)
+                callback("preparing");
+            const { tx: ContributorProfileTx, uids: ContributorProfileUID } = await this.schema.attest({
+                signer,
+                to: this.recipient,
+                refUID: consts_1.nullRef,
+                data: this.data,
+            });
+            this._uid = ContributorProfileUID[0];
+            console.log(this.uid);
+            if (callback)
+                callback("pending");
+            if (callback)
+                callback("confirmed");
+            return { tx: ContributorProfileTx, uids: ContributorProfileUID };
+        }
+        catch (error) {
+            console.error(error);
+            throw new SchemaError_1.AttestationError("ATTEST_ERROR", "Error during attestation.", error);
+        }
+    }
+    static from(attestation, network) {
+        return new ContributorProfile({
+            ...attestation,
+            data: {
+                ...attestation.data,
+            },
+            schema: new AllGapSchemas_1.AllGapSchemas().findSchema("ContributorProfile", consts_1.chainIdToNetwork[attestation.chainID]),
+            chainID: attestation.chainID,
+        });
+    }
+}
+exports.ContributorProfile = ContributorProfile;

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

@@ -50,10 +50,10 @@ export declare class Grant extends Attestation<IGrant> {
      */
     attest(signer: SignerOrProvider, projectChainId: number, callback?: Function): Promise<AttestationWithTx>;
     attestUpdate(signer: SignerOrProvider, data: IGrantUpdate, callback?: Function): Promise<void>;
-    complete(signer: SignerOrProvider, data: IGrantUpdate, callback?: Function): Promise<AttestationWithTx>;
     /**
      * Validate if the grant has a valid reference to a community.
      */
     protected assertPayload(): boolean;
+    complete(signer: SignerOrProvider, data: IGrantUpdate, callback?: Function): Promise<AttestationWithTx>;
     static from(attestations: IGrantResponse[], network: TNetwork): Grant[];
 }

package/core/class/entities/Grant.js

@@ -139,6 +139,15 @@ class Grant extends Attestation_1.Attestation {
         await grantUpdate.attest(signer, callback);
         this.updates.push(grantUpdate);
     }
+    /**
+     * Validate if the grant has a valid reference to a community.
+     */
+    assertPayload() {
+        if (!this.details || !this.communityUID) {
+            throw new SchemaError_1.AttestationError("INVALID_REFERENCE", "Grant should include a valid reference to a community on its details.");
+        }
+        return true;
+    }
     async complete(signer, data, callback) {
         const completed = new attestations_1.GrantCompleted({
             data: {
@@ -153,15 +162,6 @@ class Grant extends Attestation_1.Attestation {
         this.completed = completed;
         return { tx, uids };
     }
-    /**
-     * Validate if the grant has a valid reference to a community.
-     */
-    assertPayload() {
-        if (!this.details || !this.communityUID) {
-            throw new SchemaError_1.AttestationError("INVALID_REFERENCE", "Grant should include a valid reference to a community on its details.");
-        }
-        return true;
-    }
     static from(attestations, network) {
         return attestations.map((attestation) => {
             const grant = new Grant({

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

@@ -7,21 +7,21 @@ export interface IGrantUpdate {
     title: string;
     text: string;
     type?: string;
+    proofOfWork?: string;
 }
 type IStatus = "verified";
 export interface IGrantUpdateStatus {
     type?: `grant-update-${IStatus}`;
     reason?: string;
-    linkToProof?: string;
 }
 export declare class GrantUpdateStatus extends Attestation<IGrantUpdateStatus> implements IGrantUpdateStatus {
     type: `grant-update-${IStatus}`;
     reason?: string;
-    linkToProof?: string;
 }
 export declare class GrantUpdate extends Attestation<IGrantUpdate> implements IGrantUpdate {
     title: string;
     text: string;
+    proofOfWork: string;
     verified: GrantUpdateStatus[];
     /**
      * Attest the status of the milestone as approved, rejected or completed.

package/core/class/entities/GrantUpdate.js

@@ -63,14 +63,12 @@ class GrantUpdate extends Attestation_1.Attestation {
         if (this.schema.isJsonSchema()) {
             schema.setValue("json", JSON.stringify({
                 type: "grant-update-verified",
-                reason: data?.reason || "",
-                linkToProof: data?.linkToProof || "",
+                ...data,
             }));
         }
         else {
             schema.setValue("type", "grant-update-verified");
             schema.setValue("reason", data?.reason || "");
-            schema.setValue("linkToProof", data?.linkToProof || "");
         }
         console.log("Before attest grant update verified");
         const { tx, uids } = await this.attestStatus(signer, schema, callback);
@@ -78,8 +76,7 @@ class GrantUpdate extends Attestation_1.Attestation {
         this.verified.push(new GrantUpdateStatus({
             data: {
                 type: "grant-update-verified",
-                reason: data?.reason || "",
-                linkToProof: data?.linkToProof || "",
+                ...data,
             },
             refUID: this.uid,
             schema: schema,

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

@@ -10,6 +10,7 @@ export interface IMilestone {
     endsAt: number;
     description: string;
     type?: string;
+    priority?: number;
 }
 export declare class Milestone extends Attestation<IMilestone> implements IMilestone {
     title: string;
@@ -21,6 +22,7 @@ export declare class Milestone extends Attestation<IMilestone> implements IMiles
     rejected: MilestoneCompleted;
     verified: MilestoneCompleted[];
     type: string;
+    priority?: number;
     /**
      * Approves this milestone. If the milestone is not completed or already approved,
      * it will throw an error.

package/core/class/entities/Milestone.js

@@ -26,12 +26,13 @@ class Milestone extends Attestation_1.Attestation {
         if (this.schema.isJsonSchema()) {
             schema.setValue("json", JSON.stringify({
                 type: "approved",
-                reason: data?.reason || "",
+                ...data,
             }));
         }
         else {
             schema.setValue("type", "approved");
             schema.setValue("reason", data?.reason || "");
+            schema.setValue("proofOfWork", data?.proofOfWork || "");
         }
         await this.attestStatus(signer, schema, callback);
         this.approved = new attestations_1.MilestoneCompleted({
@@ -109,18 +110,19 @@ class Milestone extends Attestation_1.Attestation {
         if (this.schema.isJsonSchema()) {
             schema.setValue("json", JSON.stringify({
                 type: "completed",
-                reason: data?.reason || "",
+                ...data,
             }));
         }
         else {
             schema.setValue("type", "completed");
             schema.setValue("reason", data?.reason || "");
+            schema.setValue("proofOfWork", data?.proofOfWork || "");
         }
         const { tx, uids } = await this.attestStatus(signer, schema, callback);
         this.completed = new attestations_1.MilestoneCompleted({
             data: {
                 type: "completed",
-                reason: data?.reason || "",
+                ...data,
             },
             refUID: this.uid,
             schema,
@@ -294,12 +296,13 @@ class Milestone extends Attestation_1.Attestation {
         if (this.schema.isJsonSchema()) {
             schema.setValue("json", JSON.stringify({
                 type: "verified",
-                reason: data?.reason || "",
+                ...data,
             }));
         }
         else {
             schema.setValue("type", "verified");
             schema.setValue("reason", data?.reason || "");
+            schema.setValue("proofOfWork", data?.proofOfWork || "");
         }
         console.log("Before attestStatus");
         const { tx, uids } = await this.attestStatus(signer, schema, callback);
@@ -307,7 +310,7 @@ class Milestone extends Attestation_1.Attestation {
         this.verified.push(new attestations_1.MilestoneCompleted({
             data: {
                 type: "verified",
-                reason: data?.reason || "",
+                ...data,
             },
             refUID: this.uid,
             schema: schema,

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

@@ -4,9 +4,10 @@ import { Hex, MultiAttestPayload, SignerOrProvider, TNetwork } from "core/types"
 import { Grant } from "./Grant";
 import { MemberOf } from "./MemberOf";
 import { IProjectResponse } from "../karma-indexer/api/types";
-import { ProjectImpact } from "./ProjectImpact";
+import { IProjectImpact, ProjectImpact } from "./ProjectImpact";
 import { ProjectUpdate } from "./ProjectUpdate";
 import { ProjectPointer } from "./ProjectPointer";
+import { ProjectMilestone } from "./ProjectMilestone";
 export interface IProject {
     project: true;
 }
@@ -19,6 +20,7 @@ export declare class Project extends Attestation<IProject> {
     endorsements: ProjectEndorsement[];
     updates: ProjectUpdate[];
     pointers: ProjectPointer[];
+    milestones: ProjectMilestone[];
     /**
      * Creates the payload for a multi-attestation.
      *
@@ -78,7 +80,10 @@ export declare class Project extends Attestation<IProject> {
     removeAllMembers(signer: SignerOrProvider): Promise<void>;
     static from(attestations: IProjectResponse[], network: TNetwork): Project[];
     attestUpdate(signer: SignerOrProvider, data: ProjectUpdate, callback?: Function): Promise<void>;
+    attestMilestone(signer: SignerOrProvider, data: ProjectUpdate, callback?: Function): Promise<void>;
     attestPointer(signer: SignerOrProvider, data: ProjectPointer, callback?: Function): Promise<void>;
-    attestImpact(signer: SignerOrProvider, data: ProjectImpact): Promise<void>;
+    attestImpact(signer: SignerOrProvider, data: IProjectImpact, targetChainId?: number, callback?: Function): Promise<AttestationWithTx>;
+    private attestGhostProjectImpact;
     attestEndorsement(signer: SignerOrProvider, data?: ProjectEndorsement): Promise<void>;
+    attestGhostProject(signer: SignerOrProvider, targetChainId: number): Promise<AttestationWithTx>;
 }

package/core/class/entities/Project.js

@@ -13,6 +13,7 @@ const AllGapSchemas_1 = require("../AllGapSchemas");
 const ProjectImpact_1 = require("./ProjectImpact");
 const ProjectUpdate_1 = require("./ProjectUpdate");
 const ProjectPointer_1 = require("./ProjectPointer");
+const ProjectMilestone_1 = require("./ProjectMilestone");
 class Project extends Attestation_1.Attestation {
     constructor() {
         super(...arguments);
@@ -22,6 +23,7 @@ class Project extends Attestation_1.Attestation {
         this.endorsements = [];
         this.updates = [];
         this.pointers = [];
+        this.milestones = [];
     }
     /**
      * Creates the payload for a multi-attestation.
@@ -265,6 +267,9 @@ class Project extends Attestation_1.Attestation {
             if (attestation.updates) {
                 project.updates = ProjectUpdate_1.ProjectUpdate.from(attestation.updates, network);
             }
+            if (attestation.milestones) {
+                project.milestones = ProjectMilestone_1.ProjectMilestone.from(attestation.milestones, network);
+            }
             if (attestation.endorsements) {
                 project.endorsements = attestation.endorsements.map((pi) => {
                     const endorsement = new attestations_1.ProjectEndorsement({
@@ -294,6 +299,19 @@ class Project extends Attestation_1.Attestation {
         await projectUpdate.attest(signer, callback);
         this.updates.push(projectUpdate);
     }
+    async attestMilestone(signer, data, callback) {
+        const projectMilestone = new ProjectMilestone_1.ProjectMilestone({
+            data: {
+                ...data,
+                type: "project-milestone",
+            },
+            recipient: this.recipient,
+            refUID: this.uid,
+            schema: this.schema.gap.findSchema("ProjectMilestone"),
+        });
+        await projectMilestone.attest(signer, callback);
+        this.milestones.push(projectMilestone);
+    }
     async attestPointer(signer, data, callback) {
         const projectPointer = new ProjectPointer_1.ProjectPointer({
             data: {
@@ -307,7 +325,10 @@ class Project extends Attestation_1.Attestation {
         await projectPointer.attest(signer, callback);
         this.pointers.push(projectPointer);
     }
-    async attestImpact(signer, data) {
+    async attestImpact(signer, data, targetChainId, callback) {
+        if (targetChainId && targetChainId !== this.chainID) {
+            return this.attestGhostProjectImpact(signer, data, targetChainId, callback);
+        }
         const projectImpact = new ProjectImpact_1.ProjectImpact({
             data: {
                 ...data,
@@ -317,8 +338,30 @@ class Project extends Attestation_1.Attestation {
             refUID: this.uid,
             schema: this.schema.gap.findSchema("ProjectDetails"),
         });
-        await projectImpact.attest(signer);
+        const { tx, uids } = await projectImpact.attest(signer, callback);
+        this.impacts.push(projectImpact);
+        return { tx, uids };
+    }
+    async attestGhostProjectImpact(signer, data, targetChainId, callback) {
+        const { tx, uids } = await this.attestGhostProject(signer, targetChainId);
+        const ghostProjectUid = uids[0];
+        const allGapSchemas = new AllGapSchemas_1.AllGapSchemas();
+        const projectImpact = new ProjectImpact_1.ProjectImpact({
+            data: {
+                ...data,
+                type: "project-impact",
+            },
+            recipient: this.recipient,
+            refUID: ghostProjectUid,
+            schema: allGapSchemas.findSchema("ProjectDetails", consts_1.chainIdToNetwork[targetChainId]),
+            chainID: targetChainId,
+        });
+        const impactAttestation = await projectImpact.attest(signer, callback);
         this.impacts.push(projectImpact);
+        return {
+            tx: impactAttestation.tx,
+            uids: [...uids, impactAttestation.uids[0]],
+        };
     }
     async attestEndorsement(signer, data) {
         const projectEndorsement = new attestations_1.ProjectEndorsement({
@@ -333,5 +376,25 @@ class Project extends Attestation_1.Attestation {
         await projectEndorsement.attest(signer);
         this.endorsements.push(projectEndorsement);
     }
+    async attestGhostProject(signer, targetChainId) {
+        const allGapSchemas = new AllGapSchemas_1.AllGapSchemas();
+        const project = new Project({
+            data: { project: true },
+            schema: allGapSchemas.findSchema("Project", consts_1.chainIdToNetwork[targetChainId]),
+            recipient: this.recipient,
+            chainID: targetChainId,
+        });
+        project.details = new Attestation_1.Attestation({
+            data: {
+                originalProjectChainId: this.chainID,
+                uid: this.uid,
+            },
+            chainID: targetChainId,
+            recipient: this.recipient,
+            schema: allGapSchemas.findSchema("ProjectDetails", consts_1.chainIdToNetwork[targetChainId]),
+        });
+        const attestation = await project.attest(signer);
+        return attestation;
+    }
 }
 exports.Project = Project;

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

@@ -20,7 +20,7 @@ export interface IProjectImpact {
     startedAt?: number;
     completedAt: number;
     type?: string;
-    verified: ProjectImpactStatus[];
+    verified?: ProjectImpactStatus[];
 }
 export declare class ProjectImpact extends Attestation<IProjectImpact> implements IProjectImpact {
     work: string;

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

@@ -0,0 +1,60 @@
+import { SignerOrProvider, TNetwork } from "../../../core/types";
+import { Attestation, AttestationArgs } from "../Attestation";
+import { GapSchema } from "../GapSchema";
+import { Transaction } from "ethers";
+import { IProjectMilestoneResponse } from "../karma-indexer/api/types";
+import { MilestoneCompleted as ProjectMilestoneCompleted } from "../types/attestations";
+export interface IProjectMilestone {
+    title: string;
+    text: string;
+    type?: string;
+}
+type IStatus = "verified" | "completed";
+export interface IProjectMilestoneStatus {
+    type?: `project-milestone-${IStatus}`;
+    proofOfWork?: string;
+    reason?: string;
+}
+export declare class ProjectMilestoneStatus extends Attestation<IProjectMilestoneStatus> implements IProjectMilestoneStatus {
+    type: `project-milestone-${IStatus}`;
+    reason?: string;
+}
+export declare class ProjectMilestone extends Attestation<IProjectMilestone> implements IProjectMilestone {
+    title: string;
+    text: string;
+    verified: ProjectMilestoneStatus[];
+    completed: ProjectMilestoneCompleted;
+    constructor(data: AttestationArgs<IProjectMilestone, GapSchema>);
+    /**
+     * Attest the status of the update as approved, rejected or completed.
+     */
+    private attestStatus;
+    /**
+     * Verify this ProjectUpdate. If the ProjectUpdate is not already verified,
+     * it will throw an error.
+     * @param signer
+     * @param reason
+     */
+    verify(signer: SignerOrProvider, data?: IProjectMilestoneStatus, callback?: Function): Promise<void>;
+    /**
+     * Marks a milestone as completed. If the milestone is already completed,
+     * it will throw an error.
+     * @param signer
+     * @param reason
+     */
+    complete(signer: SignerOrProvider, data?: IProjectMilestoneStatus, callback?: Function): Promise<{
+        tx: Transaction[];
+        uids: `0x${string}`[];
+    }>;
+    /**
+     * Revokes the completed status of the milestone. If the milestone is not completed,
+     * it will throw an error.
+     * @param signer
+     */
+    revokeCompletion(signer: SignerOrProvider, callback?: Function): Promise<{
+        tx: Transaction[];
+        uids: `0x${string}`[];
+    }>;
+    static from(attestations: IProjectMilestoneResponse[], network: TNetwork): ProjectMilestone[];
+}
+export {};