@peeramid-labs/sdk 1.0.0

package/lib.esm/utils/artifacts.d.ts

@@ -0,0 +1,45 @@
+import { type Address, type PublicClient, type WalletClient, type GetContractReturnType, AbiItem, Hex } from "viem";
+import rankifyAbi from "../abis/Rankify";
+import multipassAbi from "../abis/Multipass";
+import simpleAccessManagerAbi from "../abis/SimpleAccessManager";
+import DAODistributorabi from "../abis/DAODistributor";
+export type SupportedChains = "anvil" | "localhost";
+export declare const chainIdMapping: {
+    [key in SupportedChains]: string;
+};
+export type ArtifactTypes = "Rankify" | "Multipass" | "SimpleAccessManager" | "DAODistributor";
+export type ArtifactAbi = {
+    Rankify: typeof rankifyAbi;
+    Multipass: typeof multipassAbi;
+    SimpleAccessManager: typeof simpleAccessManagerAbi;
+    DAODistributor: typeof DAODistributorabi;
+};
+/**
+ * Retrieves the contract artifact for the specified chain.
+ * @param chain The viem Chain object
+ * @param artifactName The name of the artifact to retrieve
+ * @returns The artifact containing the address and execution args
+ * @throws Error if the contract deployment is not found or chain is not supported.
+ */
+export declare const getArtifact: (chainId: number, artifactName: ArtifactTypes, overrideChainName?: string) => {
+    abi: readonly AbiItem[];
+    address: Address;
+    execute: {
+        args: string[];
+    };
+    receipt: {
+        from: Address;
+        transactionHash: Hex;
+        blockNumber: number;
+        args: string[];
+    };
+};
+/**
+ * Gets a contract instance with the appropriate ABI and address for the given chain
+ * @param chain The chain to get the contract for
+ * @param artifactName The name of the contract to get
+ * @param client The viem client to use (public or wallet)
+ * @returns A viem contract instance
+ */
+export declare const getContract: <TArtifactName extends ArtifactTypes, TClient extends PublicClient | WalletClient>(chainId: number, artifactName: TArtifactName, client: TClient) => GetContractReturnType<ArtifactAbi[TArtifactName], TClient>;
+//# sourceMappingURL=artifacts.d.ts.map

package/lib.esm/utils/artifacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifacts.d.ts","sourceRoot":"","sources":["../../../src/utils/artifacts.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,YAAY,EAEjB,KAAK,qBAAqB,EAC1B,OAAO,EACP,GAAG,EACJ,MAAM,MAAM,CAAC;AAEd,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAC7C,OAAO,sBAAsB,MAAM,6BAA6B,CAAC;AACjE,OAAO,iBAAiB,MAAM,wBAAwB,CAAC;AAIvD,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,WAAW,CAAC;AAEpD,eAAO,MAAM,cAAc,EAAE;KAAG,GAAG,IAAI,eAAe,GAAG,MAAM;CAG9D,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,WAAW,GAAG,qBAAqB,GAAG,gBAAgB,CAAC;AAE/F,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,OAAO,UAAU,CAAC;IAC3B,SAAS,EAAE,OAAO,YAAY,CAAC;IAC/B,mBAAmB,EAAE,OAAO,sBAAsB,CAAC;IACnD,cAAc,EAAE,OAAO,iBAAiB,CAAC;CAC1C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,YACb,MAAM,gBACD,aAAa,sBACP,MAAM,KACzB;IACD,GAAG,EAAE,SAAS,OAAO,EAAE,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAC5B,OAAO,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,eAAe,EAAE,GAAG,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CAuBvF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAI,aAAa,SAAS,aAAa,EAAE,OAAO,SAAS,YAAY,GAAG,YAAY,WACjG,MAAM,gBACD,aAAa,UACnB,OAAO,KACd,qBAAqB,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,OAAO,CAO3D,CAAC"}

package/lib.esm/utils/artifacts.js

