fix: update build process and add new configuration files; improve pa…

…ckage exports and documentation

.gitignore

@@ -4,7 +4,4 @@
 /coverage.data
 /coverage/
 
-# Build files
-/dist
-
 /.idea

.husky/pre-commit

@@ -1,2 +1,3 @@
-bun run format
-bun run test
+npm run format
+npm run test
+npm run build

README.md

@@ -43,7 +43,7 @@ bun install timecipher
 First, import the necessary methods from the library:
 
 ```javascript
-import { getTimestamp, encryptMessage, decryptMessage, isActive, whenActive } from "time-cipher";
+import { getTimestamp, encryptMessage, decryptMessage, isActive, whenActive } from "timecipher";
 ```
 
 Example: Encrypting a message
@@ -86,20 +86,6 @@ console.log("Current Timestamp:", timestamp);
 
 ## API Documentation
 
-`getTimestamp(_config?: IExtendedConfig): Promise<number>`
-
-Retrieves the current timestamp from the smart contract.
-
-**Parameters:**
-
-- `_config` (optional): An object to override default configuration.
-
-**Returns:**
-
-- A promise that resolves to the current timestamp as a number.
-
----
-
 `decryptMessage(encryptedMessage: string, _config?: IExtendedConfig): Promise<string>`
 
 Decrypts an encrypted message using the smart contract.
@@ -143,6 +129,20 @@ Gets the activation timestamp of an encrypted message.
 
 - A promise that resolves to the activation timestamp as a number.
 
