@show-karma/karma-gap-sdk 0.4.15 → 0.4.16

package/core/class/entities/Grant.js

@@ -1,223 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Grant = void 0;
-const Attestation_1 = require("../Attestation");
-const attestations_1 = require("../types/attestations");
-const Milestone_1 = require("./Milestone");
-const SchemaError_1 = require("../SchemaError");
-const consts_1 = require("../../consts");
-const GapContract_1 = require("../contract/GapContract");
-const Community_1 = require("./Community");
-const Project_1 = require("./Project");
-const AllGapSchemas_1 = require("../AllGapSchemas");
-const GrantUpdate_1 = require("./GrantUpdate");
-class Grant extends Attestation_1.Attestation {
-    constructor() {
-        super(...arguments);
-        this.verified = false;
-        this.milestones = [];
-        this.updates = [];
-        this.members = [];
-        this.categories = [];
-    }
-    async verify(signer) {
-        const eas = this.schema.gap.eas.connect(signer);
-        const schema = this.schema.gap.findSchema("MilestoneApproved");
-        schema.setValue("approved", true);
-        try {
-            await eas.attest({
-                schema: schema.raw,
-                data: {
-                    recipient: this.recipient,
-                    data: schema.encode(),
-                    refUID: this.uid,
-                    expirationTime: 0n,
-                    revocable: schema.revocable,
-                },
-            });
-            this.verified = true;
-        }
-        catch (error) {
-            console.error(error);
-            throw new SchemaError_1.AttestationError("ATTEST_ERROR", error.message, error);
-        }
-    }
-    /**
-     * Add milestones to the grant.
-     * @param signer
-     * @param milestones
-     */
-    addMilestones(milestones) {
-        const schema = this.schema.gap.findSchema("Milestone");
-        const newMilestones = milestones.map((milestone) => {
-            const m = new Milestone_1.Milestone({
-                data: milestone,
-                refUID: this.uid,
-                schema,
-                createdAt: Date.now(),
-                recipient: this.recipient,
-                uid: consts_1.nullRef,
-            });
-            return m;
-        });
-        this.milestones.push(...newMilestones);
-    }
-    /**
-     * 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 projectIdx
-     */
-    async multiAttestPayload(currentPayload = [], projectIdx = 0) {
-        this.assertPayload();
-        const payload = [...currentPayload];
-        const grantIdx = payload.push([this, await this.payloadFor(projectIdx)]) - 1;
-        if (this.details) {
-            payload.push([this.details, await this.details.payloadFor(grantIdx)]);
-        }
-        if (this.milestones.length) {
-            await Promise.all(this.milestones.map(async (m) => payload.push(...(await m.multiAttestPayload(payload, grantIdx)))));
-        }
-        if (this.updates.length) {
-            await Promise.all(this.updates.map(async (u) => payload.push([u, await u.payloadFor(grantIdx)])));
-        }
-        return payload.slice(currentPayload.length, payload.length);
-    }
-    async attestProject(signer, originalProjectChainId) {
-        const project = new Project_1.Project({
-            data: { project: true },
-            schema: this.schema.gap.findSchema("Project"),
-            recipient: this.recipient,
-            chainID: this.chainID,
-        });
-        project.details = new Attestation_1.Attestation({
-            data: {
-                originalProjectChainId,
-                uid: this.refUID,
-            },
-            chainID: this.chainID,
-            recipient: this.recipient,
-            schema: this.schema.gap.findSchema("ProjectDetails"),
-        });
-        // Overwrite refuid
-        Object.assign(this, { refUID: consts_1.nullRef });
-        project.grants = [this];
-        const attestation = await project.attest(signer);
-        return attestation;
-    }
-    /**
-     * @inheritdoc
-     */
-    async attest(signer, projectChainId, callback) {
-        if (projectChainId !== this.chainID) {
-            return this.attestProject(signer, projectChainId);
-        }
-        this.assertPayload();
-        const payload = await this.multiAttestPayload();
-        const { tx, uids } = await GapContract_1.GapContract.multiAttest(signer, payload.map((p) => p[1]), callback);
-        if (Array.isArray(uids)) {
-            uids.forEach((uid, index) => {
-                payload[index][0].uid = uid;
-            });
-        }
-        return { tx, uids };
-    }
-    async attestUpdate(signer, data, callback) {
-        const grantUpdate = new GrantUpdate_1.GrantUpdate({
-            data: {
-                ...data,
-                type: "grant-update",
-            },
-            recipient: this.recipient,
-            refUID: this.uid,
-            schema: this.schema.gap.findSchema("GrantDetails"),
-        });
-        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: {
-                ...data,
-                type: "grant-completed",
-            },
-            recipient: this.recipient,
-            refUID: this.uid,
-            schema: this.schema.gap.findSchema("GrantDetails"),
-        });
-        const { tx, uids } = await completed.attest(signer, callback);
-        this.completed = completed;
-        return { tx, uids };
-    }
-    static from(attestations, network) {
-        return attestations.map((attestation) => {
-            const grant = new Grant({
-                ...attestation,
-                data: {
-                    communityUID: attestation.data.communityUID,
-                },
-                schema: new AllGapSchemas_1.AllGapSchemas().findSchema("Grant", consts_1.chainIdToNetwork[attestation.chainID]),
-                chainID: attestation.chainID,
-            });
-            if (attestation.details) {
-                const { details } = attestation;
-                grant.details = new attestations_1.GrantDetails({
-                    ...details,
-                    data: {
-                        ...details.data,
-                    },
-                    schema: new AllGapSchemas_1.AllGapSchemas().findSchema("GrantDetails", consts_1.chainIdToNetwork[attestation.chainID]),
-                    chainID: attestation.chainID,
-                });
-            }
-            if (attestation.milestones) {
-                const { milestones } = attestation;
-                grant.milestones = Milestone_1.Milestone.from(milestones, network);
-            }
-            if (attestation.updates) {
-                const { updates } = attestation;
-                grant.updates = GrantUpdate_1.GrantUpdate.from(updates, network);
-            }
-            if (attestation.completed) {
-                const { completed } = attestation;
-                grant.completed = new attestations_1.GrantCompleted({
-                    ...completed,
-                    data: {
-                        ...completed.data,
-                    },
-                    schema: new AllGapSchemas_1.AllGapSchemas().findSchema("GrantDetails", consts_1.chainIdToNetwork[attestation.chainID]),
-                    chainID: attestation.chainID,
-                });
-            }
-            if (attestation.project) {
-                const { project } = attestation;
-                grant.project = project;
-            }
-            if (attestation.community) {
-                const { community } = attestation;
-                grant.community = Community_1.Community.from([community], network)[0];
-            }
-            if (attestation.members) {
-                grant.members = attestation.members;
-            }
-            if (attestation.categories) {
-                grant.categories = attestation.categories;
-            }
-            return grant;
-        });
-    }
-}
-exports.Grant = Grant;

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

