@show-karma/karma-gap-sdk 0.4.24 → 0.4.25

package/core/class/GAP.js

@@ -233,11 +233,13 @@ 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
+        // Use rpcConfig provider if available for the target chain,
+        // otherwise fall back to signer (which may already be a provider
+        // for the correct chain, e.g. when created by the frontend).
+        const rpcUrl = chainId && rpcConfig
+            ? rpcConfig[chainId]
+            : undefined;
+        const provider = rpcUrl
             ? (0, get_web3_provider_1.getWeb3Provider)(chainId, rpcConfig)
             : signer;
         const network = Object.values(consts_1.Networks).find((n) => +n.chainId === Number(currentChainId));
@@ -258,11 +260,13 @@ 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
+        // Use rpcConfig provider if available for the target chain,
+        // otherwise fall back to signer (which may already be a provider
+        // for the correct chain, e.g. when created by the frontend).
+        const rpcUrl = chainId && rpcConfig
+            ? rpcConfig[chainId]
+            : undefined;
+        const provider = rpcUrl
             ? (0, get_web3_provider_1.getWeb3Provider)(chainId, rpcConfig)
             : signer;
         const network = Object.values(consts_1.Networks).find((n) => +n.chainId === Number(currentChainId));

package/core/class/karma-indexer/api/GapIndexerApi.d.ts

@@ -2,72 +2,72 @@ import { AxiosGQL } from "../../GraphQL/AxiosGQL";
 import { Hex, IAttestationResponse, ICommunityResponse, ICommunityAdminsResponse, IGrantResponse, IProjectResponse, ISearchResponse, IProjectMilestoneResponse, ITrackResponse, ITrackAssignmentResponse, IProjectTrackResponse } from "./types";
 export declare class GapIndexerApi extends AxiosGQL {
     constructor(url: string);
-    attestation(uid: Hex): Promise<import("axios").AxiosResponse<IAttestationResponse, any, {}>>;
-    attestations(schemaUID: string, search?: string): Promise<import("axios").AxiosResponse<IAttestationResponse[], any, {}>>;
-    attestationsOf(schemaUID: string, attester: Hex): Promise<import("axios").AxiosResponse<IAttestationResponse[], any, {}>>;
+    attestation(uid: Hex): Promise<import("axios").AxiosResponse<IAttestationResponse, any>>;
+    attestations(schemaUID: string, search?: string): Promise<import("axios").AxiosResponse<IAttestationResponse[], any>>;
+    attestationsOf(schemaUID: string, attester: Hex): Promise<import("axios").AxiosResponse<IAttestationResponse[], any>>;
     /**
      * Community
      */
-    communities(search?: string): Promise<import("axios").AxiosResponse<ICommunityResponse[], any, {}>>;
-    communitiesOf(address: Hex, withGrants: boolean): Promise<import("axios").AxiosResponse<ICommunityResponse[], any, {}>>;
-    adminOf(address: Hex): Promise<import("axios").AxiosResponse<ICommunityResponse[], any, {}>>;
-    communityBySlug(slug: string): Promise<import("axios").AxiosResponse<ICommunityResponse, any, {}>>;
-    communityAdmins(uid: Hex): Promise<import("axios").AxiosResponse<ICommunityAdminsResponse, any, {}>>;
+    communities(search?: string): Promise<import("axios").AxiosResponse<ICommunityResponse[], any>>;
+    communitiesOf(address: Hex, withGrants: boolean): Promise<import("axios").AxiosResponse<ICommunityResponse[], any>>;
+    adminOf(address: Hex): Promise<import("axios").AxiosResponse<ICommunityResponse[], any>>;
+    communityBySlug(slug: string): Promise<import("axios").AxiosResponse<ICommunityResponse, any>>;
+    communityAdmins(uid: Hex): Promise<import("axios").AxiosResponse<ICommunityAdminsResponse, any>>;
     /**
      * Project
      */
-    projectBySlug(slug: string): Promise<import("axios").AxiosResponse<IProjectResponse, any, {}>>;
-    search(query: string): Promise<import("axios").AxiosResponse<ISearchResponse, any, {}>>;
-    searchProjects(query: string): Promise<import("axios").AxiosResponse<IProjectResponse[], any, {}>>;
-    projects(name?: string): Promise<import("axios").AxiosResponse<IProjectResponse[], any, {}>>;
-    projectsOf(grantee: Hex): Promise<import("axios").AxiosResponse<IProjectResponse[], any, {}>>;
-    projectMilestones(uidOrSlug: string): Promise<import("axios").AxiosResponse<IProjectMilestoneResponse[], any, {}>>;
+    projectBySlug(slug: string): Promise<import("axios").AxiosResponse<IProjectResponse, any>>;
+    search(query: string): Promise<import("axios").AxiosResponse<ISearchResponse, any>>;
+    searchProjects(query: string): Promise<import("axios").AxiosResponse<IProjectResponse[], any>>;
+    projects(name?: string): Promise<import("axios").AxiosResponse<IProjectResponse[], any>>;
+    projectsOf(grantee: Hex): Promise<import("axios").AxiosResponse<IProjectResponse[], any>>;
+    projectMilestones(uidOrSlug: string): Promise<import("axios").AxiosResponse<IProjectMilestoneResponse[], any>>;
     /**
      * Grantee
      */
-    grantee(address: Hex): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    grantee(address: Hex): Promise<import("axios").AxiosResponse<any, any>>;
     grantees(): Promise<import("axios").AxiosResponse<{
         [key: `0x${string}`]: {
             grants: number;
             projects: number;
         };
-    }, any, {}>>;
+    }, any>>;
     /**
      * Grant
      */