@@ -0,0 +1,44 @@
+import { getContract as viemGetContract, } from "viem";
+import { getChainPath } from "./chainMapping";
+export const chainIdMapping = {
+    anvil: "97113",
+    localhost: "42161",
+};
+/**
+ * Retrieves the contract artifact for the specified chain.
+ * @param chain The viem Chain object
+ * @param artifactName The name of the artifact to retrieve
+ * @returns The artifact containing the address and execution args
+ * @throws Error if the contract deployment is not found or chain is not supported.
+ */
+export const getArtifact = (chainId, artifactName, overrideChainName) => {
+    const chainPath = overrideChainName ?? getChainPath(chainId);
+    const artifact = (artifactName === "Multipass"
+        ? require(`@peeramid-labs/multipass/deployments/${chainPath}/${artifactName}.json`)
+        : require(`rankify-contracts/deployments/${chainPath}/${artifactName}.json`));
+    if (!artifact) {
+        throw new Error("Contract deployment not found");
+    }
+    return {
+        address: artifact.address,
+        execute: artifact.execute,
+        abi: artifact.abi,
+        receipt: artifact.receipt,
+    };
+};
+/**
+ * Gets a contract instance with the appropriate ABI and address for the given chain
+ * @param chain The chain to get the contract for
+ * @param artifactName The name of the contract to get
+ * @param client The viem client to use (public or wallet)
+ * @returns A viem contract instance
+ */
+export const getContract = (chainId, artifactName, client) => {
+    const artifact = getArtifact(chainId, artifactName);
+    return viemGetContract({
+        address: artifact.address,
+        abi: artifact.abi,
+        client,
+    });
+};
+//# sourceMappingURL=artifacts.js.map

package/lib.esm/utils/artifacts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"artifacts.js","sourceRoot":"","sources":["../../../src/utils/artifacts.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,WAAW,IAAI,eAAe,GAI/B,MAAM,MAAM,CAAC;AAOd,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAI9C,MAAM,CAAC,MAAM,cAAc,GAAyC;IAClE,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,OAAO;CACnB,CAAC;AAWF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,OAAe,EACf,YAA2B,EAC3B,iBAA0B,EAM1B,EAAE;IACF,MAAM,SAAS,GAAG,iBAAiB,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;IAC7D,MAAM,QAAQ,GAAG,CACf,YAAY,KAAK,WAAW;QAC1B,CAAC,CAAC,OAAO,CAAC,wCAAwC,SAAS,IAAI,YAAY,OAAO,CAAC;QACnF,CAAC,CAAC,OAAO,CAAC,iCAAiC,SAAS,IAAI,YAAY,OAAO,CAAC,CAM/E,CAAC;IAEF,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IACD,OAAO;QACL,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,OAAO,EAAE,QAAQ,CAAC,OAAO;KAC1B,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,OAAe,EACf,YAA2B,EAC3B,MAAe,EAC6C,EAAE;IAC9D,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACpD,OAAO,eAAe,CAAC;QACrB,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,MAAM;KACP,CAA+D,CAAC;AACnE,CAAC,CAAC"}

package/lib.esm/utils/chainMapping.d.ts

@@ -0,0 +1,4 @@
+export type ChainMapping = Record<string, string>;
+export declare const chainToPath: ChainMapping;
+export declare function getChainPath(chainId: number): string;
+//# sourceMappingURL=chainMapping.d.ts.map

package/lib.esm/utils/chainMapping.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chainMapping.d.ts","sourceRoot":"","sources":["../../../src/utils/chainMapping.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAElD,eAAO,MAAM,WAAW,EAAE,YAGhB,CAAC;AAEX,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAMpD"}

package/lib.esm/utils/chainMapping.js

@@ -0,0 +1,12 @@
+export const chainToPath = {
+    "31337": "localhost",
+    "97113": "anvil",
+};
+export function getChainPath(chainId) {
+    const path = chainToPath[chainId.toString()];
+    if (!path) {
+        throw new Error(`Chain ID ${chainId} is not supported`);
+    }
+    return path;
+}
+//# sourceMappingURL=chainMapping.js.map