@@ -1,40 +0,0 @@
-import { IGrantUpdateBase } from "core/shared/types";
-import { Transaction } from "ethers";
-import { SignerOrProvider, TNetwork } from "../../../core/types";
-import { Attestation } from "../Attestation";
-export interface _IGrantUpdate extends GrantUpdate {
-}
-export interface IGrantUpdate extends IGrantUpdateBase {
-    type?: string;
-}
-type IStatus = "verified";
-export interface IGrantUpdateStatus {
-    type?: `grant-update-${IStatus}`;
-    reason?: string;
-}
-export declare class GrantUpdateStatus extends Attestation<IGrantUpdateStatus> implements IGrantUpdateStatus {
-    type: `grant-update-${IStatus}`;
-    reason?: 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.
-     */
-    private attestStatus;
-    /**
-     * Verify this GrantUpdate. If the GrantUpdate is not already verified,
-     * it will throw an error.
-     * @param signer
-     * @param reason
-     */
-    verify(signer: SignerOrProvider, data?: IGrantUpdateStatus, callback?: Function): Promise<{
-        tx: Transaction[];
-        uids: `0x${string}`[];
-    }>;
-    static from(attestations: _IGrantUpdate[], network: TNetwork): GrantUpdate[];
-}
-export {};

package/core/class/entities/GrantUpdate.js