-    grantsOf(grantee: Hex, withCommunity?: boolean): Promise<import("axios").AxiosResponse<IGrantResponse[], any, {}>>;
-    grantsFor(uid: string, withCommunity?: boolean): Promise<import("axios").AxiosResponse<IGrantResponse[], any, {}>>;
-    grantsForExtProject(projectExtId: string): Promise<import("axios").AxiosResponse<IGrantResponse[], any, {}>>;
-    grantBySlug(slug: Hex): Promise<import("axios").AxiosResponse<IGrantResponse, any, {}>>;
+    grantsOf(grantee: Hex, withCommunity?: boolean): Promise<import("axios").AxiosResponse<IGrantResponse[], any>>;
+    grantsFor(uid: string, withCommunity?: boolean): Promise<import("axios").AxiosResponse<IGrantResponse[], any>>;
+    grantsForExtProject(projectExtId: string): Promise<import("axios").AxiosResponse<IGrantResponse[], any>>;
+    grantBySlug(slug: Hex): Promise<import("axios").AxiosResponse<IGrantResponse, any>>;
     grantsByCommunity(uid: Hex, page?: number, pageLimit?: number): Promise<import("axios").AxiosResponse<{
         data: IGrantResponse[];
-    }, any, {}>>;
+    }, any>>;
     /**
      * Milestone
      */
-    milestonesOf(uid: Hex): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    milestonesOf(uid: Hex): Promise<import("axios").AxiosResponse<any, any>>;
     slugExists(slug: string): Promise<boolean>;
     /**
      * Tracks
      */
-    getTracks(communityUID: string, includeArchived?: boolean): Promise<import("axios").AxiosResponse<ITrackResponse[], any, {}>>;
-    getTrackById(id: string): Promise<import("axios").AxiosResponse<ITrackResponse, any, {}>>;
+    getTracks(communityUID: string, includeArchived?: boolean): Promise<import("axios").AxiosResponse<ITrackResponse[], any>>;
+    getTrackById(id: string): Promise<import("axios").AxiosResponse<ITrackResponse, any>>;
     createTrack(data: {
         name: string;
         description?: string;
         communityUID: string;
-    }): Promise<import("axios").AxiosResponse<ITrackResponse, any, {}>>;
+    }): Promise<import("axios").AxiosResponse<ITrackResponse, any>>;
     updateTrack(id: string, data: {
         name?: string;
         description?: string;
         communityUID?: string;
-    }): Promise<import("axios").AxiosResponse<ITrackResponse, any, {}>>;
-    archiveTrack(id: string): Promise<import("axios").AxiosResponse<ITrackResponse, any, {}>>;
-    assignTracksToProgram(programId: string, trackIds: string[]): Promise<import("axios").AxiosResponse<ITrackAssignmentResponse[], any, {}>>;
-    unassignTrackFromProgram(programId: string, trackId: string): Promise<import("axios").AxiosResponse<ITrackAssignmentResponse, any, {}>>;
-    getTracksForProgram(programId: string): Promise<import("axios").AxiosResponse<ITrackResponse[], any, {}>>;
-    getTracksForProject(projectId: string, programId: string, activeOnly?: boolean): Promise<import("axios").AxiosResponse<ITrackResponse[], any, {}>>;
-    assignTracksToProject(projectId: string, programId: string, trackIds: string[]): Promise<import("axios").AxiosResponse<any[], any, {}>>;
-    unassignTracksFromProject(projectId: string, programId: string, trackIds: string[]): Promise<import("axios").AxiosResponse<any[], any, {}>>;
-    getProjectsByTrack(communityId: string, programId: string, trackId?: string): Promise<import("axios").AxiosResponse<IProjectTrackResponse[], any, {}>>;
+    }): Promise<import("axios").AxiosResponse<ITrackResponse, any>>;
+    archiveTrack(id: string): Promise<import("axios").AxiosResponse<ITrackResponse, any>>;
+    assignTracksToProgram(programId: string, trackIds: string[]): Promise<import("axios").AxiosResponse<ITrackAssignmentResponse[], any>>;
+    unassignTrackFromProgram(programId: string, trackId: string): Promise<import("axios").AxiosResponse<ITrackAssignmentResponse, any>>;
+    getTracksForProgram(programId: string): Promise<import("axios").AxiosResponse<ITrackResponse[], any>>;
+    getTracksForProject(projectId: string, programId: string, activeOnly?: boolean): Promise<import("axios").AxiosResponse<ITrackResponse[], any>>;
+    assignTracksToProject(projectId: string, programId: string, trackIds: string[]): Promise<import("axios").AxiosResponse<any[], any>>;
+    unassignTracksFromProject(projectId: string, programId: string, trackIds: string[]): Promise<import("axios").AxiosResponse<any[], any>>;
+    getProjectsByTrack(communityId: string, programId: string, trackId?: string): Promise<import("axios").AxiosResponse<IProjectTrackResponse[], any>>;
 }

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/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.24",
+    "version": "0.4.25",
     "description": "Simple and easy interface between EAS and Karma.",
     "main": "./index.js",
     "author": "KarmaHQ",