@show-karma/karma-gap-sdk 0.4.21 → 0.4.22

package/core/class/GAP.js

@@ -233,6 +233,10 @@ class GAP extends types_1.Facade {
         const currentChainId = chainId ||
             Number((await signer.provider.getNetwork())?.chainId ||
                 (await signer.getChainId()));
+        if (chainId && !rpcConfig) {
+            throw new Error(`rpcConfig is required when specifying chainId for cross-chain operations. ` +
+                `Either provide rpcConfig or omit chainId to use the signer's chain.`);
+        }
         const provider = chainId && rpcConfig
             ? (0, get_web3_provider_1.getWeb3Provider)(chainId, rpcConfig)
             : signer;
@@ -254,6 +258,10 @@ class GAP extends types_1.Facade {
         const currentChainId = chainId ||
             Number((await signer.provider.getNetwork())?.chainId ||
                 (await signer.getChainId()));
+        if (chainId && !rpcConfig) {
+            throw new Error(`rpcConfig is required when specifying chainId for cross-chain operations. ` +
+                `Either provide rpcConfig or omit chainId to use the signer's chain.`);
+        }
         const provider = chainId && rpcConfig
             ? (0, get_web3_provider_1.getWeb3Provider)(chainId, rpcConfig)
             : signer;

package/core/class/remote-storage/IpfsStorage.d.ts

@@ -0,0 +1,23 @@
+import { RemoteStorage } from "./RemoteStorage";
+import { TRemoteStorageOutput } from "core/types";
+export interface IpfsStorageOptions {
+    token: string;
+}
+export declare class IpfsStorage extends RemoteStorage {
+    private pinataJWTToken;
+    constructor(opts: IpfsStorageOptions, 
+    /**
+     * If set, will send request to another server instead of
+     * using the local instance
+     */
+    sponsor?: RemoteStorage["sponsor"]);
+    private assert;
+    save<T = unknown>(data: T): Promise<string>;
+    encode(data: string): TRemoteStorageOutput<string>;
+    get<T = unknown>(args: {
+        cid: string;
+    }): Promise<T>;
+    saveAndGetCID(data: any, pinataMetadata?: {
+        name: string;
+    }): Promise<any>;
+}

package/core/class/remote-storage/IpfsStorage.js

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IpfsStorage = void 0;
+const RemoteStorage_1 = require("./RemoteStorage");
+const SchemaError_1 = require("../SchemaError");
+const utils_1 = require("../../utils");
+const axios_1 = __importDefault(require("axios"));
+class IpfsStorage extends RemoteStorage_1.RemoteStorage {
+    constructor(opts, 
+    /**
+     * If set, will send request to another server instead of
+     * using the local instance
+     */
+    sponsor) {
+        super(0 /* STORAGE_TYPE.IPFS */, sponsor);
+        this.assert(opts);
+        this.pinataJWTToken = opts.token;
+    }
+    assert(opts) { }
+    async save(data) {
+        try {
+            const cid = await this.saveAndGetCID(data);
+            return cid;
+        }
+        catch (error) {
+            throw new SchemaError_1.RemoteStorageError("REMOTE_STORAGE_UPLOAD", `Error adding data to IPFS`);
+        }
+    }
+    encode(data) {
+        return { hash: data, storageType: this.storageType };
+    }
+    async get(args) {
+        return (0, utils_1.getIPFSData)(args.cid);
+    }
+    async saveAndGetCID(data, pinataMetadata = { name: "via karma-gap-sdk" }) {
+        try {
+            const res = await axios_1.default.post("https://api.pinata.cloud/pinning/pinJSONToIPFS", {
+                pinataContent: data,
+                pinataMetadata: pinataMetadata,
+            }, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${this.pinataJWTToken}`,
+                },
+            });
+            return res.data.IpfsHash;
+        }
+        catch (error) {
+            throw new SchemaError_1.RemoteStorageError("REMOTE_STORAGE_UPLOAD", `Error adding data to IPFS`);
+        }
+    }
+}
+exports.IpfsStorage = IpfsStorage;

package/core/class/remote-storage/RemoteStorage.d.ts

@@ -0,0 +1,41 @@
+import { STORAGE_TYPE, TRemoteStorageOutput } from 'core/types';
+interface SponsoredRemote {
+    url: string;
+    responseParser: (response: any) => string;
+}
+export declare abstract class RemoteStorage<C = unknown> {
+    protected client: C;
+    readonly storageType: number;
+    readonly sponsor?: SponsoredRemote;
+    constructor(storageType: STORAGE_TYPE, 
+    /**
+     * If set, will try to POST request to another server instead of
+     * using the local instance.
+     *
+     * > If a response parser is not set, it will try to get { cid: string }.
+     */
+    sponsor: SponsoredRemote);
+    /**
+     * Try to save data to remote storage and return the CID.
+     * IF sponsorUrl is set, this method will be automatically
+     * intercepted and will send a POST request to the sponsorUrl
+     * with the contents: `{ data: T, type: "<AttestationType>" }`
+     */
+    abstract save<T = unknown>(data: T, schemaName: string): Promise<string>;
+    /**
+     * Encodes the data according to the remote storage type parameters
+     * OR returns the data as is if no encoding is required
+     */
+    abstract encode(data: unknown): TRemoteStorageOutput;
+    /**
+     * Get data from Remote Storage
+     */
+    abstract get<T = unknown>(args: unknown): Promise<T>;
+    /**
+     * If sponsorUrl is set, intercept the save method and send a POST request
+     * to the sponsorUrl instead of using the local instance.
+     * @returns
+     */
+    private interceptRemoteStorage;
+}
+export {};

package/core/class/remote-storage/RemoteStorage.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoteStorage = void 0;
+const axios_1 = __importDefault(require("axios"));
+class RemoteStorage {
+    constructor(storageType, 
+    /**
+     * If set, will try to POST request to another server instead of
+     * using the local instance.
+     *
+     * > If a response parser is not set, it will try to get { cid: string }.
+     */
+    sponsor) {
+        this.storageType = storageType;
+        this.sponsor = sponsor;
+        this.interceptRemoteStorage();
+    }
+    /**
+     * If sponsorUrl is set, intercept the save method and send a POST request
+     * to the sponsorUrl instead of using the local instance.
+     * @returns
+     */
+    interceptRemoteStorage() {
+        if (!this.sponsor?.url)
+            return;
+        this.save = async (data, schemaName) => {
+            const { data: response } = await axios_1.default.post(this.sponsor.url, {
+                data: data,
+                type: schemaName,
+            });
+            return this.sponsor.responseParser?.(response) || response.cid;
+        };
+    }
+}
+exports.RemoteStorage = RemoteStorage;

package/core/consts.js

@@ -435,16 +435,43 @@ exports.Networks = {
             Community: "0x3c2231024f4f17f3718b5bd9ed9ff29cc323dea5449f9ceba11a9888bfbdd0e1",
             Details: "0x9895e82115987d8e3e02b35ced92e6a0509293890333f58f50ec291b34853dac",
             Grant: "0x7afa603a89cee2d8f93d30007e2c64efddc6509fd76aa95d2ccd97b6e34acc71",
-            GrantVerified: "0xf45fdf2c064073f0623416571c2746085d785cde5a57fd0696ff88bdf78bcbdc",
+            GrantVerified: "0x837ae97827bdec74d0c8d755331634f730bb8ad00702099e9a6a2bbe193b1511",
             MemberOf: "0xb4186a2401f40a4c78768941ef9140e1fbe5fe595053a65d44f31d6df180b712",
-            MilestoneApproved: "0xf45fdf2c064073f0623416571c2746085d785cde5a57fd0696ff88bdf78bcbdc",
-            MilestoneCompleted: "0xf45fdf2c064073f0623416571c2746085d785cde5a57fd0696ff88bdf78bcbdc",
-            GrantUpdateStatus: "0xf45fdf2c064073f0623416571c2746085d785cde5a57fd0696ff88bdf78bcbdc",
+            MilestoneApproved: "0x837ae97827bdec74d0c8d755331634f730bb8ad00702099e9a6a2bbe193b1511",
+            MilestoneCompleted: "0x837ae97827bdec74d0c8d755331634f730bb8ad00702099e9a6a2bbe193b1511",
+            GrantUpdateStatus: "0x837ae97827bdec74d0c8d755331634f730bb8ad00702099e9a6a2bbe193b1511",
             Project: "0x672fbaa8a1fb6e1f73a89c84a8e97a808da0750003a9d1d18aba3d39fa165945",
-            ProjectUpdateStatus: "0xf45fdf2c064073f0623416571c2746085d785cde5a57fd0696ff88bdf78bcbdc",
-            ProjectMilestoneStatus: "0xf45fdf2c064073f0623416571c2746085d785cde5a57fd0696ff88bdf78bcbdc",
+            ProjectUpdateStatus: "0x837ae97827bdec74d0c8d755331634f730bb8ad00702099e9a6a2bbe193b1511",
+            ProjectMilestoneStatus: "0x837ae97827bdec74d0c8d755331634f730bb8ad00702099e9a6a2bbe193b1511",
             ContributorProfile: null
         },
+        oldSchemas: [
+            {
+                name: "GrantVerified",
+                uid: "0xf45fdf2c064073f0623416571c2746085d785cde5a57fd0696ff88bdf78bcbdc",
+                raw: oldStatusSchema
+            },
+            {
+                name: "MilestoneApproved",
+                uid: "0xf45fdf2c064073f0623416571c2746085d785cde5a57fd0696ff88bdf78bcbdc",
+                raw: oldStatusSchema
+            },
+            {
+                name: "MilestoneCompleted",
+                uid: "0xf45fdf2c064073f0623416571c2746085d785cde5a57fd0696ff88bdf78bcbdc",
+                raw: oldStatusSchema
+            },
+            {
+                name: "GrantUpdateStatus",
+                uid: "0xf45fdf2c064073f0623416571c2746085d785cde5a57fd0696ff88bdf78bcbdc",
+                raw: oldStatusSchema
+            },
+            {
+                name: "ProjectUpdateStatus",
+                uid: "0xf45fdf2c064073f0623416571c2746085d785cde5a57fd0696ff88bdf78bcbdc",
+                raw: oldStatusSchema
+            },
+        ]
     },
     "base": {
         chainId: 8453,
@@ -462,16 +489,43 @@ exports.Networks = {
             Community: "0x721c17b065dccc5c916e0c2708d0ef50f1810591b76d0402ff6fe5accbd8488f",
             Details: "0x70a3f615f738fc6a4f56100692ada93d947c028b840940d97af7e7d6f0fa0577",
             Grant: "0x12837231f48acbca4e1e7f4416f684f3353bd4d71d4f03a09d29e5ffa6f21a50",
-            GrantVerified: "0xb7eab95609c821624edc3c3a5a6c787bdc9da6c91393a967fb22b0e274c619dd",
+            GrantVerified: "0x535417d864b95c33fc0289082617b4004737a12c276ee27effd9f54491942934",
             MemberOf: "0x7fbb8a65924d8ad2ae12356e04b1418043e8361ba3b1b6c917de2e23df3ec81c",
-            MilestoneApproved: "0xb7eab95609c821624edc3c3a5a6c787bdc9da6c91393a967fb22b0e274c619dd",
-            MilestoneCompleted: "0xb7eab95609c821624edc3c3a5a6c787bdc9da6c91393a967fb22b0e274c619dd",
-            GrantUpdateStatus: "0xb7eab95609c821624edc3c3a5a6c787bdc9da6c91393a967fb22b0e274c619dd",
+            MilestoneApproved: "0x535417d864b95c33fc0289082617b4004737a12c276ee27effd9f54491942934",
+            MilestoneCompleted: "0x535417d864b95c33fc0289082617b4004737a12c276ee27effd9f54491942934",
+            GrantUpdateStatus: "0x535417d864b95c33fc0289082617b4004737a12c276ee27effd9f54491942934",
             Project: "0x5a6b36ac106c74541efad39f8430751dd843bb78729bf7ffc296eca4cbb8d8f3",
-            ProjectUpdateStatus: "0xb7eab95609c821624edc3c3a5a6c787bdc9da6c91393a967fb22b0e274c619dd",
-            ProjectMilestoneStatus: "0xb7eab95609c821624edc3c3a5a6c787bdc9da6c91393a967fb22b0e274c619dd",
+            ProjectUpdateStatus: "0x535417d864b95c33fc0289082617b4004737a12c276ee27effd9f54491942934",
+            ProjectMilestoneStatus: "0x535417d864b95c33fc0289082617b4004737a12c276ee27effd9f54491942934",
             ContributorProfile: "0xdfb8ad353dd144235bd45ae38803db6ffe066081770370f603709b9dec9ba8ff"
         },
+        oldSchemas: [
+            {
+                name: "GrantVerified",
+                uid: "0xb7eab95609c821624edc3c3a5a6c787bdc9da6c91393a967fb22b0e274c619dd",
+                raw: oldStatusSchema
+            },
+            {
+                name: "MilestoneApproved",
+                uid: "0xb7eab95609c821624edc3c3a5a6c787bdc9da6c91393a967fb22b0e274c619dd",
+                raw: oldStatusSchema
+            },
+            {
+                name: "MilestoneCompleted",
+                uid: "0xb7eab95609c821624edc3c3a5a6c787bdc9da6c91393a967fb22b0e274c619dd",
+                raw: oldStatusSchema
+            },
+            {
+                name: "GrantUpdateStatus",
+                uid: "0xb7eab95609c821624edc3c3a5a6c787bdc9da6c91393a967fb22b0e274c619dd",
+                raw: oldStatusSchema
+            },
+            {
+                name: "ProjectUpdateStatus",
+                uid: "0xb7eab95609c821624edc3c3a5a6c787bdc9da6c91393a967fb22b0e274c619dd",
+                raw: oldStatusSchema
+            },
+        ]
     },
     "polygon": {
         chainId: 137,
@@ -489,16 +543,43 @@ exports.Networks = {
             Community: "0x884bd33b1d7fce5c637e85aef538e83a8a87157d7df2d357e6cc8d4c59b89400",
             Details: "0x2038ec9d8d0ab60324065aa0b4961d3f93d725f1c71f67b9f1ef209114c75f7f",
             Grant: "0x2cedad5cda259c921f3380eedd5920be86a7dfe9496848cc8afc7f01159dfd65",
-            GrantVerified: "0xe4b229d7051c27bb64cca0d29d92377143e6d5b9e076416e997c38d4cb40a399",
+            GrantVerified: "0xefa705f5baaf91745bb4706fa4aa55156c5d9c3cd6834fcc4912bcb51ad5bea3",
             MemberOf: "0x2cfa4adacb1efcd0ff408d749fd12bb36cd5f88aa0822f633962d4bd5c8023aa",
-            MilestoneApproved: "0xe4b229d7051c27bb64cca0d29d92377143e6d5b9e076416e997c38d4cb40a399",
-            MilestoneCompleted: "0xe4b229d7051c27bb64cca0d29d92377143e6d5b9e076416e997c38d4cb40a399",
-            GrantUpdateStatus: "0xe4b229d7051c27bb64cca0d29d92377143e6d5b9e076416e997c38d4cb40a399",
+            MilestoneApproved: "0xefa705f5baaf91745bb4706fa4aa55156c5d9c3cd6834fcc4912bcb51ad5bea3",
+            MilestoneCompleted: "0xefa705f5baaf91745bb4706fa4aa55156c5d9c3cd6834fcc4912bcb51ad5bea3",
+            GrantUpdateStatus: "0xefa705f5baaf91745bb4706fa4aa55156c5d9c3cd6834fcc4912bcb51ad5bea3",
             Project: "0x7f0e4ac5f7cbe2a39af317b46bad7e86b053f76109c364d197447d9da34e821a",
-            ProjectUpdateStatus: "0xe4b229d7051c27bb64cca0d29d92377143e6d5b9e076416e997c38d4cb40a399",
-            ProjectMilestoneStatus: "0xe4b229d7051c27bb64cca0d29d92377143e6d5b9e076416e997c38d4cb40a399",
+            ProjectUpdateStatus: "0xefa705f5baaf91745bb4706fa4aa55156c5d9c3cd6834fcc4912bcb51ad5bea3",
+            ProjectMilestoneStatus: "0xefa705f5baaf91745bb4706fa4aa55156c5d9c3cd6834fcc4912bcb51ad5bea3",
             ContributorProfile: "0x281f0afbb0313c6ff851400c4ed317fe9741be75e7e20c337dfd403059523bea"
         },
+        oldSchemas: [
+            {
+                name: "GrantVerified",
+                uid: "0xe4b229d7051c27bb64cca0d29d92377143e6d5b9e076416e997c38d4cb40a399",
+                raw: oldStatusSchema
+            },
+            {
+                name: "MilestoneApproved",
+                uid: "0xe4b229d7051c27bb64cca0d29d92377143e6d5b9e076416e997c38d4cb40a399",
+                raw: oldStatusSchema
+            },
+            {
+                name: "MilestoneCompleted",
+                uid: "0xe4b229d7051c27bb64cca0d29d92377143e6d5b9e076416e997c38d4cb40a399",
+                raw: oldStatusSchema
+            },
+            {
+                name: "GrantUpdateStatus",
+                uid: "0xe4b229d7051c27bb64cca0d29d92377143e6d5b9e076416e997c38d4cb40a399",
+                raw: oldStatusSchema
+            },
+            {
+                name: "ProjectUpdateStatus",
+                uid: "0xe4b229d7051c27bb64cca0d29d92377143e6d5b9e076416e997c38d4cb40a399",
+                raw: oldStatusSchema
+            },
+        ]
     },
 };
 const DetailsSchema = [{ type: "string", name: "json", value: null }];

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,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIPFSData = getIPFSData;
+const axios_1 = __importDefault(require("axios"));
+async function getIPFSData(cid) {
+    try {
+        const { data } = await axios_1.default.get(`https://ipfs.io/ipfs/${cid}`, {
+            timeout: 5000,
+        });
+        return data;
+    }
+    catch (err) {
+        console.error(err);
+        throw new Error(`Error to retrive data for CID: ${cid}`);
+    }
+}

package/package.json

@@ -3,7 +3,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.4.21",
+    "version": "0.4.22",
     "description": "Simple and easy interface between EAS and Karma GAP.",
     "main": "./index.js",
     "author": "KarmaHQ",