@show-karma/karma-gap-sdk 0.3.4 → 0.3.5

package/core/abi/CommunityResolverABI.json

@@ -0,0 +1,508 @@
+[
+    {
+        "inputs": [
+            {
+                "internalType": "contract IEAS",
+                "name": "eas",
+                "type": "address"
+            }
+        ],
+        "stateMutability": "nonpayable",
+        "type": "constructor"
+    },
+    {
+        "inputs": [],
+        "name": "AccessDenied",
+        "type": "error"
+    },
+    {
+        "inputs": [],
+        "name": "InsufficientValue",
+        "type": "error"
+    },
+    {
+        "inputs": [],
+        "name": "InvalidEAS",
+        "type": "error"
+    },
+    {
+        "inputs": [],
+        "name": "NotPayable",
+        "type": "error"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": false,
+                "internalType": "uint8",
+                "name": "version",
+                "type": "uint8"
+            }
+        ],
+        "name": "Initialized",
+        "type": "event"
+    },
+    {
+        "anonymous": false,
+        "inputs": [
+            {
+                "indexed": true,
+                "internalType": "address",
+                "name": "previousOwner",
+                "type": "address"
+            },
+            {
+                "indexed": true,
+                "internalType": "address",
+                "name": "newOwner",
+                "type": "address"
+            }
+        ],
+        "name": "OwnershipTransferred",
+        "type": "event"
+    },
+    {
+        "inputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "bytes32",
+                        "name": "uid",
+                        "type": "bytes32"
+                    },
+                    {
+                        "internalType": "bytes32",
+                        "name": "schema",
+                        "type": "bytes32"
+                    },
+                    {
+                        "internalType": "uint64",
+                        "name": "time",
+                        "type": "uint64"
+                    },
+                    {
+                        "internalType": "uint64",
+                        "name": "expirationTime",
+                        "type": "uint64"
+                    },
+                    {
+                        "internalType": "uint64",
+                        "name": "revocationTime",
+                        "type": "uint64"
+                    },
+                    {
+                        "internalType": "bytes32",
+                        "name": "refUID",
+                        "type": "bytes32"
+                    },
+                    {
+                        "internalType": "address",
+                        "name": "recipient",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "address",
+                        "name": "attester",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "bool",
+                        "name": "revocable",
+                        "type": "bool"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "data",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Attestation",
+                "name": "attestation",
+                "type": "tuple"
+            }
+        ],
+        "name": "attest",
+        "outputs": [
+            {
+                "internalType": "bool",
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "address",
+                "name": "attester",
+                "type": "address"
+            }
+        ],
+        "name": "canAttest",
+        "outputs": [
+            {
+                "internalType": "bool",
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "bytes32",
+                "name": "community",
+                "type": "bytes32"
+            },
+            {
+                "internalType": "address",
+                "name": "addr",
+                "type": "address"
+            }
+        ],
+        "name": "delist",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "bytes32",
+                "name": "community",
+                "type": "bytes32"
+            },
+            {
+                "internalType": "address",
+                "name": "addr",
+                "type": "address"
+            }
+        ],
+        "name": "enlist",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "initialize",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "bytes32",
+                "name": "community",
+                "type": "bytes32"
+            },
+            {
+                "internalType": "address",
+                "name": "addr",
+                "type": "address"
+            }
+        ],
+        "name": "isAdmin",
+        "outputs": [
+            {
+                "internalType": "bool",
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "isPayable",
+        "outputs": [
+            {
+                "internalType": "bool",
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "stateMutability": "pure",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "bytes32",
+                        "name": "uid",
+                        "type": "bytes32"
+                    },
+                    {
+                        "internalType": "bytes32",
+                        "name": "schema",
+                        "type": "bytes32"
+                    },
+                    {
+                        "internalType": "uint64",
+                        "name": "time",
+                        "type": "uint64"
+                    },
+                    {
+                        "internalType": "uint64",
+                        "name": "expirationTime",
+                        "type": "uint64"
+                    },
+                    {
+                        "internalType": "uint64",
+                        "name": "revocationTime",
+                        "type": "uint64"
+                    },
+                    {
+                        "internalType": "bytes32",
+                        "name": "refUID",
+                        "type": "bytes32"
+                    },
+                    {
+                        "internalType": "address",
+                        "name": "recipient",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "address",
+                        "name": "attester",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "bool",
+                        "name": "revocable",
+                        "type": "bool"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "data",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Attestation[]",
+                "name": "attestations",
+                "type": "tuple[]"
+            },
+            {
+                "internalType": "uint256[]",
+                "name": "values",
+                "type": "uint256[]"
+            }
+        ],
+        "name": "multiAttest",
+        "outputs": [
+            {
+                "internalType": "bool",
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "bytes32",
+                        "name": "uid",
+                        "type": "bytes32"
+                    },
+                    {
+                        "internalType": "bytes32",
+                        "name": "schema",
+                        "type": "bytes32"
+                    },
+                    {
+                        "internalType": "uint64",
+                        "name": "time",
+                        "type": "uint64"
+                    },
+                    {
+                        "internalType": "uint64",
+                        "name": "expirationTime",
+                        "type": "uint64"
+                    },
+                    {
+                        "internalType": "uint64",
+                        "name": "revocationTime",
+                        "type": "uint64"
+                    },
+                    {
+                        "internalType": "bytes32",
+                        "name": "refUID",
+                        "type": "bytes32"
+                    },
+                    {
+                        "internalType": "address",
+                        "name": "recipient",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "address",
+                        "name": "attester",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "bool",
+                        "name": "revocable",
+                        "type": "bool"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "data",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Attestation[]",
+                "name": "attestations",
+                "type": "tuple[]"
+            },
+            {
+                "internalType": "uint256[]",
+                "name": "values",
+                "type": "uint256[]"
+            }
+        ],
+        "name": "multiRevoke",
+        "outputs": [
+            {
+                "internalType": "bool",
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "owner",
+        "outputs": [
+            {
+                "internalType": "address",
+                "name": "",
+                "type": "address"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "renounceOwnership",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "components": [
+                    {
+                        "internalType": "bytes32",
+                        "name": "uid",
+                        "type": "bytes32"
+                    },
+                    {
+                        "internalType": "bytes32",
+                        "name": "schema",
+                        "type": "bytes32"
+                    },
+                    {
+                        "internalType": "uint64",
+                        "name": "time",
+                        "type": "uint64"
+                    },
+                    {
+                        "internalType": "uint64",
+                        "name": "expirationTime",
+                        "type": "uint64"
+                    },
+                    {
+                        "internalType": "uint64",
+                        "name": "revocationTime",
+                        "type": "uint64"
+                    },
+                    {
+                        "internalType": "bytes32",
+                        "name": "refUID",
+                        "type": "bytes32"
+                    },
+                    {
+                        "internalType": "address",
+                        "name": "recipient",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "address",
+                        "name": "attester",
+                        "type": "address"
+                    },
+                    {
+                        "internalType": "bool",
+                        "name": "revocable",
+                        "type": "bool"
+                    },
+                    {
+                        "internalType": "bytes",
+                        "name": "data",
+                        "type": "bytes"
+                    }
+                ],
+                "internalType": "struct Attestation",
+                "name": "attestation",
+                "type": "tuple"
+            }
+        ],
+        "name": "revoke",
+        "outputs": [
+            {
+                "internalType": "bool",
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "stateMutability": "payable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "address",
+                "name": "newOwner",
+                "type": "address"
+            }
+        ],
+        "name": "transferOwnership",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "version",
+        "outputs": [
+            {
+                "internalType": "string",
+                "name": "",
+                "type": "string"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "stateMutability": "payable",
+        "type": "receive"
+    }
+]

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

@@ -208,6 +208,13 @@ export declare class GAP extends Facade {
     static getProjectResolver(signer: SignerOrProvider & {
         getChainId?: () => Promise<number>;
     }, chainId?: number): Promise<ethers.Contract>;
+    /**
+     * Get the multicall contract
+     * @param signer
+     */
+    static getCommunityResolver(signer: SignerOrProvider & {
+        getChainId?: () => Promise<number>;
+    }, chainId?: number): Promise<ethers.Contract>;
     get schemas(): GapSchema[];
     /**
      * Defined if the transactions will be gasless or not.

package/core/class/GAP.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GAP = void 0;
 const MultiAttester_json_1 = __importDefault(require("../abi/MultiAttester.json"));
 const ProjectResolver_json_1 = __importDefault(require("../abi/ProjectResolver.json"));
+const CommunityResolverABI_json_1 = __importDefault(require("../abi/CommunityResolverABI.json"));
 const types_1 = require("../types");
 const Schema_1 = require("./Schema");
 const GapSchema_1 = require("./GapSchema");
@@ -195,6 +196,19 @@ class GAP extends types_1.Facade {
         const address = network.contracts.projectResolver;
         return new ethers_1.ethers.Contract(address, ProjectResolver_json_1.default, provider);
     }
+    /**
+     * Get the multicall contract
+     * @param signer
+     */
+    static async getCommunityResolver(signer, chainId) {
+        const currentChainId = chainId ||
+            Number((await signer.provider.getNetwork())?.chainId ||
+                (await signer.getChainId()));
+        const provider = chainId ? (0, get_web3_provider_1.getWeb3Provider)(chainId) : signer;
+        const network = Object.values(consts_1.Networks).find((n) => +n.chainId === Number(currentChainId));
+        const address = network.contracts.communityResolver;
+        return new ethers_1.ethers.Contract(address, CommunityResolverABI_json_1.default, provider);
+    }
     get schemas() {
         return this._schemas;
     }

package/core/class/GraphQL/Fetcher.d.ts

@@ -0,0 +1,132 @@
+import { Hex, IAttestation, TSchemaName } from "core/types";
+import { Attestation } from "../Attestation";
+import { Community, Grant, MemberOf, Milestone, Project } from "../entities";
+import { Grantee } from "../types/attestations";
+import { AxiosGQL } from "./AxiosGQL";
+export declare abstract class Fetcher extends AxiosGQL {
+    /**
+     * Fetch a single attestation by its UID.
+     * @param uid
+     */
+    abstract attestation<T = unknown>(uid: Hex): Promise<Attestation<T>>;
+    /**
+     * Fetch attestations of a schema.
+     * @param schemaName
+     * @param search if set, will search decodedDataJson by the value.
+     * @returns
+     */
+    abstract attestations(schemaName: TSchemaName, search?: string): Promise<IAttestation[]>;
+    /**
+     * Fetch attestations of a schema.
+     * @param schemaName
+     * @param recipient
+     * @returns
+     */
+    abstract attestationsOf(schemaName: TSchemaName, recipient: Hex): Promise<IAttestation[]>;
+    /**
+     * Fetch attestations of a schema for a specific recipient.
+     * @param schemaName
+     * @param recipient
+     * @returns
+     */
+    abstract attestationsTo(schemaName: TSchemaName, recipient: Hex): Promise<IAttestation[]>;
+    /**
+     * Fetch all available communities with details and grantees uids.
+     *
+     * If search is defined, will try to find communities by the search string.
+     * @param search
+     * @returns
+     */
+    abstract communities(search?: string): Promise<Community[]>;
+    /**
+     * Fetch a set of communities by their ids.
+     * @param uids
+     * @returns
+     */
+    abstract communitiesByIds(uids: Hex[]): Promise<Community[]>;
+    /**
+     * Fetch a community by its name with details, grants and milestones.
+     *
+     * It is possible that the resulted community is not the one you are looking for.
+     * @param name
+     * @returns
+     */
+    abstract communityBySlug(slug: string): Promise<Community>;
+    /**
+     * Fetch a community by its id. This method will also return the
+     * community details and projects.
+     */
+    abstract communityById(uid: Hex): Promise<Community>;
+    /**
+     * Fetch a project by its id.
+     * @param uid
+     * @returns
+     */
+    abstract projectById(uid: Hex): Promise<Project>;
+    /**
+     * Fetch a project by its slug.
+     * @param slug
+     * @returns
+     */
+    abstract projectBySlug(slug: string): Promise<Project>;
+    /**
+     * Fetch projects with details and members.
+     * @param name if set, will search by the name.
+     * @returns
+     */
+    abstract projects(name?: string): Promise<Project[]>;
+    /**
+     * Fetch projects with details and members.
+     * @param grantee the public address of the grantee
+     * @returns
+     */
+    abstract projectsOf(grantee: Hex): Promise<Project[]>;
+    /**
+     * Fetch Grantee with details and projects.
+     * @param address
+     * @param withProjects if true, will get grantee project details.
+     * @returns
+     */
+    abstract grantee(address: Hex): Promise<Grantee>;
+    /**
+     * Fetch all Grantees with details.
+     * @returns
+     */
+    abstract grantees(): Promise<Grantee[]>;
+    /**
+     * Fetches the grantes related to a grantee address (recipient).
+     * @param grantee grantee address
+     * @returns
+     */
+    abstract grantsOf(grantee: Hex, withCommunity?: boolean): Promise<Grant[]>;
+    /**
+     * Fetch grants for an array of projects with milestones.
+     * @param projects
+     * @returns
+     */
+    abstract grantsFor(projects: Project[], withCommunity?: boolean): Promise<Grant[]>;
+    /**
+     * Fetch a grants that belongs to a community.
+     * @param uid community uid
+     * @returns
+     */
+    abstract grantsByCommunity(uid: Hex): any;
+    /**
+     * Fetch all milestones related to an array of Grants.
+     * @param grants
+     * @returns
+     */
+    abstract milestonesOf(grants: Grant[]): Promise<Milestone[]>;
+    /**
+     * Bulk fetch members with details of an array of Projects.
+     * @param projects
+     * @returns
+     */
+    abstract membersOf(projects: Project[]): Promise<MemberOf[]>;
+    /**
+     * Check if a name is already in use.
+     * @param slug
+     * @returns
+     */
+    abstract slugExists(slug: string): Promise<boolean>;
+}