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

package/core/class/contract/GapContract.js

@@ -1,285 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GapContract = void 0;
-const eas_sdk_1 = require("@ethereum-attestation-service/eas-sdk");
-const send_gelato_txn_1 = require("../../utils/gelato/send-gelato-txn");
-const serialize_bigint_1 = require("../../utils/serialize-bigint");
-const GAP_1 = require("../GAP");
-const AttestationDataTypes = {
-    Attest: [
-        { name: "payloadHash", type: "string" },
-        { name: "nonce", type: "uint256" },
-        { name: "expiry", type: "uint256" },
-    ],
-};
-class GapContract {
-    /**
-     * Signs a message for the delegated attestation.
-     * @param signer
-     * @param payload
-     * @returns r,s,v signature
-     */
-    static async signAttestation(signer, payload, expiry) {
-        let { nonce } = await this.getNonce(signer);
-        const { chainId } = await signer.provider.getNetwork();
-        const domain = {
-            chainId,
-            name: "gap-attestation",
-            version: "1",
-            verifyingContract: (await GAP_1.GAP.getMulticall(signer)).address,
-        };
-        const data = { payloadHash: payload, nonce, expiry };
-        console.log({ domain, AttestationDataTypes, data });
-        const signature = await signer._signTypedData(domain, AttestationDataTypes, data);
-        const { r, s, v } = this.getRSV(signature);
-        return { r, s, v, nonce, chainId };
-    }
-    /**
-     * Returns the r, s, v values of a signature
-     * @param signature
-     * @returns
-     */
-    static getRSV(signature) {
-        const r = signature.slice(0, 66);
-        const s = `0x${signature.slice(66, 130)}`;
-        const v = `0x${signature.slice(130, 132)}`;
-        return { r, s, v };
-    }
-    static async getSignerAddress(signer) {
-        const address = signer.address || signer._address || (await signer.getAddress());
-        if (!address)
-            throw new Error("Signer does not provider either address or getAddress().");
-        return address;
-    }
-    /**
-     * Get nonce for the transaction
-     * @param address
-     * @returns
-     */
-    static async getNonce(signer) {
-        const contract = await GAP_1.GAP.getMulticall(signer);
-        const address = await this.getSignerAddress(signer);
-        console.log({ address });
-        const nonce = await contract.nonces(address);
-        return {
-            nonce: Number(nonce),
-            next: Number(nonce + 1n),
-        };
-    }
-    /**
-     * Send a single attestation
-     * @param signer
-     * @param payload
-     * @returns
-     */
-    static async attest(signer, payload, callback) {
-        const contract = await GAP_1.GAP.getMulticall(signer);
-        if (GAP_1.GAP.gelatoOpts?.useGasless) {
-            return this.attestBySig(signer, payload);
-        }
-        callback?.("preparing");
-        const tx = await contract
-            .attest({
-            schema: payload.schema,
-            data: payload.data.payload,
-        })
-            .then((res) => {
-            callback?.("pending");
-            return res;
-        });
-        const result = await tx.wait?.();
-        callback?.("confirmed");
-        const attestations = (0, eas_sdk_1.getUIDsFromAttestReceipt)(result)[0];
-        const resultArray = [result].flat();
-        return {
-            tx: resultArray,
-            uids: [attestations],
-        };
-    }
-    static async attestBySig(signer, payload) {
-        const contract = await GAP_1.GAP.getMulticall(signer);
-        const expiry = BigInt(Math.floor(Date.now() / 1000) + 60 * 60 * 24 * 30);
-        const address = await this.getSignerAddress(signer);
-        const payloadHash = (0, serialize_bigint_1.serializeWithBigint)({
-            schema: payload.schema,
-            data: payload.data.raw,
-        });
-        const { r, s, v, nonce, chainId } = await this.signAttestation(signer, payloadHash, expiry);
-        const { data: populatedTxn } = await contract.attestBySig.populateTransaction({
-            data: payload.data.payload,
-            schema: payload.schema,
-        }, payloadHash, address, nonce, expiry, v, r, s);
-        if (!populatedTxn)
-            throw new Error("Transaction data is empty");
-        let contractAddress = await contract.getAddress();
-        const txn = await (0, send_gelato_txn_1.sendGelatoTxn)(...send_gelato_txn_1.Gelato.buildArgs(populatedTxn, chainId, contractAddress));
-        const attestations = await this.getTransactionLogs(signer, txn);
-        return {
-            tx: [
-                {
-                    hash: txn,
-                },
-            ],
-            uids: attestations,
-        };
-    }
-    /**
-     * Performs a referenced multi attestation.
-     *
-     * @returns an array with the attestation UIDs.
-     */
-    static async multiAttest(signer, payload, callback) {
-        const contract = await GAP_1.GAP.getMulticall(signer);
-        if (GAP_1.GAP.gelatoOpts?.useGasless) {
-            return this.multiAttestBySig(signer, payload);
-        }
-        if (callback)
-            callback("preparing");
-        const tx = await contract.multiSequentialAttest(payload.map((p) => p.payload));
-        if (callback)
-            callback("pending");
-        const result = await tx.wait?.();
-        if (callback)
-            callback("confirmed");
-        const attestations = (0, eas_sdk_1.getUIDsFromAttestReceipt)(result);
-        const resultArray = [result].flat();
-        return {
-            tx: resultArray,
-            uids: attestations,
-        };
-    }
-    /**
-     * Performs a referenced multi attestation.
-     *
-     * @returns an array with the attestation UIDs.
-     */
-    static async multiAttestBySig(signer, payload) {
-        const contract = await GAP_1.GAP.getMulticall(signer);
-        const expiry = BigInt(Math.floor(Date.now() / 1000) + 60 * 60 * 24 * 30);
-        const address = await this.getSignerAddress(signer);
-        const payloadHash = (0, serialize_bigint_1.serializeWithBigint)(payload.map((p) => p.raw));
-        const { r, s, v, nonce, chainId } = await this.signAttestation(signer, payloadHash, expiry);
-        console.info({ r, s, v, nonce, chainId, payloadHash, address });
-        const { data: populatedTxn } = await contract.multiSequentialAttestBySig.populateTransaction(payload.map((p) => p.payload), payloadHash, address, nonce, expiry, v, r, s);
-        if (!populatedTxn)
-            throw new Error("Transaction data is empty");
-        let contractAddress = await contract.getAddress();
-        const txn = await (0, send_gelato_txn_1.sendGelatoTxn)(...send_gelato_txn_1.Gelato.buildArgs(populatedTxn, chainId, contractAddress));
-        const attestations = await this.getTransactionLogs(signer, txn);
-        return {
-            tx: [
-                {
-                    hash: txn,
-                },
-            ],
-            uids: attestations,
-        };
-    }
-    static async multiRevoke(signer, payload) {
-        const contract = await GAP_1.GAP.getMulticall(signer);
-        if (GAP_1.GAP.gelatoOpts?.useGasless) {
-            return this.multiRevokeBySig(signer, payload);
-        }
-        const tx = await contract.multiRevoke(payload);
-        return {
-            tx: [tx],
-            uids: [],
-        };
-    }
-    /**
-     * Performs a referenced multi attestation.
-     *
-     * @returns an array with the attestation UIDs.
-     */
-    static async multiRevokeBySig(signer, payload) {
-        const contract = await GAP_1.GAP.getMulticall(signer);
-        const expiry = BigInt(Math.floor(Date.now() / 1000) + 60 * 60 * 24 * 30);
-        const address = await this.getSignerAddress(signer);
-        const payloadHash = (0, serialize_bigint_1.serializeWithBigint)(payload);
-        const { r, s, v, nonce, chainId } = await this.signAttestation(signer, payloadHash, expiry);
-        console.info({ r, s, v, nonce, chainId, payloadHash, address });
-        const { data: populatedTxn } = await contract.multiRevokeBySig.populateTransaction(payload, payloadHash, address, nonce, expiry, v, r, s);
-        if (!populatedTxn)
-            throw new Error("Transaction data is empty");
-        let contractAddress = await contract.getAddress();
-        const txn = await (0, send_gelato_txn_1.sendGelatoTxn)(...send_gelato_txn_1.Gelato.buildArgs(populatedTxn, chainId, contractAddress));
-        return {
-            tx: [{ hash: txn }],
-            uids: [],
-        };
-    }
-    /**
-     * Transfer the ownership of an attestation
-     * @param signer
-     * @param projectUID
-     * @param newOwner
-     * @returns
-     */
-    static async transferProjectOwnership(signer, projectUID, newOwner) {
-        const contract = await GAP_1.GAP.getProjectResolver(signer);
-        const tx = await contract.transferProjectOwnership(projectUID, newOwner);
-        return tx.wait?.();
-    }
-    /**
-     * Check if the signer is the owner of the project
-     * @param signer
-     * @param projectUID
-     * @param projectChainId
-     * @param publicAddress
-     * @returns
-     */
-    static async isProjectOwner(signer, projectUID, projectChainId, publicAddress) {
-        const contract = await GAP_1.GAP.getProjectResolver(signer, projectChainId);
-        const address = publicAddress || (await this.getSignerAddress(signer));
-        const isOwner = await contract.isOwner(projectUID, address);
-        return isOwner;
-    }
-    /**
-     * Check if the signer is admin of the project
-     * @param signer
-     * @param projectUID
-     * @param projectChainId
-     * @param publicAddress
-     * @returns
-     */
-    static async isProjectAdmin(signer, projectUID, projectChainId, publicAddress) {
-        const contract = await GAP_1.GAP.getProjectResolver(signer, projectChainId);
-        const address = publicAddress || (await this.getSignerAddress(signer));
-        const isAdmin = await contract.isAdmin(projectUID, address);
-        return isAdmin;
-    }
-    static async getTransactionLogs(signer, txnHash) {
-        const txn = await signer.provider.getTransactionReceipt(txnHash);
-        if (!txn || !txn.logs.length)
-            throw new Error("Transaction not found");
-        // Returns the txn logs with the attestation results. Tha last two logs are the
-        // the ones from the GelatoRelay contract.
-        return (0, eas_sdk_1.getUIDsFromAttestReceipt)(txn);
-    }
-    /**
-     * Add Project Admin
-     * @param signer
-     * @param projectUID
-     * @param newAdmin
-     * @returns
-     */
-    static async addProjectAdmin(signer, projectUID, newAdmin) {
-        const contract = await GAP_1.GAP.getProjectResolver(signer);
-        const tx = await contract.addAdmin(projectUID, newAdmin);
-        return tx.wait?.();
-    }
-    /**
-     * RemoveProject Admin
-     * @param signer
-     * @param projectUID
-     * @param newAdmin
-     * @returns
-     */
-    static async removeProjectAdmin(signer, projectUID, oldAdmin) {
-        const contract = await GAP_1.GAP.getProjectResolver(signer);
-        const tx = await contract.removeAdmin(projectUID, oldAdmin);
-        return tx.wait?.();
-    }
-}
-exports.GapContract = GapContract;
-GapContract.nonces = {};

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

