@show-karma/karma-gap-sdk 0.4.16 → 0.4.18

package/core/utils/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./gelato"), exports);
+__exportStar(require("./get-date"), exports);
+__exportStar(require("./gql-queries"), exports);
+__exportStar(require("./map-filter"), exports);
+__exportStar(require("./serialize-bigint"), exports);
+__exportStar(require("./to-unix"), exports);
+__exportStar(require("./get-ipfs-data"), exports);

package/core/utils/map-filter.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Filters an array by its condition then maps it to the desired format.
+ * @param arr
+ * @param condition
+ * @param mapTo
+ * @returns
+ */
+export declare function mapFilter<T = unknown, U = unknown>(arr: U[], condition: (item: U) => boolean, mapTo: (item: U) => T): T[];

package/core/utils/map-filter.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapFilter = void 0;
+/**
+ * Filters an array by its condition then maps it to the desired format.
+ * @param arr
+ * @param condition
+ * @param mapTo
+ * @returns
+ */
+function mapFilter(arr, condition, mapTo) {
+    const newArray = [];
+    for (const item of arr) {
+        if (condition(item)) {
+            newArray.push(mapTo(item));
+        }
+    }
+    return newArray;
+}
+exports.mapFilter = mapFilter;

package/core/utils/serialize-bigint.d.ts

@@ -0,0 +1 @@
+export declare function serializeWithBigint(value: unknown): string;

package/core/utils/serialize-bigint.js

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

package/core/utils/to-unix.d.ts

@@ -0,0 +1 @@
+export declare function toUnix(value: number | Date | string): number;

package/core/utils/to-unix.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toUnix = void 0;
+function toUnix(value) {
+    switch (typeof value) {
+        case "number":
+            value = Math.round(value);
+            if (value.toString().length > 13)
+                throw new Error("Invalid timestamp length");
+            if (value.toString().length === 10)
+                return value;
+            return Math.floor(value / 1000);
+        case "string":
+            if (/\D/.test(value))
+                return null;
+            return toUnix(+value);
+        case "object":
+            if (value instanceof Date)
+                return toUnix(value.getTime());
+            return null;
+        default:
+            return null;
+    }
+}
+exports.toUnix = toUnix;

package/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./core"), exports);

package/package.json

@@ -1,47 +1,47 @@
 {
-  "name": "@show-karma/karma-gap-sdk",
-  "publishConfig": {
-    "access": "public"
-  },
-  "version": "0.4.16",
-  "description": "Simple and easy interface between EAS and Karma GAP.",
-  "main": "./index.js",
-  "author": "KarmaHQ",
-  "license": "MIT",
-  "private": false,
-  "repository": {
-    "url": "git+https://github.com/show-karma/karma-gap-sdk.git",
-    "type": "git"
-  },
-  "scripts": {
-    "deploy": "npx ts-node ./core/scripts/deploy.ts",
-    "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.6.0",
-    "@types/sha256": "^0.2.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",
-    "fast-csv": "^4.3.6",
-    "husky": "^8.0.3",
-    "prettier": "^3.0.1",
-    "typescript": "^5.1.6"
-  }
+    "name": "@show-karma/karma-gap-sdk",
+    "publishConfig": {
+        "access": "public"
+    },
+    "version": "0.4.18",
+    "description": "Simple and easy interface between EAS and Karma GAP.",
+    "main": "./index.js",
+    "author": "KarmaHQ",
+    "license": "MIT",
+    "private": false,
+    "repository": {
+        "url": "git+https://github.com/show-karma/karma-gap-sdk.git",
+        "type": "git"
+    },
+    "scripts": {
+        "deploy": "npx ts-node ./core/scripts/deploy.ts",
+        "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.6.0",
+        "@types/sha256": "^0.2.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",
+        "fast-csv": "^4.3.6",
+        "husky": "^8.0.3",
+        "prettier": "^3.0.1",
+        "typescript": "^5.1.6"
+    }
 }

package/.cursorrules