@@ -1,114 +0,0 @@
-"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");
-class GrantUpdateStatus extends Attestation_1.Attestation {
-}
-exports.GrantUpdateStatus = GrantUpdateStatus;
-class GrantUpdate extends Attestation_1.Attestation {
-    constructor() {
-        super(...arguments);
-        this.verified = [];
-    }
-    /**
-     * Attest the status of the milestone 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 GrantUpdate. If the GrantUpdate 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("GrantUpdateStatus");
-        if (this.schema.isJsonSchema()) {
-            schema.setValue("json", JSON.stringify({
-                type: "grant-update-verified",
-                ...data,
-            }));
-        }
-        else {
-            schema.setValue("type", "grant-update-verified");
-            schema.setValue("reason", data?.reason || "");
-        }
-        console.log("Before attest grant update verified");
-        const { tx, uids } = await this.attestStatus(signer, schema, callback);
-        console.log("After attest grant update verified");
-        this.verified.push(new GrantUpdateStatus({
-            data: {
-                type: "grant-update-verified",
-                ...data,
-            },
-            refUID: this.uid,
-            schema: schema,
-            recipient: this.recipient,
-        }));
-        return {
-            tx,
-            uids,
-        };
-    }
-    static from(attestations, network) {
-        return attestations.map((attestation) => {
-            const grantUpdate = new GrantUpdate({
-                ...attestation,
-                data: {
-                    ...attestation.data,
-                },
-                schema: new AllGapSchemas_1.AllGapSchemas().findSchema("GrantUpdate", consts_1.chainIdToNetwork[attestation.chainID]),
-                chainID: attestation.chainID,
-            });
-            if (attestation.verified?.length > 0) {
-                grantUpdate.verified = attestation.verified.map((m) => new GrantUpdateStatus({
-                    ...m,
-                    data: {
-                        ...m.data,
-                    },
-                    schema: new AllGapSchemas_1.AllGapSchemas().findSchema("GrantUpdateStatus", consts_1.chainIdToNetwork[attestation.chainID]),
-                    chainID: attestation.chainID,
-                }));
-            }
-            return grantUpdate;
-        });
-    }
-}
-exports.GrantUpdate = GrantUpdate;

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

@@ -1,11 +0,0 @@
-import { MultiAttestPayload, SignerOrProvider } from "core/types";
-import { Attestation } from "../Attestation";
-import { AttestationWithTx, MemberDetails } from "../types/attestations";
-export interface IMemberOf {
-    memberOf: true;
-}
-export declare class MemberOf extends Attestation<IMemberOf> {
-    details?: MemberDetails;
-    multiAttestPayload(currentPayload?: MultiAttestPayload, projectIdx?: number): Promise<[Attestation<unknown, import("..").GapSchema>, import("core/types").RawMultiAttestPayload][]>;
-    attest(signer: SignerOrProvider, callback?: Function): Promise<AttestationWithTx>;
-}

package/core/class/entities/MemberOf.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MemberOf = void 0;
-const Attestation_1 = require("../Attestation");
-const SchemaError_1 = require("../SchemaError");
-const GapContract_1 = require("../contract/GapContract");
-class MemberOf extends Attestation_1.Attestation {
-    async multiAttestPayload(currentPayload = [], projectIdx = 0) {
-        const payload = [...currentPayload];
-        const memberIdx = payload.push([this, await this.payloadFor(projectIdx)]) - 1;
-        if (this.details) {
-            payload.push([this.details, await this.details.payloadFor(memberIdx)]);
-        }
-        return payload.slice(currentPayload.length, payload.length);
-    }
-    async attest(signer, callback) {
-        const payload = await this.multiAttestPayload();
-        try {
-            const { uids, tx } = await GapContract_1.GapContract.multiAttest(signer, payload.map((p) => p[1]), callback);
-            const [memberUID, detailsUID] = uids;
-            this.uid = memberUID;
-            if (this.details && detailsUID) {
-                this.details.uid = detailsUID;
-            }
-            return { tx, uids };
-        }
-        catch (error) {
-            console.error(error);
-            throw new SchemaError_1.AttestationError("ATTEST_ERROR", error.message, error);
-        }
-    }
-}
-exports.MemberOf = MemberOf;

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

@@ -1,168 +0,0 @@
-import { Transaction } from "ethers";
-import { Hex, MultiAttestPayload, MultiRevokeArgs, SignerOrProvider, TNetwork } from "../../types";
-import { Attestation } from "../Attestation";
-import { GapSchema } from "../GapSchema";
-import { IMilestoneResponse } from "../karma-indexer/api/types";
-import { AttestationWithTx, MilestoneCompleted, IMilestoneCompleted } from "../types/attestations";
-export interface IMilestone {
-    title: string;
-    startsAt?: number;
-    endsAt: number;
-    description: string;
-    type?: string;
-    priority?: number;
-}
-/**
- * Milestone class represents a milestone that can be attested to one or multiple grants.
- *
- * It provides methods to:
- * - Create, complete, approve, reject, and verify milestones
- * - Attest a milestone to a single grant
- * - Attest a milestone to multiple grants in a single transaction
- * - Complete, approve, and verify milestones across multiple grants
- * - Revoke multiple milestone attestations at once
- */
-export declare class Milestone extends Attestation<IMilestone> implements IMilestone {
-    title: string;
-    startsAt?: number;
-    endsAt: number;
-    description: string;
-    completed: MilestoneCompleted;
-    approved: MilestoneCompleted;
-    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.
-     * @param signer
-     * @param reason
-     */
-    approve(signer: SignerOrProvider, data?: IMilestoneCompleted, callback?: Function): Promise<void>;
-    /**
-     * Approves this milestone across multiple grants. If the milestones are not completed,
-     * it will throw an error.
-     * @param signer - The signer to use for attestation
-     * @param milestoneUIDs - Array of milestone UIDs to approve
-     * @param data - Optional approval data
-     * @param callback - Optional callback function for status updates
-     * @returns Promise with transaction and UIDs
-     */
-    approveMultipleGrants(signer: SignerOrProvider, milestoneUIDs: Hex[], data?: IMilestoneCompleted, callback?: Function): Promise<AttestationWithTx>;
-    /**
-     * Revokes the approved status of the milestone. If the milestone is not approved,
-     * it will throw an error.
-     * @param signer
-     */
-    revokeApproval(signer: SignerOrProvider): Promise<void>;
-    /**
-     * Reject a completed milestone. If the milestone is not completed or already rejected,
-     * it will throw an error.
-     * @param signer
-     * @param reason
-     */
-    reject(signer: SignerOrProvider, reason?: string): Promise<void>;
-    /**
-     * Revokes the rejected status of the milestone. If the milestone is not rejected,
-     * it will throw an error.
-     * @param signer
-     */
-    revokeRejection(signer: SignerOrProvider): Promise<{
-        tx: Transaction[];
-        uids: `0x${string}`[];
-    }>;
-    /**
-     * Revokes multiple milestone attestations at once.
-     * This method can be used to revoke multiple milestone attestations in a single transaction.
-     *
-     * @param signer - The signer to use for revocation
-     * @param attestationsToRevoke - Array of objects containing schemaId and uid of attestations to revoke
-     * @param callback - Optional callback function for status updates
-     * @returns Promise with transaction and UIDs of revoked attestations
-     */
-    revokeMultipleAttestations(signer: SignerOrProvider, attestationsToRevoke: MultiRevokeArgs[], callback?: Function): Promise<AttestationWithTx>;
-    /**
-     * Marks a milestone as completed. If the milestone is already completed,
-     * it will throw an error.
-     * @param signer
-     * @param reason
-     */
-    complete(signer: SignerOrProvider, data?: IMilestoneCompleted, callback?: Function): Promise<AttestationWithTx>;
-    /**
-     * Marks a milestone as completed across multiple grants. If the milestone is already completed,
-     * it will throw an error.
-     * @param signer - The signer to use for attestation
-     * @param grantIndices - Array of grant indices to attest this milestone to, or array of milestone UIDs
-     * @param data - Optional completion data
-     * @param callback - Optional callback function for status updates
-     * @returns Promise with transaction and UIDs
-     */
-    completeForMultipleGrants(signer: SignerOrProvider, grantIndicesOrMilestoneUIDs?: number[] | Hex[], data?: IMilestoneCompleted, callback?: Function): Promise<AttestationWithTx>;
-    /**
-     * 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}`[];
-    }>;
-    /**
-     * 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 grantIdx
-     */
-    multiAttestPayload(currentPayload?: MultiAttestPayload, grantIdx?: number): Promise<[Attestation<unknown, GapSchema>, import("../../types").RawMultiAttestPayload][]>;
-    /**
-     * Creates the payload for a multi-attestation across multiple grants.
-     *
-     * This method allows for the same milestone to be attested to multiple grants
-     * in a single transaction.
-     *
-     * @param currentPayload - Current payload to append to
-     * @param grantIndices - Array of grant indices to attest this milestone to
-     * @returns The multi-attest payload with all grant attestations
-     */
-    multiGrantAttestPayload(currentPayload?: MultiAttestPayload, grantIndices?: number[]): Promise<[Attestation<unknown, GapSchema>, import("../../types").RawMultiAttestPayload][]>;
-    /**
-     * Attests this milestone to multiple grants in a single transaction.
-     *
-     * @param signer - The signer to use for attestation
-     * @param grantIndices - Array of grant indices to attest this milestone to, or array of grant UIDs
-     * @param callback - Optional callback function for status updates
-     * @returns Promise with transaction and UIDs
-     */
-    attestToMultipleGrants(signer: SignerOrProvider, grantIndices?: number[] | Hex[], callback?: Function): Promise<AttestationWithTx>;
-    /**
-     * @inheritdoc
-     */
-    attest(signer: SignerOrProvider, callback?: Function): Promise<AttestationWithTx>;
-    /**
-     * Attest the status of the milestone as approved, rejected or completed.
-     */
-    private attestStatus;
-    static from(attestations: IMilestoneResponse[], network: TNetwork): Milestone[];
-    /**
-     * Verify this milestone. If the milestone is not completed or already verified,
-     * it will throw an error.
-     * @param signer
-     * @param reason
-     */
-    verify(signer: SignerOrProvider, data?: IMilestoneCompleted, callback?: Function): Promise<AttestationWithTx>;
-    /**
-     * Verifies this milestone across multiple grants. If the milestones are not completed,
-     * it will throw an error.
-     * @param signer - The signer to use for attestation
-     * @param milestoneUIDs - Array of milestone UIDs to verify
-     * @param data - Optional verification data
-     * @param callback - Optional callback function for status updates
-     * @returns Promise with transaction and UIDs
-     */
-    verifyMultipleGrants(signer: SignerOrProvider, milestoneUIDs: Hex[], data?: IMilestoneCompleted, callback?: Function): Promise<AttestationWithTx>;
-}