+---
+
+`getTimestamp(_config?: IExtendedConfig): Promise<number>`
+
+Retrieves the current timestamp from the smart contract.
+
+**Parameters:**
+
+- `_config` (optional): An object to override default configuration.
+
+**Returns:**
+
+- A promise that resolves to the current timestamp as a number.
+
 ## Types
 
 ```typescript
@@ -157,7 +157,3 @@ interface IExtendedConfig {
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-```
-
-```

dist/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultContractAddress = exports.defaultABI = exports.whenActive = exports.isActive = exports.decryptMessage = exports.encryptMessage = exports.getTimestamp = exports.default = void 0;
+const ABI_1 = require("./src/ABI");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return ABI_1.methods; } });
+Object.defineProperty(exports, "defaultContractAddress", { enumerable: true, get: function () { return ABI_1.defaultContractAddress; } });
+Object.defineProperty(exports, "defaultABI", { enumerable: true, get: function () { return ABI_1.defaultABI; } });
+const { getTimestamp, encryptMessage, decryptMessage, isActive, whenActive } = ABI_1.methods;
+exports.getTimestamp = getTimestamp;
+exports.encryptMessage = encryptMessage;
+exports.decryptMessage = decryptMessage;
+exports.isActive = isActive;
+exports.whenActive = whenActive;

dist/jest.config.js

@@ -0,0 +1,5 @@
+"use strict";
+module.exports = {
+    preset: "ts-jest",
+    testEnvironment: "node",
+};

dist/src/ABI/abi.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v1_0 = void 0;
+exports.v1_0 = [
+    { inputs: [], stateMutability: "nonpayable", type: "constructor" },
+    {
+        inputs: [{ internalType: "bytes", name: "encryptedMsg", type: "bytes" }],
+        name: "decryptMessage",
+        outputs: [{ internalType: "string", name: "", type: "string" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [
+            { internalType: "string", name: "message", type: "string" },
+            { internalType: "uint256", name: "timestamp", type: "uint256" },
+        ],
+        name: "encryptMessage",
+        outputs: [{ internalType: "bytes", name: "", type: "bytes" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [],
+        name: "getTimestamp",
+        outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [{ internalType: "bytes", name: "encryptedMsg", type: "bytes" }],
+        name: "isActive",
+        outputs: [{ internalType: "bool", name: "", type: "bool" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        inputs: [{ internalType: "bytes", name: "encryptedMsg", type: "bytes" }],
+        name: "whenActive",
+        outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+        stateMutability: "view",
+        type: "function",
+    },
+];

dist/src/ABI/index.js

@@ -0,0 +1,70 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.methods = exports.defaultContractAddress = exports.defaultABI = void 0;
+const ethers_1 = require("ethers");
+const abi_1 = require("./abi");
+const config_1 = __importDefault(require("../config"));
+const abi = [abi_1.v1_0];
+exports.defaultABI = abi[0];
+exports.defaultContractAddress = config_1.default.CONTRACT_ADDRESS;
+const defaults = {
+    provider: new ethers_1.ethers.JsonRpcProvider(config_1.default.RPC_URL),
+    contractAddress: config_1.default.CONTRACT_ADDRESS,
+    rpcUrl: config_1.default.RPC_URL,
+    abi: abi[0],
+};
+const getDefaults = (_config) => ({
+    provider: _config.provider || new ethers_1.ethers.JsonRpcProvider(_config.rpcUrl || config_1.default.RPC_URL),
+    contractAddress: _config.contractAddress || config_1.default.CONTRACT_ADDRESS,
+    rpcUrl: _config.rpcUrl || config_1.default.RPC_URL,
+    abi: _config.abi || abi[0],
+});
+exports.methods = {
+    getTimestamp: (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (_config = defaults) {
+        const { provider, contractAddress, abi } = getDefaults(_config);
+        const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
+        const timestamp = yield contract.getTimestamp();
+        return Number(timestamp);
+    }),
+    encryptMessage: (message_1, timestamp_1, ...args_1) => __awaiter(void 0, [message_1, timestamp_1, ...args_1], void 0, function* (message, timestamp, _config = defaults) {
+        const { provider, contractAddress, abi } = getDefaults(_config);
+        const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
+        return yield contract.encryptMessage(message, timestamp);
+    }),
+    decryptMessage: (encryptedMessage_1, ...args_1) => __awaiter(void 0, [encryptedMessage_1, ...args_1], void 0, function* (encryptedMessage, _config = defaults) {
+        var _a, _b;
+        try {
+            const { provider, contractAddress, abi } = getDefaults(_config);
+            const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
+            return yield contract.decryptMessage(encryptedMessage);
+        }
+        catch (error) {
+            if (((_b = (_a = error === null || error === void 0 ? void 0 : error.revert) === null || _a === void 0 ? void 0 : _a.args) === null || _b === void 0 ? void 0 : _b.length) > 0)
+                throw new Error(error.revert.args[0]);
+            throw new Error(error.message);
+        }
+    }),
+    isActive: (encryptedMsg_1, ...args_1) => __awaiter(void 0, [encryptedMsg_1, ...args_1], void 0, function* (encryptedMsg, _config = defaults) {
+        const { provider, contractAddress, abi } = getDefaults(_config);
+        const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
+        return yield contract.isActive(encryptedMsg);
+    }),
+    whenActive: (encryptedMsg_1, ...args_1) => __awaiter(void 0, [encryptedMsg_1, ...args_1], void 0, function* (encryptedMsg, _config = defaults) {
+        const { provider, contractAddress, abi } = getDefaults(_config);
+        const contract = new ethers_1.ethers.Contract(contractAddress, abi, provider);
+        const timestamp = yield contract.whenActive(encryptedMsg);
+        return Number(timestamp);
+    }),
+};

dist/src/config/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config = {
+    RPC_URL: "https://sepolia.base.org",
+    CHAIN_ID: 84532,
+    CONTRACT_ADDRESS: "0x9237084a3bd3c113f26f589d703321080d9532f9",
+};
+exports.default = config;

dist/src/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

dist/test/modules.test.js

@@ -0,0 +1,42 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = __importDefault(require("../index"));
+test("getTimestamp", () => __awaiter(void 0, void 0, void 0, function* () {
+    const timestamp = yield index_1.default.getTimestamp();
+    expect(typeof timestamp).toBe("number");
+}));
+test("encryptMessage", () => __awaiter(void 0, void 0, void 0, function* () {
+    const timestamp = yield index_1.default.getTimestamp();
+    const encryptedMessage = yield index_1.default.encryptMessage("test", timestamp);
+    expect(typeof encryptedMessage).toBe("string");
+}));
+test("decryptMessage", () => __awaiter(void 0, void 0, void 0, function* () {
+    const timestamp = yield index_1.default.getTimestamp();
+    const encryptedMessage = yield index_1.default.encryptMessage("test", timestamp);
+    const decryptedMessage = yield index_1.default.decryptMessage(encryptedMessage);
+    expect(decryptedMessage).toBe("test");
+}));
+test("isActive", () => __awaiter(void 0, void 0, void 0, function* () {
+    const timestamp = yield index_1.default.getTimestamp();
+    const encryptedMessage = yield index_1.default.encryptMessage("test", timestamp);
+    const active = yield index_1.default.isActive(encryptedMessage);
+    expect(active).toBe(true);
+}));
+test("whenActive", () => __awaiter(void 0, void 0, void 0, function* () {
+    const timestamp = yield index_1.default.getTimestamp();
+    const encryptedMessage = yield index_1.default.encryptMessage("test", timestamp);
+    const whenActive = yield index_1.default.whenActive(encryptedMessage);
+    expect(whenActive).toBe(timestamp);
+}));

index.ts

@@ -1,4 +1,4 @@
-import { methods } from "./src/ABI";
+import { methods, defaultContractAddress, defaultABI } from "./src/ABI";
 import type { IEthersError, IExtendedConfig } from "./src/types";
 
 const { getTimestamp, encryptMessage, decryptMessage, isActive, whenActive } = methods;
@@ -9,6 +9,8 @@ export {
   decryptMessage,
   isActive,
   whenActive,
+  defaultABI,
+  defaultContractAddress,
   type IEthersError,
   type IExtendedConfig,
 };

package.json

@@ -1,7 +1,7 @@
 {
   "name": "timecipher",
   "discription": "TimeCipher is a blockchain-based time-locked messaging system that securely encrypts messages with a timestamp, ensuring they can only be decrypted after the specified time. This innovative solution combines privacy and delayed access, perfect for secure future communication.",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "keywords": [
     "timecipher",
     "blockchain",
@@ -17,6 +17,18 @@
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "require": "./dist/index.d.ts",
+        "default": "./dist/index.d.ts"
+      },
+      "default": {
+        "require": "./dist/index.js",
+        "import": "./dist/index.js"
+      }
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/truethari/timecipher.git"