@show-karma/karma-gap-sdk 0.4.15 → 0.4.17

package/core/class/GrantProgramRegistry/Allo.js

@@ -39,12 +39,12 @@ class AlloBase {
     async encodeStrategyInitData(applicationStart, applicationEnd, roundStart, roundEnd, payoutToken) {
         const encoder = new ethers_2.AbiCoder();
         const initStrategyData = encoder.encode(["bool", "bool", "uint256", "uint256", "uint256", "uint256", "address[]"], [
-            false,
-            true,
-            applicationStart,
-            applicationEnd,
-            roundStart,
-            roundEnd,
+            false, // useRegistryAnchor
+            true, // metadataRequired
+            applicationStart, // Eg. Curr + 1 hour later   registrationStartTime
+            applicationEnd, // Eg. Curr +  5 days later   registrationEndTime
+            roundStart, // Eg. Curr + 2 hours later  allocationStartTime
+            roundEnd, // Eg. Curr + 10 days later  allocaitonEndTime
             [payoutToken],
         ]);
         return initStrategyData;
@@ -66,7 +66,7 @@ class AlloBase {
             const createPoolArgs = {
                 profileId: args.profileId,
                 strategy: args.strategy,
-                initStrategyData: initStrategyData,
+                initStrategyData: initStrategyData, // unique to the strategy
                 token: args.payoutToken,
                 amount: BigInt(args.matchingFundAmt),
                 metadata: metadata,

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

@@ -6,6 +6,14 @@ export interface _IGrantUpdate extends GrantUpdate {
 }
 export interface IGrantUpdate extends IGrantUpdateBase {
     type?: string;
+    proofOfWork?: string;
+    pitchDeck?: string;
+    demoVideo?: string;
+    trackExplanations?: Array<{
+        trackId: string;
+        trackName: string;
+        explanation: string;
+    }>;
 }
 type IStatus = "verified";
 export interface IGrantUpdateStatus {
@@ -15,11 +23,25 @@ export interface IGrantUpdateStatus {
 export declare class GrantUpdateStatus extends Attestation<IGrantUpdateStatus> implements IGrantUpdateStatus {
     type: `grant-update-${IStatus}`;
     reason?: string;
+    pitchDeck?: string;
+    demoVideo?: string;
+    trackExplanations?: Array<{
+        trackId: string;
+        trackName: string;
+        explanation: string;
+    }>;
 }
 export declare class GrantUpdate extends Attestation<IGrantUpdate> implements IGrantUpdate {
     title: string;
     text: string;
     proofOfWork: string;
+    pitchDeck?: string;
+    demoVideo?: string;
+    trackExplanations?: Array<{
+        trackId: string;
+        trackName: string;
+        explanation: string;
+    }>;
     verified: GrantUpdateStatus[];
     /**
      * Attest the status of the milestone as approved, rejected or completed.

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

@@ -5,6 +5,11 @@ export type ExternalLink = {
     type: string;
     url: string;
 };
+export type ExternalCustomLink = {
+    type: 'custom';
+    url: string;
+    name: string;
+};
 export interface ITag {
     name: string;
 }
@@ -61,6 +66,13 @@ export interface IGrantUpdateStatus extends IAttestationResponse {
     data: {
         type: "approved" | "rejected" | "completed";
         reason?: string;
+        pitchDeck?: string;
+        demoVideo?: string;
+        trackExplanations?: Array<{
+            trackId: string;
+            trackName: string;
+            explanation: string;
+        }>;
     };
 }
 export interface IGrantUpdate extends IAttestationResponse {
@@ -160,6 +172,7 @@ export interface IGrantResponse extends IAttestationResponse {
     external?: {
         [key: string]: string[];
     };
+    amount?: Hex;
 }
 export interface IMemberDetails extends IAttestationResponse {
     name: string;
@@ -182,7 +195,7 @@ export interface IProjectDetails extends IAttestationResponse {
         missionSummary?: string;
         locationOfImpact?: string;
         imageURL: string;
-        links?: ExternalLink[];
+        links?: Array<ExternalLink | ExternalCustomLink>;
         tags?: ITag[];
         slug?: string;
         type: "project-details";
@@ -231,6 +244,7 @@ export interface IProjectResponse extends IAttestationResponse {
     symlinks: Hex[];
     endorsements: IProjectEndorsement[];
     milestones: IProjectMilestoneResponse[];
+    payoutAddress?: Hex;
 }
 export interface ICommunityDetails extends IAttestationResponse {
     type: "CommunityDetails";

package/core/class/types/attestations.d.ts

@@ -13,6 +13,11 @@ export type ExternalLink = {
     type: string;
     url: string;
 }[];
+export type ExternalCustomLink = {
+    type: 'custom';
+    url: string;
+    name: string;
+};
 export interface ICommunityDetails {
     name: string;
     description: string;
@@ -107,7 +112,7 @@ export interface IProjectDetails {
     missionSummary?: string;
     locationOfImpact?: string;
     imageURL: string;
-    links?: ExternalLink;
+    links?: Array<ExternalLink[0] | ExternalCustomLink>;
     tags?: ITag[];
     externalIds?: string[];
     slug?: string;
@@ -125,7 +130,7 @@ export declare class ProjectDetails extends Attestation<IProjectDetails> impleme
     missionSummary?: string;
     locationOfImpact?: string;
     imageURL: string;
-    links: ExternalLink;
+    links: Array<ExternalLink[0] | ExternalCustomLink>;
     tags: ITag[];
     slug: string;
     type: string;

package/core/consts.js

@@ -45,7 +45,7 @@ exports.Networks = {
         contracts: {
             eas: "0x4200000000000000000000000000000000000021",
             schema: "0x4200000000000000000000000000000000000020",
-            multicall: "0xd2eD366393FDfd243931Fe48e9fb65A192B0018c",
+            multicall: "0xd2eD366393FDfd243931Fe48e9fb65A192B0018c", //proxy,
             projectResolver: "0x7177AdC0f924b695C0294A40C4C5FEFf5EE1E141",
             communityResolver: "0x6dC1D6b864e8BEf815806f9e4677123496e12026",
             donations: "0x021896771412C1D3f31BC7B01fFA3a6A17c5dA30",
@@ -155,7 +155,7 @@ exports.Networks = {
         contracts: {
             eas: "0xbD75f629A22Dc1ceD33dDA0b68c546A1c035c458",
             schema: "0xA310da9c5B885E7fb3fbA9D66E9Ba6Df512b78eB",
-            multicall: "0x6dC1D6b864e8BEf815806f9e4677123496e12026",
+            multicall: "0x6dC1D6b864e8BEf815806f9e4677123496e12026", //proxy,
             projectResolver: "0x28BE0b0515be8BB8822aF1467A6613795E74717b",
             communityResolver: "0xD534C4704F82494aBbc901560046fB62Ac63E9C4",
             donations: "0x475F3E915601d975c792E6116791FBe9ACdBE902",
@@ -217,10 +217,10 @@ exports.Networks = {
             airdropNFT: "0x11f48e68Ff894D417956839263337a2989822703",
         },
         schemas: {
-            Community: "0xf3d790c7fdab6c1b1f25ffcc9289e5be2792eb596d2851a4d059c8aae1bc8b2e",
+            Community: "0xf3d790c7fdab6c1b1f25ffcc9289e5be2792eb596d2851a4d059c8aae1bc8b2e", //test with resolver
             // "0x1954572e3fe21bf4334afdaf1358ed7098af1ed136e76dc93c2fdc25e83934c1", // original without resolver
             Details: "0x2c270e35bfcdc4d611f0e9d3d2ab6924ec6c673505abc22a1dd07e19b67211af",
-            Grant: "0x09697aeeb3ae71de1cc19e388fd74264f11af5fba3016094764553ac341fdc72",
+            Grant: "0x09697aeeb3ae71de1cc19e388fd74264f11af5fba3016094764553ac341fdc72", // with communityUID/resolver
             GrantVerified: "0x0be8952e2dd74ffd63a02f4d55b20b603fe7a60130cb9d70de31feb9c52fdd37",
             MemberOf: "0xdd87b3500457931252424f4439365534ba72a367503a8805ff3482353fb90301",
             MilestoneApproved: "0xcdef0e492d2e7ad25d0b0fdb868f6dcd1f5e5c30e42fd5fa0debdc12f7618322",
@@ -405,7 +405,7 @@ exports.Networks = {
         contracts: {
             eas: "0x4200000000000000000000000000000000000021",
             schema: "0x4200000000000000000000000000000000000020",
-            multicall: "0x28BE0b0515be8BB8822aF1467A6613795E74717b",
+            multicall: "0x28BE0b0515be8BB8822aF1467A6613795E74717b", //proxy,
             projectResolver: "0x6dC1D6b864e8BEf815806f9e4677123496e12026",
             communityResolver: "0xfddb660F2F1C27d219372210745BB9f73431856E",
             donations: "0x28BE0b0515be8BB8822aF1467A6613795E74717b",
@@ -433,7 +433,7 @@ exports.Networks = {
         contracts: {
             eas: "0xC47300428b6AD2c7D03BB76D05A176058b47E6B0",
             schema: "0xD2CDF46556543316e7D34e8eDc4624e2bB95e3B6",
-            multicall: "0x8791Ac8c099314bB1D1514D76de13a1E80275950",
+            multicall: "0x8791Ac8c099314bB1D1514D76de13a1E80275950", //proxy,
             projectResolver: "0xAFaE7aA6118D75Fe7FDB3eF8c1623cAaF8C8a653",
             communityResolver: "0xfddb660F2F1C27d219372210745BB9f73431856E",
             donations: "0x8791Ac8c099314bB1D1514D76de13a1E80275950",

package/core/shared/types.d.ts

@@ -3,4 +3,11 @@ export interface IGrantUpdateBase {
     text: string;
     proofOfWork?: string;
     completionPercentage?: string;
+    pitchDeck?: string;
+    demoVideo?: string;
+    trackExplanations?: Array<{
+        trackId: string;
+        trackName: string;
+        explanation: string;
+    }>;
 }

package/core/types.d.ts

@@ -29,7 +29,7 @@ export interface AttestArgs<T = unknown> {
 }
 export type TSchemaName = "Community" | "CommunityDetails" | "Grant" | "GrantDetails" | "GrantVerified" | "MemberOf" | "MemberDetails" | "Milestone" | "MilestoneCompleted" | "MilestoneApproved" | "Project" | "ProjectDetails" | "Details" | "ProjectImpact" | "ProjectUpdate" | "ProjectUpdateStatus" | "ProjectPointer" | "GrantUpdate" | "GrantUpdateStatus" | "ProjectEndorsement" | "ProjectMilestone" | "ProjectMilestoneStatus" | "ContributorProfile";
 export type TResolvedSchemaNames = "Community" | "Grant" | "GrantVerified" | "MemberOf" | "MilestoneCompleted" | "MilestoneApproved" | "Project" | "Details" | "ProjectUpdateStatus" | "GrantUpdateStatus" | "ProjectUpdateStatus" | "ProjectMilestoneStatus" | "ContributorProfile";
-export type TExternalLink = "twitter" | "github" | "website" | "linkedin" | "discord" | "pitchDeck" | "demoVideo" | "farcaster";
+export type TExternalLink = "twitter" | "github" | "website" | "linkedin" | "discord" | "pitchDeck" | "demoVideo" | "farcaster" | "custom";
 export type TNetwork = "optimism" | "celo" | "optimism-sepolia" | "arbitrum" | "sepolia" | "sei" | "sei-testnet" | "base-sepolia" | "lisk" | "scroll";
 /**
  * Generic GAP Facade interface.

package/core/utils/gelato/send-gelato-txn.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Gelato = exports.sendGelatoTxn = void 0;
+exports.Gelato = void 0;
+exports.sendGelatoTxn = sendGelatoTxn;
 const axios_1 = __importDefault(require("axios"));
 const relay_sdk_1 = require("@gelatonetwork/relay-sdk");
 const watch_gelato_txn_1 = require("./watch-gelato-txn");
@@ -56,7 +57,6 @@ async function sendGelatoTxn(...params) {
     const { wait } = await sendByApiKey(...params);
     return wait();
 }
-exports.sendGelatoTxn = sendGelatoTxn;
 /**
  * Builds the arguments for a sponsored call using GelatoRelay
  * @param data Populated contract call.
@@ -86,7 +86,7 @@ data, chainId, target) {
             chainId,
             target,
         },
-        '{apiKey}',
+        '{apiKey}', // filled in the api
         {
             retries: 3,
         },

package/core/utils/gelato/sponsor-handler.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handler = void 0;
+exports.handler = handler;
 const send_gelato_txn_1 = require("./send-gelato-txn");
 const assertionObj = [
     {
@@ -57,4 +57,3 @@ async function handler(req, res, env_gelatoApiKey) {
         res.send(error.message);
     }
 }
-exports.handler = handler;

package/core/utils/gelato/watch-gelato-txn.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.watchGelatoTxn = void 0;
+exports.watchGelatoTxn = watchGelatoTxn;
 const relay_sdk_1 = require("@gelatonetwork/relay-sdk");
 var TaskState;
 (function (TaskState) {
@@ -60,4 +60,3 @@ async function watchGelatoTxn(taskId, ttl = 500) {
         loop();
     });
 }
-exports.watchGelatoTxn = watchGelatoTxn;

package/core/utils/get-date.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDate = void 0;
+exports.getDate = getDate;
 function getDate(date) {
     return typeof date === "number" ? new Date(date * 1000) : date;
 }
-exports.getDate = getDate;

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

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIPFSData = void 0;
+exports.getIPFSData = getIPFSData;
 const axios_1 = __importDefault(require("axios"));
 async function getIPFSData(cid) {
     try {
@@ -17,4 +17,3 @@ async function getIPFSData(cid) {
         throw new Error(`Error to retrive data for CID: ${cid}`);
     }
 }
-exports.getIPFSData = getIPFSData;

package/core/utils/map-filter.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapFilter = void 0;
+exports.mapFilter = mapFilter;
 /**
  * Filters an array by its condition then maps it to the desired format.
  * @param arr
@@ -17,4 +17,3 @@ function mapFilter(arr, condition, mapTo) {
     }
     return newArray;
 }
-exports.mapFilter = mapFilter;

package/core/utils/serialize-bigint.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeWithBigint = void 0;
+exports.serializeWithBigint = serializeWithBigint;
 function serializeWithBigint(value) {
     return JSON.stringify(value, (this,
         (key, value) => (typeof value === "bigint" ? value.toString() : value)));
 }
-exports.serializeWithBigint = serializeWithBigint;

package/core/utils/to-unix.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toUnix = void 0;
+exports.toUnix = toUnix;
 function toUnix(value) {
     switch (typeof value) {
         case "number":
@@ -22,4 +22,3 @@ function toUnix(value) {
             return null;
     }
 }
-exports.toUnix = toUnix;

package/package.json

@@ -3,7 +3,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.4.15",
+    "version": "0.4.17",
     "description": "Simple and easy interface between EAS and Karma GAP.",
     "main": "./index.js",
     "author": "KarmaHQ",
@@ -18,18 +18,24 @@
         "csv-upload": "npx ts-node ./csv-upload/scripts/run.ts",
         "test-file": "npx ts-node ./test-file-indexer-api.ts",
         "test-milestone": "npx ts-node ./milestone-workflow-example.ts",
+        "create-community": "npx ts-node ./create-community-example.ts",
         "publish-npm": "npm version patch && tsc && cd .dist && npm publish --scope=@show-karma/karma-gap-sdk --access public"
     },
     "dependencies": {
         "@allo-team/allo-v2-sdk": "^1.0.63",
         "@ethereum-attestation-service/eas-sdk": "1.4.2",
-        "@gelatonetwork/relay-sdk": "^5.2.0",
+        "@gelatonetwork/relay-sdk": "^5.6.0",
         "@types/sha256": "^0.2.0",
-        "axios": "^1.4.0",
+        "axios": "^1.7.9",
+        "dotenv": "^17.2.3",
         "ethers": "6.11.0",
         "sha256": "^0.2.0",
         "simple-ts-job-runner": "^1.0.12"
     },
+    "overrides": {
+        "ws": ">=8.17.1",
+        "cookie": ">=0.7.0"
+    },
     "devDependencies": {
         "@types/node": "^20.5.0",
         "eslint": "^8.47.0",