package/lib.esm/utils/chainMapping.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chainMapping.js","sourceRoot":"","sources":["../../../src/utils/chainMapping.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,WAAW,GAAiB;IACvC,OAAO,EAAE,WAAW;IACpB,OAAO,EAAE,OAAO;CACR,CAAC;AAEX,MAAM,UAAU,YAAY,CAAC,OAAe;IAC1C,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC,QAAQ,EAA8B,CAAC,CAAC;IACzE,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,YAAY,OAAO,mBAAmB,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/lib.esm/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./ApiError";
+export * from "./artifacts";
+//# sourceMappingURL=index.d.ts.map

package/lib.esm/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}

package/lib.esm/utils/index.js

@@ -0,0 +1,3 @@
+export * from "./ApiError";
+export * from "./artifacts";
+//# sourceMappingURL=index.js.map

package/lib.esm/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@peeramid-labs/sdk",
+  "description": "Peeramid Labs js client library",
+  "version": "1.0.0",
+  "type": "commonjs",
+  "main": "./lib.commonjs/index.js",
+  "module": "./lib.esm/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/peeramid-labs/sdk/main/README.md",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/peeramid-labs/sdk.git",
+    "directory": "."
+  },
+  "exports": {
+    ".": {
+      "require": "./lib.commonjs/index.js",
+      "import": "./lib.esm/index.js",
+      "default": "./lib.esm/index.js"
+    }
+  },
+  "dependencies": {
+    "@peeramid-labs/eds": "^2.2.0",
+    "@peeramid-labs/multipass": "^0.3.2",
+    "crypto-js": "^4.1.1",
+    "lodash": "^4.17.21",
+    "rankify-contracts": "^0.10.1",
+    "viem": "^2.21.55"
+  },
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.4.8",
+    "@changesets/cli": "^2.26.2",
+    "@eslint/js": "^8.56.0",
+    "@jest/globals": "^29.7.0",
+    "@types/crypto-js": "^4.1.3",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.10.5",
+    "@typescript-eslint/eslint-plugin": "^8.18.0",
+    "@typescript-eslint/parser": "^8.18.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jest": "^28.9.0",
+    "globals": "^15.9.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.3.3",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.18.0",
+    "typedoc": "^0.25.7",
+    "typedoc-plugin-markdown": "^3.17.1",
+    "typedoc-theme-hierarchy": "^4.1.2"
+  },
+  "scripts": {
+    "lint:fix": "prettier --write 'src/**/*.{ts,js}' && eslint --fix .",
+    "lint": "eslint .",
+    "generate-chain-mapping": "node ./scripts/generateChainMapping.mjs",
+    "prebuild": "node scripts/copyAbi.cjs && jq '.type = \"commonjs\"' package.json > temp.json && mv temp.json package.json",
+    "build-esm": "tsc --project tsconfig.esm.json",
+    "build-all": "pnpm generate-chain-mapping && pnpm run build-commonjs && pnpm run build-esm",
+    "build-commonjs": "tsc --project tsconfig.commonjs.json",
+    "build": "pnpm build-all && node ./scripts/copyPackageFile.cjs prod",
+    "postbuild": "jq '.type = \"module\"' package.json > temp.json && mv temp.json package.json && cp README.md dist && cp -r .changeset ./dist/.changeset && prettier --write \"dist/**/*.{ts,js,json}\" &&  cd ./dist && pnpm install",
+    "dist": "changeset && changeset version && pnpm build && cp -r .changeset ./dist && cd dist && pnpm changeset publish",
+    "version": "changeset version",
+    "release": "pnpm build && cd ./dist && changeset publish",
+    "test": "jest",
+    "test:ci": "pnpm generate-chain-mapping && node scripts/copyAbi.cjs && pnpm jest",
+    "test:watch": "jest --watch",
+    "lint:ci": "pnpm generate-chain-mapping && node scripts/copyAbi.cjs && pnpm lint",
+    "docs": "typedoc",
+    "docs:watch": "typedoc --watch"
+  }
+}