@@ -1,43 +0,0 @@
-# Karma GAP SDK - Cursor Rules
-
-## Project Overview
-The Karma GAP SDK is a library for easy integration with the Grantee Accountability Protocol. It provides tools to fetch and display Communities, Projects, Members, Grants, Milestones, and their dependencies, as well as create, update, and delete these entities. The SDK also supports gasless transactions with Gelato Relay and custom API endpoints for faster queries.
-
-## Architecture Guidelines
-When working with this codebase, understand that it follows a modular architecture with these key components:
-
-1. **GAP Facade** - Centralizes resources within the SDK, providing tools and methods to retrieve attestations and convert them into concrete objects.
-2. **Attestations** - Base module for handling various types of attestations available at EAS. Can be inherited for specific attestation types.
-3. **Schemas** - Abstract module that establishes connection with the EAS infrastructure. Contains parameters, methods, and interactions for blockchain communication.
-4. **Entities** - Represents specific attestation types customized for specific requirements. Always extends the Attestation module.
-5. **Fetcher** - Abstract module for interacting with EAS or custom API to retrieve attestations and transform them into Attestation instances.
-6. **Contract** - Custom intermediary contract to add an abstraction layer to the original EAS contracts.
-
-## Entity Types
-The SDK supports various entity types that represent different attestation types in the Grantee Accountability Protocol: Use the `gap-schema.yaml` file to understand the different types of attestations and their relationships.
-
-## Code Style Guidelines
-- Use TypeScript for all new code
-- Follow the existing module pattern when adding new features
-- Maintain proper inheritance hierarchy for new entities (extend from Attestation)
-- Document all public methods and classes with JSDoc comments
-- Use async/await for asynchronous operations
-- Implement proper error handling with custom error classes
-
-## Integration Features
-The SDK includes several integration features:
-
-- **Gelato Integration** - For gasless transactions
-- **GraphQL** - For data fetching
-- **Remote Storage** - For storing data remotely
-- **Karma Indexer** - For efficient data retrieval
-
-## Testing Guidelines
-- Write unit tests for all new functionality
-- Ensure backward compatibility when modifying existing code
-- Test with both custom API and direct blockchain access
-
-## Documentation
-- Update the README.md when adding new features
-- Include examples for new functionality
-- Document any breaking changes 

package/core/abi/index.ts

@@ -1,21 +0,0 @@
-import AirdropNFT from "./AirdropNFT.json";
-import Allo from "./Allo.json";
-import AlloRegistry from "./AlloRegistry.json";
-import CommunityResolverABI from "./CommunityResolverABI.json";
-import Donations from "./Donations.json";
-import EAS from "./EAS.json";
-import MultiAttester from "./MultiAttester.json";
-import ProjectResolver from "./ProjectResolver.json";
-import SchemaRegistry from "./SchemaRegistry.json";
-
-export const abis = {
-    AirdropNFT,
-    Allo,
-    AlloRegistry,
-    CommunityResolverABI,
-    Donations,
-    EAS,
-    MultiAttester,
-    ProjectResolver,
-    SchemaRegistry,
-};

package/core/class/AllGapSchemas.ts

@@ -1,21 +0,0 @@
-import { MountEntities, Networks } from "../../core/consts";
-import { SchemaInterface, TNetwork, TSchemaName } from "../types";
-import { GAP } from "./GAP";
-import { GapSchema } from "./GapSchema";
-
-export class AllGapSchemas {
-  public allSchemas: { [network: string]: SchemaInterface<TSchemaName>[] } = {};
-
-  constructor() {
-    Object.keys(Networks).forEach((network) => {
-      this.allSchemas[network] = Object.values(
-        MountEntities(Networks[network])
-      );
-    });
-  }
-
-  findSchema(name: TSchemaName, network: TNetwork) {
-    const schema = this.allSchemas[network].find((s) => s.name === name);
-    return new GapSchema(schema, GAP.getInstance({ network }), false, false);
-  }
-}