@show-karma/karma-gap-sdk 0.1.40 → 0.2.1

package/core/class/Attestation.d.ts

@@ -134,10 +134,10 @@ export declare class Attestation<T = unknown, S extends Schema = GapSchema> impl
      * @param refIdx
      * @returns [Encoded payload, Raw payload]
      */
-    payloadFor(refIdx: number): {
+    payloadFor(refIdx: number): Promise<{
         payload: MultiAttestData;
         raw: MultiAttestData;
-    };
+    }>;
     /**
      * Returns an Attestation instance from a JSON decoded schema.
      * @param data

package/core/class/Attestation.js

@@ -4,6 +4,7 @@ exports.Attestation = void 0;
 const Schema_1 = require("./Schema");
 const SchemaError_1 = require("./SchemaError");
 const get_date_1 = require("../utils/get-date");
+const GAP_1 = require("./GAP");
 const consts_1 = require("../consts");
 const GapContract_1 = require("./contract/GapContract");
 /**
@@ -184,8 +185,16 @@ class Attestation {
      * @param refIdx
      * @returns [Encoded payload, Raw payload]
      */
-    payloadFor(refIdx) {
+    async payloadFor(refIdx) {
         this.assertPayload();
+        if (this.schema.isJsonSchema()) {
+            const ipfsManager = GAP_1.GAP.ipfs;
+            if (ipfsManager) {
+                const ipfsHash = await ipfsManager.save(this._data);
+                const encodedData = ipfsManager.encode(ipfsHash, 0);
+                this.schema.setValue("json", JSON.stringify(encodedData));
+            }
+        }
         const payload = (encode = true) => ({
             uid: consts_1.nullRef,
             refIdx,

package/core/class/AttestationIPFS.d.ts

@@ -0,0 +1,7 @@
+import { IPFS } from './IPFS/IPFS';
+export declare class AttestationIPFS extends IPFS {
+    encode(data: string, storageType: number): {
+        ipfsHash: string;
+        type: number;
+    };
+}

package/core/class/AttestationIPFS.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttestationIPFS = void 0;
+const IPFS_1 = require("./IPFS/IPFS");
+class AttestationIPFS extends IPFS_1.IPFS {
+    encode(data, storageType) {
+        return { ipfsHash: data, type: storageType };
+    }
+}
+exports.AttestationIPFS = AttestationIPFS;

package/core/class/GAP.d.ts

@@ -2,6 +2,7 @@ import { AttestArgs, Facade, SchemaInterface, TNetwork, TSchemaName, SignerOrPro
 import { GapSchema } from "./GapSchema";
 import { ethers } from "ethers";
 import { Fetcher } from "./Fetcher";
+import { AttestationIPFS } from "./AttestationIPFS";
 interface GAPArgs {
     network: TNetwork;
     globalSchemas?: boolean;
@@ -88,6 +89,17 @@ interface GAPArgs {
          */
         useGasless?: boolean;
     };
+    /**
+     * Specifies an optional IPFS key for uploading project details and other related data.
+     *
+     * This key is used to authenticate with the IPFS storage service, specifically designed for use with "NFT.STORAGE".
+     * Utilizing IPFS (InterPlanetary File System) offers a decentralized solution for storing data, ensuring better
+     * scalability and efficiency compared to sending large amounts of data directly in the attestation body.
+     *
+     * If an IPFS key is not provided, the default storage method will be used.
+     *
+     */
+    ipfsKey?: string;
 }
 /**
  * GAP SDK Facade.
@@ -146,12 +158,14 @@ interface GAPArgs {
  */
 export declare class GAP extends Facade {
     private static client;
+    private static ipfsManager;
     readonly fetch: Fetcher;
     readonly network: TNetwork;
     private _schemas;
     private static _gelatoOpts;
     constructor(args: GAPArgs);
-    private assert;
+    private assertGelatoOpts;
+    private assertIPFSOpts;
     /**
      * Creates the attestation payload using a specific schema.
      * @param from
@@ -208,5 +222,6 @@ export declare class GAP extends Facade {
      */
     static get gelatoOpts(): GAPArgs["gelatoOpts"];
     static set useGasLess(useGasLess: boolean);
+    static get ipfs(): AttestationIPFS;
 }
 export {};

package/core/class/GAP.js

@@ -13,6 +13,7 @@ const consts_1 = require("../consts");
 const ethers_1 = require("ethers");
 const MultiAttester_json_1 = __importDefault(require("../abi/MultiAttester.json"));
 const package_json_1 = require("../../package.json");
+const AttestationIPFS_1 = require("./AttestationIPFS");
 /**
  * GAP SDK Facade.
  *
@@ -97,13 +98,16 @@ class GAP extends types_1.Facade {
         this.network = args.network;
         GAP._eas = new eas_sdk_1.EAS(consts_1.Networks[args.network].contracts.eas);
         this.fetch = args.apiClient || new GapEasClient_1.GapEasClient({ network: args.network });
-        this.assert(args);
+        this.assertGelatoOpts(args);
         GAP._gelatoOpts = args.gelatoOpts;
+        if (this.assertIPFSOpts(args)) {
+            GAP.ipfsManager = new AttestationIPFS_1.AttestationIPFS(args.ipfsKey);
+        }
         this._schemas = schemas.map((schema) => new GapSchema_1.GapSchema(schema, false, args.globalSchemas ? !args.globalSchemas : false));
         Schema_1.Schema.validate();
         console.info(`Loaded GAP SDK v${package_json_1.version}`);
     }
-    assert(args) {
+    assertGelatoOpts(args) {
         if (args.gelatoOpts &&
             !(args.gelatoOpts.sponsorUrl || args.gelatoOpts.apiKey)) {
             throw new Error("You must provide a `sponsorUrl` or an `apiKey`.");
@@ -120,6 +124,12 @@ class GAP extends types_1.Facade {
             console.warn("GAP::You are using gelatoOpts but not setting useGasless to true. This will send transactions through the normal provider.");
         }
     }
+    assertIPFSOpts(args) {
+        if (!args.ipfsKey) {
+            return false;
+        }
+        return true;
+    }
     /**
      * Creates the attestation payload using a specific schema.
      * @param from
@@ -201,6 +211,9 @@ class GAP extends types_1.Facade {
         }
         this._gelatoOpts.useGasless = useGasLess;
     }
+    static get ipfs() {
+        return this.ipfsManager;
+    }
 }
 exports.GAP = GAP;
 GAP._gelatoOpts = null;

package/core/class/IPFS/IPFS.d.ts

@@ -0,0 +1,13 @@
+import { NFTStorage } from "nft.storage";
+export declare abstract class IPFS {
+    protected client: NFTStorage;
+    constructor(ipfsKey: string);
+    /**
+    * Insert the data in the IPFS and return the cid.
+    */
+    save<T = unknown>(data: T): Promise<string>;
+    /**
+    * Encode Attestation data using IPFS cid
+    */
+    protected abstract encode(data: string, storageType: number): any;
+}

package/core/class/IPFS/IPFS.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IPFS = void 0;
+const nft_storage_1 = require("nft.storage");
+const SchemaError_1 = require("../SchemaError");
+class IPFS {
+    constructor(ipfsKey) {
+        this.client = new nft_storage_1.NFTStorage({ token: ipfsKey });
+    }
+    /**
+    * Insert the data in the IPFS and return the cid.
+    */
+    async save(data) {
+        try {
+            const blob = new nft_storage_1.Blob([JSON.stringify(data)], { type: 'application/json' });
+            const cid = await this.client.storeBlob(blob);
+            return cid;
+        }
+        catch (error) {
+            throw new SchemaError_1.AttestationError('IPFS_UPLOAD', `Error adding data to IPFS`);
+        }
+    }
+}
+exports.IPFS = IPFS;

package/core/class/Schema.d.ts

@@ -125,9 +125,18 @@ export declare abstract class Schema<T extends string = string> implements Schem
      */
     multiRevokeOffchain(uids: Hex[], signer: SignerOrProvider): Promise<import("@ethereum-attestation-service/eas-sdk/dist/transaction").Transaction<bigint[]>>;
     /**
-     * Attest for a schema.
-     * @param param0
-     * @returns
+     * Validates and attests a given schema.
+     *
+     * This function checks a schema against predefined standards or rules. If the 'ipfsKey' parameter is enabled,
+     * it uploads the data to the IPFS (InterPlanetary File System). Upon successful upload, the function
+     * returns the CID (Content Identifier) within the Attestation Body, providing a reference to the data on IPFS.
+     *
+     * Usage:
+     * - Ensure that the schema to be attested conforms to the required format.
+     * - Enable 'ipfsKey' if you wish to store the data on IPFS and retrieve its CID.
+     *
+     * @param {Object} param0 - An object containing the schema and other optional settings.
+     * @returns {Object} An object containing the attestation results, including the CID if 'ipfsKey' is enabled.
      */
     attest<T>({ data, to, signer, refUID }: AttestArgs<T>): Promise<Hex>;
     /**

package/core/class/Schema.js

@@ -205,15 +205,30 @@ class Schema {
         return eas.multiRevokeOffchain(uids);
     }
     /**
-     * Attest for a schema.
-     * @param param0
-     * @returns
+     * Validates and attests a given schema.
+     *
+     * This function checks a schema against predefined standards or rules. If the 'ipfsKey' parameter is enabled,
+     * it uploads the data to the IPFS (InterPlanetary File System). Upon successful upload, the function
+     * returns the CID (Content Identifier) within the Attestation Body, providing a reference to the data on IPFS.
+     *
+     * Usage:
+     * - Ensure that the schema to be attested conforms to the required format.
+     * - Enable 'ipfsKey' if you wish to store the data on IPFS and retrieve its CID.
+     *
+     * @param {Object} param0 - An object containing the schema and other optional settings.
+     * @returns {Object} An object containing the attestation results, including the CID if 'ipfsKey' is enabled.
      */
     async attest({ data, to, signer, refUID }) {
         const eas = GAP_1.GAP.eas.connect(signer);
         if (this.references && !refUID)
             throw new SchemaError_1.AttestationError("INVALID_REFERENCE", "Attestation schema references another schema but no reference UID was provided.");
         if (this.isJsonSchema()) {
+            const ipfsManager = GAP_1.GAP.ipfs;
+            if (ipfsManager) {
+                const ipfsHash = await ipfsManager.save(data);
+                const encodedData = ipfsManager.encode(ipfsHash, 0);
+                data = encodedData;
+            }
             this.setValue("json", JSON.stringify(data));
         }
         else {

package/core/class/SchemaError.d.ts

@@ -14,6 +14,7 @@ declare const SchemaErrorCodes: {
     INVALID_REF_UID: number;
     REVOKATION_ERROR: number;
     NOT_REVOCABLE: number;
+    IPFS_UPLOAD: number;
 };
 export declare class SchemaError extends Error {
     readonly code: number;

package/core/class/SchemaError.js

@@ -17,6 +17,7 @@ const SchemaErrorCodes = {
     INVALID_REF_UID: 50013,
     REVOKATION_ERROR: 50014,
     NOT_REVOCABLE: 50015,
+    IPFS_UPLOAD: 50016,
 };
 class SchemaError extends Error {
     constructor(code, append) {

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

@@ -22,7 +22,7 @@ export declare class Community extends Attestation<ICommunity> {
      * @param payload
      * @param refIdx
      */
-    multiAttestPayload(): MultiAttestPayload;
+    multiAttestPayload(): Promise<MultiAttestPayload>;
     /**
      * Attest a community with its details.
      *

package/core/class/entities/Community.js

@@ -23,15 +23,13 @@ class Community extends Attestation_1.Attestation {
      * @param payload
      * @param refIdx
      */
-    multiAttestPayload() {
-        const payload = [[this, this.payloadFor(0)]];
+    async multiAttestPayload() {
+        const payload = [[this, await this.payloadFor(0)]];
         if (this.details) {
-            payload.push([this.details, this.details.payloadFor(0)]);
+            payload.push([this.details, await this.details.payloadFor(0)]);
         }
         if (this.projects?.length) {
-            this.projects.forEach((p) => {
-                payload.push(...p.multiAttestPayload(payload, 0));
-            });
+            await Promise.all(this.projects.map(async (p) => payload.push(...(await p.multiAttestPayload(payload, 0)))));
         }
         return payload;
     }

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

@@ -42,7 +42,7 @@ export declare class Grant extends Attestation<IGrant> {
      * @param payload
      * @param projectIdx
      */
-    multiAttestPayload(currentPayload?: MultiAttestPayload, projectIdx?: number): [Attestation<unknown, GapSchema>, import("core/types").RawMultiAttestPayload][];
+    multiAttestPayload(currentPayload?: MultiAttestPayload, projectIdx?: number): Promise<[Attestation<unknown, GapSchema>, import("core/types").RawMultiAttestPayload][]>;
     /**
      * @inheritdoc
      */

package/core/class/entities/Grant.js

@@ -10,7 +10,6 @@ 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");
 class Grant extends Attestation_1.Attestation {
     constructor() {
         super(...arguments);
@@ -71,22 +70,18 @@ class Grant extends Attestation_1.Attestation {
      * @param payload
      * @param projectIdx
      */
-    multiAttestPayload(currentPayload = [], projectIdx = 0) {
+    async multiAttestPayload(currentPayload = [], projectIdx = 0) {
         this.assertPayload();
         const payload = [...currentPayload];
-        const grantIdx = payload.push([this, this.payloadFor(projectIdx)]) - 1;
+        const grantIdx = payload.push([this, await this.payloadFor(projectIdx)]) - 1;
         if (this.details) {
-            payload.push([this.details, this.details.payloadFor(grantIdx)]);
+            payload.push([this.details, await this.details.payloadFor(grantIdx)]);
         }
         if (this.milestones.length) {
-            this.milestones.forEach((m) => {
-                payload.push([m, m.payloadFor(grantIdx)]);
-            });
+            await Promise.all(this.milestones.map(async (m) => payload.push(...(await m.multiAttestPayload(currentPayload, grantIdx)))));
         }
         if (this.updates.length) {
-            this.updates.forEach((u) => {
-                payload.push([u, u.payloadFor(grantIdx)]);
-            });
+            await Promise.all(this.updates.map(async (u) => payload.push([u, await u.payloadFor(grantIdx)])));
         }
         return payload.slice(currentPayload.length, payload.length);
     }
@@ -95,7 +90,7 @@ class Grant extends Attestation_1.Attestation {
      */
     async attest(signer) {
         this.assertPayload();
-        const payload = this.multiAttestPayload();
+        const payload = await this.multiAttestPayload();
         const uids = await GapContract_1.GapContract.multiAttest(signer, payload.map((p) => p[1]));
         uids.forEach((uid, index) => {
             payload[index][0].uid = uid;
@@ -182,12 +177,7 @@ class Grant extends Attestation_1.Attestation {
             }
             if (attestation.project) {
                 const { project } = attestation;
-                const rawProject = Project_1.Project.from([project])[0];
-                grant.project = {
-                    title: rawProject.details?.title,
-                    uid: rawProject.uid,
-                    slug: rawProject.details?.slug,
-                };
+                grant.project = project;
             }
             if (attestation.community) {
                 const { community } = attestation;

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

@@ -6,6 +6,6 @@ export interface IMemberOf {
 }
 export declare class MemberOf extends Attestation<IMemberOf> {
     details?: MemberDetails;
-    multiAttestPayload(currentPayload?: MultiAttestPayload, projectIdx?: number): [Attestation<unknown, import("..").GapSchema>, import("core/types").RawMultiAttestPayload][];
+    multiAttestPayload(currentPayload?: MultiAttestPayload, projectIdx?: number): Promise<[Attestation<unknown, import("..").GapSchema>, import("core/types").RawMultiAttestPayload][]>;
     attest(signer: SignerOrProvider): Promise<void>;
 }

package/core/class/entities/MemberOf.js

@@ -5,16 +5,16 @@ const Attestation_1 = require("../Attestation");
 const SchemaError_1 = require("../SchemaError");
 const GapContract_1 = require("../contract/GapContract");
 class MemberOf extends Attestation_1.Attestation {
-    multiAttestPayload(currentPayload = [], projectIdx = 0) {
+    async multiAttestPayload(currentPayload = [], projectIdx = 0) {
         const payload = [...currentPayload];
-        const memberIdx = payload.push([this, this.payloadFor(projectIdx)]) - 1;
+        const memberIdx = payload.push([this, await this.payloadFor(projectIdx)]) - 1;
         if (this.details) {
-            payload.push([this.details, this.details.payloadFor(memberIdx)]);
+            payload.push([this.details, await this.details.payloadFor(memberIdx)]);
         }
         return payload.slice(currentPayload.length, payload.length);
     }
     async attest(signer) {
-        const payload = this.multiAttestPayload();
+        const payload = await this.multiAttestPayload();
         try {
             const [memberUID, detailsUID] = await GapContract_1.GapContract.multiAttest(signer, payload.map((p) => p[1]));
             this.uid = memberUID;

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

@@ -1,5 +1,6 @@
-import { SignerOrProvider } from '../../types';
+import { MultiAttestPayload, SignerOrProvider } from '../../types';
 import { Attestation } from '../Attestation';
+import { GapSchema } from '../GapSchema';
 import { MilestoneCompleted } from '../types/attestations';
 interface _Milestone extends Milestone {
 }
@@ -54,6 +55,21 @@ export declare class Milestone extends Attestation<IMilestone> implements IMiles
      * @param signer
      */
     revokeCompletion(signer: SignerOrProvider): Promise<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 grantIdx
+     */
+    multiAttestPayload(currentPayload?: MultiAttestPayload, grantIdx?: number): Promise<[Attestation<unknown, GapSchema>, import("../../types").RawMultiAttestPayload][]>;
+    /**
+     * @inheritdoc
+     */
+    attest(signer: SignerOrProvider): Promise<void>;
     /**
      * Attest the status of the milestone as approved, rejected or completed.
      */

package/core/class/entities/Milestone.js

@@ -5,6 +5,7 @@ const Attestation_1 = require("../Attestation");
 const GAP_1 = require("../GAP");
 const GapSchema_1 = require("../GapSchema");
 const SchemaError_1 = require("../SchemaError");
+const GapContract_1 = require("../contract/GapContract");
 const attestations_1 = require("../types/attestations");
 class Milestone extends Attestation_1.Attestation {
     /**
@@ -119,6 +120,40 @@ class Milestone extends Attestation_1.Attestation {
             },
         ]);
     }
+    /**
+     * 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
+     */
+    async multiAttestPayload(currentPayload = [], grantIdx = 0) {
+        this.assertPayload();
+        const payload = [...currentPayload];
+        const milestoneIdx = payload.push([this, await this.payloadFor(grantIdx)]) - 1;
+        if (this.completed) {
+            payload.push([
+                this.completed,
+                await this.completed.payloadFor(milestoneIdx),
+            ]);
+        }
+        return payload.slice(currentPayload.length, payload.length);
+    }
+    /**
+     * @inheritdoc
+     */
+    async attest(signer) {
+        this.assertPayload();
+        const payload = await this.multiAttestPayload();
+        const uids = await GapContract_1.GapContract.multiAttest(signer, payload.map((p) => p[1]));
+        uids.forEach((uid, index) => {
+            payload[index][0].uid = uid;
+        });
+        console.log(uids);
+    }
     /**
      * Attest the status of the milestone as approved, rejected or completed.
      */

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

@@ -23,7 +23,7 @@ export declare class Project extends Attestation<IProject> {
      * @param payload
      * @param communityIdx
      */
-    multiAttestPayload(currentPayload?: MultiAttestPayload, communityIdx?: number): MultiAttestPayload;
+    multiAttestPayload(currentPayload?: MultiAttestPayload, communityIdx?: number): Promise<MultiAttestPayload>;
     attest(signer: SignerOrProvider): Promise<void>;
     /**
      * Add new members to the project.

package/core/class/entities/Project.js

@@ -26,26 +26,22 @@ class Project extends Attestation_1.Attestation {
      * @param payload
      * @param communityIdx
      */
-    multiAttestPayload(currentPayload = [], communityIdx = 0) {
+    async multiAttestPayload(currentPayload = [], communityIdx = 0) {
         const payload = [...currentPayload];
-        const projectIdx = payload.push([this, this.payloadFor(communityIdx)]) - 1;
+        const projectIdx = payload.push([this, await this.payloadFor(communityIdx)]) - 1;
         if (this.details) {
-            payload.push([this.details, this.details.payloadFor(projectIdx)]);
+            payload.push([this.details, await this.details.payloadFor(projectIdx)]);
         }
         if (this.members?.length) {
-            this.members.forEach((m) => {
-                payload.push(...m.multiAttestPayload(payload, projectIdx));
-            });
+            await Promise.all(this.members.map(async (m) => payload.push(...(await m.multiAttestPayload(payload, projectIdx)))));
         }
         if (this.grants?.length) {
-            this.grants.forEach((g) => {
-                payload.push(...g.multiAttestPayload(payload, projectIdx));
-            });
+            await Promise.all(this.grants.map(async (g) => payload.push(...(await g.multiAttestPayload(payload, projectIdx)))));
         }
         return payload.slice(currentPayload.length, payload.length);
     }
     async attest(signer) {
-        const payload = this.multiAttestPayload();
+        const payload = await this.multiAttestPayload();
         const uids = await GapContract_1.GapContract.multiAttest(signer, payload.map((p) => p[1]));
         uids.forEach((uid, index) => {
             payload[index][0].uid = uid;

package/core/utils/get-ipfs-data.d.ts

@@ -0,0 +1 @@
+export declare function getIPFSData<T>(cid: string): Promise<T>;

package/core/utils/get-ipfs-data.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIPFSData = void 0;
+const axios_1 = __importDefault(require("axios"));
+async function getIPFSData(cid) {
+    try {
+        const { data } = await axios_1.default.get(`https://ipfs.io/ipfs/${cid}`);
+        return data;
+    }
+    catch (err) {
+        throw new Error(`Error to retrive data for CID: ${cid}`);
+    }
+}
+exports.getIPFSData = getIPFSData;

package/core/utils/index.d.ts

@@ -4,3 +4,4 @@ export * from './gql-queries';
 export * from './map-filter';
 export * from './serialize-bigint';
 export * from './to-unix';
+export * from './get-ipfs-data';

package/core/utils/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./gql-queries"), exports);
 __exportStar(require("./map-filter"), exports);
 __exportStar(require("./serialize-bigint"), exports);
 __exportStar(require("./to-unix"), exports);
+__exportStar(require("./get-ipfs-data"), exports);

package/package.json

@@ -3,7 +3,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.1.40",
+    "version": "0.2.1",
     "description": "Simple and easy interface between EAS and Karma GAP.",
     "main": "dist/index.js",
     "author": "KarmaHQ",
@@ -23,6 +23,7 @@
         "@types/sha256": "^0.2.0",
         "axios": "^1.4.0",
         "ethers": "5.7",
+        "nft.storage": "^7.1.1",
         "sha256": "^0.2.0",
         "simple-ts-job-runner": "^1.0.12"
     },