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

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/contract/MultiAttest.d.ts

@@ -0,0 +1,10 @@
+import { SignerOrProvider } from "@ethereum-attestation-service/eas-sdk/dist/transaction";
+import { Hex, MultiAttestData } from "core/types";
+export declare class MultiAttest {
+    /**
+     * Performs a referenced multi attestation.
+     *
+     * @returns an array with the attestation UIDs.
+     */
+    static send(signer: SignerOrProvider, payload: MultiAttestData[]): Promise<Hex[]>;
+}

package/core/class/contract/MultiAttest.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiAttest = void 0;
+const GAP_1 = require("../GAP");
+class MultiAttest {
+    /**
+     * Performs a referenced multi attestation.
+     *
+     * @returns an array with the attestation UIDs.
+     */
+    static async send(signer, payload) {
+        const contract = GAP_1.GAP.getMulticall(signer);
+        const tx = await contract.functions.multiSequentialAttest(payload);
+        const result = await tx.wait?.();
+        const attestations = result.logs?.map((m) => m.data);
+        return attestations;
+    }
+}
+exports.MultiAttest = MultiAttest;

package/core/consts.js

@@ -20,40 +20,6 @@ exports.zeroAddress = exports.nullResolver;
  * The networks that are supported by the EAS
  */
 exports.Networks = {
-    // mainnet: {
-    //   url: "https://easscan.org/graphql",
-    //   chainId: 1,
-    //   contracts: {
-    //     eas: "0xA1207F3BBa224E2c9c3c6D5aF63D0eb1582Ce587",
-    //     schema: "0xA7b39296258348C78294F95B872b282326A97BDF",
-    //     multicall:''
-    //   },
-    //   schemas: {
-    //     Grant: "",
-    //     GrantVerified: "",
-    //     MemberOf: "",
-    //     MilestoneApproved: "",
-    //     MilestoneCompleted: "",
-    //     Project: "",
-    //   },
-    // },
-    // "base-goerli": {
-    //   chainId: 5,
-    //   url: "https://base-goerli.easscan.org/graphql",
-    //   contracts: {
-    //     eas: "0xAcfE09Fd03f7812F022FBf636700AdEA18Fd2A7A",
-    //     schema: "0x720c2bA66D19A725143FBf5fDC5b4ADA2742682E",
-    //     multicall:''
-    //   },
-    //   schemas: {
-    //     Grant: "",
-    //     GrantVerified: "",
-    //     MemberOf: "",
-    //     MilestoneApproved: "",
-    //     MilestoneCompleted: "",
-    //     Project: "",
-    //   },
-    // },
     optimism: {
         chainId: 10,
         url: 'https://optimism.easscan.org/graphql',
@@ -63,6 +29,7 @@ exports.Networks = {
             schema: '0x4200000000000000000000000000000000000020',
             multicall: '0xd2eD366393FDfd243931Fe48e9fb65A192B0018c',
             projectResolver: '0x7177AdC0f924b695C0294A40C4C5FEFf5EE1E141',
+            communityResolver: '0x6dC1D6b864e8BEf815806f9e4677123496e12026',
         },
         schemas: {
             Community: '0x721c17b065dccc5c916e0c2708d0ef50f1810591b76d0402ff6fe5accbd8488f',
@@ -84,6 +51,7 @@ exports.Networks = {
             schema: '0x4200000000000000000000000000000000000020',
             multicall: '0x5D5a8032b2FA06652804c33F60DcEA00e389B732',
             projectResolver: '0xbCf8910Bc3971eA59D93256357b76E846CF2e1F8',
+            communityResolver: '0xa09369bDE7E4403a9C821AffA00E649cF85Ef09e',
         },
         schemas: {
             Community: '0xc1aade58410b3fd807c19845181996721248459c5f042284f27d21cec12a38d1',
@@ -106,6 +74,7 @@ exports.Networks = {
             schema: '0xA310da9c5B885E7fb3fbA9D66E9Ba6Df512b78eB',
             multicall: '0x6dC1D6b864e8BEf815806f9e4677123496e12026',
             projectResolver: '0x28BE0b0515be8BB8822aF1467A6613795E74717b',
+            communityResolver: '0xD534C4704F82494aBbc901560046fB62Ac63E9C4',
         },
         schemas: {
             Community: '0xc604f0661cfd522583835ed2b2c644b80e068139d287f93c7f1680888894bacc',
@@ -127,6 +96,7 @@ exports.Networks = {
             schema: '0x0a7E2Ff54e76B8E6659aedc9103FB21c038050D0',
             multicall: '0xec8d7BFe344790FD860920C41B46B259c005727A',
             projectResolver: '0x099787D5a5aC92779A519CfD925ACB0Dc7E8bd23',
+            communityResolver: '0xa9E55D9F52d7B47792d2Db15F6A9674c56ccc5C9',
         },
         schemas: {
             Community: '0xf3d790c7fdab6c1b1f25ffcc9289e5be2792eb596d2851a4d059c8aae1bc8b2e',

package/core/types.d.ts

@@ -67,6 +67,7 @@ export interface EASNetworkConfig {
         schema: Hex;
         multicall: Hex;
         projectResolver: Hex;
+        communityResolver: Hex;
     };
     /**
      * A tuple containing the schema name and it's UID for that network

package/package.json

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

package/readme.md

@@ -5,20 +5,25 @@
 1. [What is GAP SDK?](#1-what-is-gap-sdk)
 2. [Architecture](#2-architecture)
 3. [Getting started](#3-getting-started)
-4. [Fetching Entities](#4-getting-attestations)
-5. [Creating entities in the Frontend](#5-attesting-data-in-a-frontend)
-6. [Creating entities in the Backend](#6-attesting-data-in-a-backend)
+4. [Getting attestations](#4-getting-attestations)
+5. [Attesting data in a Frontend](#5-attesting-data-in-a-frontend)
+6. [Attesting data in a Backend](#6-attesting-data-in-a-backend)
 7. [Gasless transactions with Gelato](#7-gasless-transactions-with-gelato)
 8. [Speed up requests with a Custom API](#8-custom-api)
 
 ## 1. What is GAP SDK?
 
-The GAP SDK is a library for easy integration with [Grantee Accountability Protocol](https://gap.karmahq.xyz). Using this library, you will be able to:
+The GAP SDK is a tool that provides ease of use when working with the [accountability protocol](https://gap.karmahq.xyz). Its core is developed to support customization\* and flexibility.
 
-- Fetch and display Communities, Projects, Members, Grants, Milestones, and all of their dependencies.
-- Create, update and delete all of the above.
+Through this tool, you will be able to:
+
+- Get and display Communities, Projects, Members, Grants, Milestones, and all of their dependencies.
+- Perform attestations for all of the above.
+- Execute revocations for all of the above.
 - Utilize gasless transactions with [Gelato Relay](https://relay.gelato.network).
-- Utilize custom API endpoints to speed up queries instead of accessing data onchain through RPC end points.
+- Harness a custom API to expedite requests, as it adheres to the defined parameters.
+
+> \* We are currently working on enhancing the ability to customize this API through tools that facilitate the modification of parameters. This feature may appear confusing if you attempt to modify certain parameters, such as default schemas and contracts, at the moment.
 
 ## 2. Architecture
 
@@ -40,13 +45,13 @@ Here's an example of how all these modules work together when retrieving Project
 
 ![img](docs/images/dfd-get-projects.png)
 
-In this diagram, you can already discern the benefits of using a Custom API to obtain data from the network and construct your own indexer, as opposed to relying on EAS's GraphQL API. We will delve into this further in [Section 8](#8-custom-api).
+In this diagram, you can already discern the benefits of using a Custom API to obtain data from the network and construct your own indexer, as opposed to relying on EAS's GraphQL API. We will delve into this further in [Chapter 8](#8-custom-api).
 
 > **Note**: GAP currently does not fully support multichain, and creating more than one instance can result in unexpected errors when using the fetcher. This feature is currently under development.
 
 ### Attestations
 
-All the data in the protocol is stored as attestations using [EAS](https://attest.sh). Attestations are categorized into various types of entities to establish a relationship between them and enable users to modify their attestation details without losing references to the main attestation. As a result, entities like community, project, grant, and members require two attestations: the first defines the entity, and the second defines its details. Due to this structure, all these entities will include a `details` property that contains all the data inserted into that attestation. For example:
+Attestations are categorized into various types of entities to establish a relationship between them and enable users to modify their attestation details without losing references to the main attestation. As a result, entities like community, project, grant, and members require two attestations: the first defines the entity, and the second defines its details. Due to this structure, all these entities will include a `details` property that contains all the data inserted into that attestation. For example:
 
 ```ts
 import { Project } from '@show-karma/karma-gap-sdk';
@@ -82,8 +87,8 @@ import { GAP } from '@show-karma/karma-gap-sdk';
 
 const gap = GAP.createClient({
   network: 'optimism-goerli', // sepolia, optimism,
-  // apiClient: custom api client, see Section 8;
-  // gelatoOpts: for gasless transactions, see Section 7;
+  // apiClient: custom api client, see it on Chap. 8;
+  // gelatoOpts: for gasless transactions, see it on Chap. 7;
 });
 
 export default gap;
@@ -104,7 +109,7 @@ export class MyCustomApiClient extends Fetcher {
 }
 ```
 
-[..] Then you can use it on GapClient. More details about how to implement a custom fetcher on [Section 8](#8-custom-api).
+[..] Then you can use it on GapClient. More details about how to implement a custom fetcher on [Chapter 8](#8-custom-api).
 
 ```ts
 // gap.client.ts;
@@ -115,7 +120,6 @@ const gap = GAP.createClient({
   network: 'optimism-goerli', // sepolia, optimism,
   apiClient: new MyCustomApiClient('https://my-custom-api.mydomain.com'),
   // gelatoOpts: for gasless transactions, see it on Chap. 7;
-  // ipfsKey: for cheaper attestations;
 });
 
 export default gap;
@@ -123,11 +127,9 @@ export default gap;
 
 The `gelatoOpts` option is used when developers aim to provide gasless transactions for a better user experience. For more details about this feature, please refer to [Chapter 7](#7-gasless-transactions-with-gelato).
 
-The `ipfsKey` is utilized to upload a project's data to the InterPlanetary File System (IPFS) and then include the resulting IPFS hash in the body of the Attestation. This approach is advantageous because it significantly reduces the size of the Attestation body. By storing the bulk of data on IPFS—a decentralized storage solution—and referencing it via a hash, the overall cost of creating and sending Attestations is reduced, making the process more efficient and cost-effective.
+## 4. Getting Attestations
 
-## 4. Fetching Entities
-
-After initializing the GAP client, you are now able to fetch entities available including:
+After initializing the GAP client, you are now able to fetch attestations available within this project, including:
 
 - Communities
 - Projects
@@ -137,7 +139,7 @@ After initializing the GAP client, you are now able to fetch entities available
 - Milestones
 - Milestone updates
 
-Indeed, you can retrieve all available entities, but we provide methods primarily for the higher-level entities, as this aligns with the intended behavior. When examining the `Fetcher` interface, you can:
+Indeed, you can retrieve all available attestations, but we provide methods primarily for the higher-level attestations, as this aligns with the intended behavior. When examining the `Fetcher` interface, you can:
 
 - Retrieve communities along with their related grants.
 - Obtain projects, which will contain related members and grants. Note that grants will include related updates and milestones, and milestones will also include their updates.
@@ -167,9 +169,9 @@ gap.fetch
   });
 ```
 
-## 5. Creating entities in the Frontend
+## 5. Attesting Data in a Frontend
 
-Creating entities (by adding attestations) using the GAP SDK is quite straightforward. Developers only need to define what they want to attest, and we provide facilities for this module. To avoid frequent wallet pop-ups for individual entity attestations, we've developed a special contract that handles multiple attestations and their relationships. This means you can transact once and attest multiple times. Let's walk through an example:
+Attesting data using the GAP SDK is quite straightforward. Developers only need to define what they want to attest, and we provide facilities for this module. To avoid frequent wallet pop-ups for individual entity attestations, we've developed a special contract that handles multiple attestations and their relationships. This means you can transact once and attest multiple times. Let's walk through an example:
 
 Suppose a user wants to create a project, and this project will include:
 
@@ -196,7 +198,7 @@ export function getDummyProject() {
   // Creating Project
   const project = new Project({
     data: { project: true },
-    schema: gap.findSchema('Project', 'optimism-goerli'),
+    schema: GapSchema.find('Project'),
     // Owner address, usually whoever is connected to the app
     recipient: '0xd7d...25f2',
   });
@@ -210,13 +212,13 @@ export function getDummyProject() {
       links: [{ type: 'github', url: 'https://github.com/my-org' }],
       tags: [{ name: 'DAO' }, { name: 'UI/UX' }],
     },
-    schema: gap.findSchema('ProjectDetails'),
+    schema: GapSchema.find('ProjectDetails'),
     recipient: project.recipient,
   });
 
   const member_1 = new MemberOf({
     data: { memberOf: true },
-    schema: gap.findSchema('MemberOf'),
+    schema: GapSchema.find('MemberOf'),
     refUID: pro.uid,
     // member 1 address
     recipient: '0x8dC...A8b4',
@@ -224,7 +226,7 @@ export function getDummyProject() {
 
   const member_2 = new MemberOf({
     data: { memberOf: true },
-    schema: gap.findSchema('MemberOf'),
+    schema: GapSchema.find('MemberOf'),
     refUID: pro.uid,
     // member 2 address
     recipient: '0xabc...A7b3',
@@ -237,7 +239,7 @@ export function getDummyProject() {
   const grant = new Grant({
     // Address of the related community
     data: { communityUID: '0xabc...def' },
-    schema: gap.findSchema('Grant'),
+    schema: GapSchema.find('Grant'),
     recipient: project.recipient,
   });
 
@@ -250,7 +252,7 @@ export function getDummyProject() {
       // cycle: grant cycle, optional
       // season: grant season, optional
     },
-    schema: gap.findSchema('GrantDetails'),
+    schema: GapSchema.find('GrantDetails'),
     recipient: pro.recipient,
   });
 
@@ -261,7 +263,7 @@ export function getDummyProject() {
       description: 'Milestone Description',
       endsAt: Date.now() + 1000000,
     },
-    schema: gap.findSchema('Milestone'),
+    schema: GapSchema.find('Milestone'),
     recipient: pro.recipient,
   });
 
@@ -410,9 +412,9 @@ export const MyComponent: React.FC = () => {
 
 Following any type of attestation, the SDK will associate UIDs with the objects, making them accessible after the attestation is completed. For instance, if you perform the project attestation with all its dependents, you can retrieve the attestation UID of the project, its details, grants, milestones, and so on.
 
-### Deleting an entity
+### Revoking an attestation
 
-Since every object returned by the Fetcher is also an Attestation, to delete an entitye, you just have to revoke the attestation by calling attestation.revoke.
+Since every object returned by the Fetcher is also an Attestation, to revoke any attestation, the developer simply needs to call attestation.revoke.
 
 ```ts
 // revoke-project.ts
@@ -467,9 +469,9 @@ export async function updateProjectDetails(
 
 > Note that you cannot update Milestone without losing all of its references.
 
-## 6. Create entities in a Backend
+## 6. Attesting data in a Backend
 
-To create entities in the backend, follow the same content as provided in [Section 5](#5-attesting-data-in-a-frontend). The only distinction between them is that in the backend, you'll need to instantiate an `ethers.js` wallet at runtime to sign attestations.
+To attest data in the backend, follow the same content as provided in [Chapter 5](#5-attesting-data-in-a-frontend). The only distinction between them is that in the backend, you'll need to instantiate an `ethers.js` wallet at runtime to sign attestations.
 
 ```ts
 import { gap } from 'gap-client';
@@ -644,10 +646,7 @@ When using a self-contained API to hide API keys, we offer a plug-and-play utili
 
 ```ts
 // pages/api/sponsored-handler.ts
-import {
-  type ApiRequest,
-  handler as sponsorTxnHandler,
-} from '@show-karma/karma-gap-sdk';
+import { type ApiRequest, handler as sponsorTxnHandler } from '@show-karma/karma-gap-sdk';
 import type { NextApiResponse } from 'next';
 
 const handler = (req: ApiRequest, res: NextApiResponse) =>
@@ -840,7 +839,3 @@ export default gap;
 ```
 
 > Note that your API service should return data that aligns with the interfaces provided by each Attestation for proper compatibility with this SDK. This ensures that the data is structured correctly to work seamlessly with the SDK.
-
-## Contact Us
-
-If you have any questions on SDK usage, join our discord to get help: https://discord.com/invite/X4fwgzPReJ

package/config/keys.example.json

@@ -1,6 +0,0 @@
-{
-    "sepolia": "0xabc",
-    "optimismGoerli": "0xabc",
-    "gelatoKey": "l_abx_l1",
-    "alchemy": "alchemy provider URL"
-}