@@ -1,34 +0,0 @@
-import { Attestation } from "../Attestation";
-import { AttestationWithTx, CommunityDetails, ICommunityDetails } from "../types/attestations";
-import { Project } from "./Project";
-import { MultiAttestPayload, SignerOrProvider, TNetwork } from "core/types";
-import { Grant } from "./Grant";
-import { ICommunityResponse } from "../karma-indexer/api/types";
-export interface ICommunity {
-    community: true;
-}
-export declare class Community extends Attestation<ICommunity> {
-    projects: Project[];
-    grants: Grant[];
-    details?: CommunityDetails;
-    /**
-     * 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, details?: ICommunityDetails, callback?: Function): Promise<AttestationWithTx>;
-    static from(attestations: ICommunityResponse[], network: TNetwork): Community[];
-}

package/core/class/entities/Community.js

@@ -1,109 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Community = void 0;
-const Attestation_1 = require("../Attestation");
-const attestations_1 = require("../types/attestations");
-const consts_1 = require("../../consts");
-const SchemaError_1 = require("../SchemaError");
-const GapSchema_1 = require("../GapSchema");
-const Grant_1 = require("./Grant");
-class Community extends Attestation_1.Attestation {
-    constructor() {
-        super(...arguments);
-        this.projects = [];
-        this.grants = [];
-    }
-    /**
-     * 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)]];
-        if (this.details) {
-            payload.push([this.details, await this.details.payloadFor(0)]);
-        }
-        if (this.projects?.length) {
-            await Promise.all(this.projects.map(async (p) => payload.push(...(await p.multiAttestPayload(payload, 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, details, callback) {
-        console.log("Attesting community");
-        try {
-            if (callback)
-                callback("preparing");
-            const { tx: communityTx, uids: communityUID } = await this.schema.attest({
-                signer,
-                to: this.recipient,
-                refUID: consts_1.nullRef,
-                data: this.data,
-            });
-            this._uid = communityTx[0].hash;
-            console.log(this.uid);
-            if (callback)
-                callback("pending");
-            if (details) {
-                const communityDetails = new attestations_1.CommunityDetails({
-                    data: details,
-                    recipient: this.recipient,
-                    refUID: this.uid,
-                    schema: this.schema.gap.findSchema("CommunityDetails"),
-                });
-                const { tx: communityDetailsTx, uids: communityDetailsUID } = await communityDetails.attest(signer);
-                return {
-                    tx: [communityTx[0], communityDetailsTx[0]],
-                    uids: [communityUID[0], communityDetailsUID[0]],
-                };
-            }
-            if (callback)
-                callback("confirmed");
-            return { tx: communityTx, uids: communityUID };
-        }
-        catch (error) {
-            console.error(error);
-            throw new SchemaError_1.AttestationError("ATTEST_ERROR", "Error during attestation.", error);
-        }
-    }
-    static from(attestations, network) {
-        return attestations.map((attestation) => {
-            const community = new Community({
-                ...attestation,
-                data: {
-                    community: true,
-                },
-                schema: GapSchema_1.GapSchema.find("Community", network),
-                chainID: attestation.chainID,
-            });
-            if (attestation.details) {
-                const { details } = attestation;
-                community.details = new attestations_1.CommunityDetails({
-                    ...details,
-                    data: {
-                        ...details.data,
-                    },
-                    schema: GapSchema_1.GapSchema.find("CommunityDetails", network),
-                    chainID: attestation.chainID,
-                });
-            }
-            if (attestation.grants) {
-                const { grants } = attestation;
-                community.grants = Grant_1.Grant.from(grants, network);
-            }
-            return community;
-        });
-    }
-}
-exports.Community = Community;

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

@@ -1,41 +0,0 @@
-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;
-    linkedin?: string;
-    farcaster?: string;
-}
-export declare class ContributorProfile extends Attestation<IContributorProfile> implements IContributorProfile {
-    name: string;
-    aboutMe?: string;
-    github?: string;
-    twitter?: string;
-    linkedin?: string;
-    farcaster?: string;
-    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

@@ -1,69 +0,0 @@
-"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

@@ -1,54 +0,0 @@
-import { Attestation } from "../Attestation";
-import { GrantDetails, GrantRound, GrantCompleted, AttestationWithTx } from "../types/attestations";
-import { IMilestone, Milestone } from "./Milestone";
-import { GapSchema } from "../GapSchema";
-import { Hex, MultiAttestPayload, SignerOrProvider, TNetwork } from "core/types";
-import { Community } from "./Community";
-import { IGrantResponse, IProjectResponse, ISummaryProject } from "../karma-indexer/api/types";
-import { GrantUpdate, IGrantUpdate } from "./GrantUpdate";
-export interface IGrant {
-    communityUID: Hex;
-}
-export declare class Grant extends Attestation<IGrant> {
-    details?: GrantDetails;
-    communityUID: Hex;
-    verified?: boolean;
-    round?: GrantRound;
-    milestones: Milestone[];
-    community: Community;
-    updates: GrantUpdate[];
-    members: string[];
-    completed?: GrantCompleted;
-    project?: IProjectResponse | ISummaryProject;
-    categories?: string[];
-    verify(signer: SignerOrProvider): Promise<void>;
-    /**
-     * Add milestones to the grant.
-     * @param signer
-     * @param milestones
-     */
-    addMilestones(milestones: IMilestone[]): void;
-    /**
-     * 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
-     */
-    multiAttestPayload(currentPayload?: MultiAttestPayload, projectIdx?: number): Promise<[Attestation<unknown, GapSchema>, import("core/types").RawMultiAttestPayload][]>;
-    attestProject(signer: SignerOrProvider, originalProjectChainId: number): Promise<AttestationWithTx>;
-    /**
-     * @inheritdoc
-     */
-    attest(signer: SignerOrProvider, projectChainId: number, callback?: Function): Promise<AttestationWithTx>;
-    attestUpdate(signer: SignerOrProvider, data: IGrantUpdate, callback?: Function): Promise<void>;
-    /**
-     * 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[];
-}