denotify-client 1.1.9 → 1.1.11

package/.env

@@ -0,0 +1,9 @@
+DISCORD_WEBHOOK=https://discord.com/api/webhooks/1063967722276388874/VrdsvfyCTEtnRIk5Vzhj1Y0Fi7pFueN5dH9Bz7OeXyNpwJUI7ucIzdIQwpOq8amVgCbW
+
+
+
+PROJECT_ID=xfxplbmdcoukaitzxzei
+ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6InhmeHBsYm1kY291a2FpdHp4emVpIiwicm9sZSI6ImFub24iLCJpYXQiOjE2NzgwMDg4NzMsImV4cCI6MTk5MzU4NDg3M30.WLk7bR5syQ4YJ8_jNOAuaT1UMvl7E2MS_VYMs7sN56c
+
+EMAIL=s.battenally@gmail.com
+PASSWORD=Password

package/.eslintignore

@@ -0,0 +1,8 @@
+.history
+.husky
+.vscode
+coverage
+dist
+node_modules
+vite.config.ts
+jest.config.ts

package/.eslintrc

@@ -0,0 +1,18 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint", "prettier"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "env": {
+    "browser": true,
+    "node": true
+  },
+  "rules": {
+    "prettier/prettier": "error"
+  }
+}

package/.lintstagedrc

@@ -0,0 +1,4 @@
+{
+  "./**/*.{ts,html,json}": "npm run format:scripts",
+  "./**/*.{css,scss}": "npm run format:styles"
+}

package/.prettierignore

@@ -0,0 +1,8 @@
+.history
+.husky
+.vscode
+coverage
+dist
+node_modules
+vite.config.ts
+jest.config.ts

package/.prettierrc

@@ -0,0 +1,16 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "arrowParens": "avoid",
+  "bracketSpacing": true,
+  "useTabs": false,
+  "endOfLine": "auto",
+  "singleAttributePerLine": false,
+  "bracketSameLine": false,
+  "jsxBracketSameLine": false,
+  "jsxSingleQuote": false,
+  "quoteProps": "as-needed",
+  "semi": true
+}

package/.stylelintignore

@@ -0,0 +1,8 @@
+.history
+.husky
+.vscode
+coverage
+dist
+node_modules
+vite.config.ts
+jest.config.ts

package/.stylelintrc

@@ -0,0 +1,18 @@
+{
+  "extends": [
+    "stylelint-config-recommended",
+    "stylelint-config-sass-guidelines"
+  ],
+  "overrides": [
+    {
+      "files": ["**/*.scss"],
+      "customSyntax": "postcss-scss"
+    }
+  ],
+  "rules": {
+    "function-parentheses-space-inside": null,
+    "no-descending-specificity": null,
+    "max-nesting-depth": 2,
+    "selector-max-id": 1
+  }
+}

package/dts-bundle-generator.config.ts

@@ -0,0 +1,18 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const packageJson = require("./package.json");
+
+const getPackageName = () => {
+  return packageJson.name;
+};
+
+const config = {
+  entries: [
+    {
+      filePath: "./src/index.ts",
+      outFile: `./dist/${getPackageName()}.d.ts`,
+      noCheck: false,
+    },
+  ],
+};
+
+module.exports = config;

package/favicon.svg

@@ -0,0 +1,15 @@
+<svg width="410" height="404" viewBox="0 0 410 404" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M399.641 59.5246L215.643 388.545C211.844 395.338 202.084 395.378 198.228 388.618L10.5817 59.5563C6.38087 52.1896 12.6802 43.2665 21.0281 44.7586L205.223 77.6824C206.398 77.8924 207.601 77.8904 208.776 77.6763L389.119 44.8058C397.439 43.2894 403.768 52.1434 399.641 59.5246Z" fill="url(#paint0_linear)"/>
+<path d="M292.965 1.5744L156.801 28.2552C154.563 28.6937 152.906 30.5903 152.771 32.8664L144.395 174.33C144.198 177.662 147.258 180.248 150.51 179.498L188.42 170.749C191.967 169.931 195.172 173.055 194.443 176.622L183.18 231.775C182.422 235.487 185.907 238.661 189.532 237.56L212.947 230.446C216.577 229.344 220.065 232.527 219.297 236.242L201.398 322.875C200.278 328.294 207.486 331.249 210.492 326.603L212.5 323.5L323.454 102.072C325.312 98.3645 322.108 94.137 318.036 94.9228L279.014 102.454C275.347 103.161 272.227 99.746 273.262 96.1583L298.731 7.86689C299.767 4.27314 296.636 0.855181 292.965 1.5744Z" fill="url(#paint1_linear)"/>
+<defs>
+<linearGradient id="paint0_linear" x1="6.00017" y1="32.9999" x2="235" y2="344" gradientUnits="userSpaceOnUse">
+<stop stop-color="#41D1FF"/>
+<stop offset="1" stop-color="#BD34FE"/>
+</linearGradient>
+<linearGradient id="paint1_linear" x1="194.651" y1="8.81818" x2="236.076" y2="292.989" gradientUnits="userSpaceOnUse">
+<stop stop-color="#FFEA83"/>
+<stop offset="0.0833333" stop-color="#FFDD35"/>
+<stop offset="1" stop-color="#FFA800"/>
+</linearGradient>
+</defs>
+</svg>

package/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="favicon.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite App</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/index.ts"></script>
+  </body>
+</html>

package/jest.config.ts

@@ -0,0 +1,9 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.(ts|tsx)$": "ts-jest",
+  },
+  modulePathIgnorePatterns: ["./dist/", "./test/mocks.ts"],
+  coveragePathIgnorePatterns: ["./test/mocks.ts"],
+};

package/package.json

@@ -1,64 +1,53 @@
 {
-	"version": "1.1.9",
-	"name": "denotify-client",
-	"umd:name": "denotify-client",
-	"repository": "robo-labs/denotify-client",
-	"description": "Client module for the Robo Labs DeNotify Crypto Alerts API",
-	"unpkg": "dist/index.min.js",
-	"module": "dist/index.mjs",
-	"main": "dist/index.js",
-	"types": "types/index.d.ts",
-	"license": "MIT",
-	"type": "module",
-	"author": {
-		"name": "Robo Labs",
-		"email": "info@robolabs.biz",
-		"url": "https://robolabs.biz"
-	},
-	"files": [
-		"dist",
-		"types"
-	],
-	"exports": {
-		".": {
-			"import": "./dist/index.mjs",
-			"require": "./dist/index.js"
-		},
-		"./package.json": "./package.json"
-	},
-	"engines": {
-		"node": ">=12"
-	},
-	"scripts": {
-		"build": "rollup -c",
-		"prepublishOnly": "npm run build",
-		"types": "tsc --noEmit",
-		"test": "uvu -r tsm test"
-	},
-	"keywords": [
-		"crypto",
-		"web3",
-		"alerts",
-		"ethereum",
-		"module",
-		"keywords"
-	],
-	"devDependencies": {
-		"@rollup/plugin-node-resolve": "13.1.3",
-		"@supabase/supabase-js": "^2.10.0",
-		"ethers": "^6.0.8",
-		"rollup": "^2.66.1",
-		"rollup-plugin-terser": "7.0.2",
-		"rollup-plugin-typescript2": "0.27.1",
-		"tsm": "2.2.1",
-		"typescript": "^4.9.5",
-		"uvu": "0.5.3",
-		"dotenv": "^16.0.3"
-	},
-	"dependencies": {
-		"@supabase/supabase-js": "^2.10.0",
-		"ethers": "^6.0.8",
-		"node-fetch": "^3.3.0",
-		"yup": "^1.0.2"
-	}
+  "name": "denotify-client",
+  "private": false,
+  "version": "1.1.11",
+  "main": "./dist/denotify-client.cjs",
+  "module": "./dist/denotify-client.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/denotify-client.cjs",
+      "import": "./dist/denotify-client.mjs"
+    }
+  },
+  "scripts": {
+    "dev": "vite --host",
+    "build": "tsc && vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts",
+    "test": "jest --runInBand",
+    "test:coverage": "jest --runInBand --coverage",
+    "lint:scripts": "eslint . --ext .ts",
+    "lint:styles": "stylelint ./**/*.{css,scss}",
+    "format:scripts": "prettier . --write",
+    "format:styles": "stylelint ./**/*.{css,scss} --fix",
+    "format": "npm run format:scripts && npm run format:styles",
+    "uninstall-husky": "npm uninstall husky --no-save && git config --unset core.hooksPath && npx rimraf .husky"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.2.5",
+    "@types/jsdom": "^20.0.1",
+    "@types/node": "^18.11.18",
+    "@typescript-eslint/eslint-plugin": "^5.48.2",
+    "@typescript-eslint/parser": "^5.48.2",
+    "dts-bundle-generator": "^7.1.0",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.3",
+    "jest": "^29.3.1",
+    "lint-staged": "^13.1.0",
+    "prettier": "^2.8.3",
+    "stylelint": "^14.16.1",
+    "stylelint-config-recommended": "^9.0.0",
+    "stylelint-config-sass-guidelines": "^9.0.1",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4",
+    "vite": "^4.0.4"
+  },
+  "dependencies": {
+    "@supabase/supabase-js": "^2.10.0",
+    "axios": "^1.3.4",
+    "ethers": "^6.1.0",
+    "yup": "^1.0.2"
+  }
 }

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "lib": ["ESNext", "DOM"],
+    "moduleResolution": "nodenext",
+    "strict": true,
+    "sourceMap": true,
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "noEmit": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "forceConsistentCasingInFileNames": true,
+    "types": ["vite/client", "node", "jest"]
+  },
+  "include": ["src"],
+  "exclude": ["**/*.test.ts", "node_modules", "test/**", ".history/**"]
+}

package/vite.config.ts

@@ -0,0 +1,35 @@
+import path from "path";
+import { defineConfig } from "vite";
+import packageJson from "./package.json";
+
+const getPackageName = () => {
+  return packageJson.name;
+};
+
+const getPackageNameCamelCase = () => {
+  try {
+    return getPackageName().replace(/-./g, (char) => char[1].toUpperCase());
+  } catch (err) {
+    throw new Error("Name property in package.json is missing.");
+  }
+};
+
+const fileName = {
+  es: `${getPackageName()}.mjs`,
+  cjs: `${getPackageName()}.cjs`,
+  iife: `${getPackageName()}.iife.js`,
+};
+
+const formats = Object.keys(fileName) as Array<keyof typeof fileName>;
+
+module.exports = defineConfig({
+  base: "./",
+  build: {
+    lib: {
+      entry: path.resolve(__dirname, "src/index.ts"),
+      name: getPackageNameCamelCase(),
+      formats,
+      fileName: (format) => fileName[format],
+    },
+  },
+});

package/dist/alertbuilder.js

@@ -1,67 +0,0 @@
-import { NotifyDiscordWebhook } from "./notifications/notify_discord_webhook.js";
-import { HandlerFunctionCall } from "./triggers/handler_function_call.js";
-import { HandlerFunctionCallV2 } from "./triggers/handler_function_call_v2.js";
-import { HandlerOnchainEvent } from "./triggers/handler_onchain_event.js";
-export class AlertBuilder {
-    name;
-    network;
-    triggerId;
-    trigger;
-    notificationId;
-    notification;
-    constructor(name) {
-        this.name = name;
-    }
-    static create(name) {
-        return new AlertBuilder(name);
-    }
-    onNetwork(network) {
-        this.network = network;
-        return this;
-    }
-    /**
-     * Call withTrigger with one of the TriggerConfig types:
-     * PollFunctionV2 | PollFunctionV1 | OnchainEventV1
-     * @param id Simple ID
-     * @param options Desired trigger configuration
-     * @returns self for piping
-     */
-    withTrigger(id, options) {
-        this.triggerId = id;
-        this.trigger = options;
-        return this;
-    }
-    withNotification(id, options) {
-        this.notificationId = id;
-        this.notification = options;
-        return this;
-    }
-    async validate() {
-        // Validate trigger
-        switch (this.triggerId) {
-            case 'OnchainEventV1': return HandlerOnchainEvent.validateCreate(this.trigger);
-            case 'PollFunctionV1': return HandlerFunctionCall.validateCreate(this.trigger);
-            case 'PollFunctionV2': return HandlerFunctionCallV2.validateCreate(this.trigger);
-        }
-        switch (this.notificationId) {
-            case 'Discord': return NotifyDiscordWebhook.validateCreate(this.notification);
-        }
-    }
-    async config() {
-        if (this.trigger === undefined || this.triggerId === undefined)
-            throw new Error('Trigger not configured');
-        if (this.notification === undefined || this.notificationId === undefined)
-            throw new Error('Notification not configured');
-        if (this.network === undefined)
-            throw new Error('Network not configured');
-        await this.validate();
-        return {
-            name: this.name,
-            network: this.network,
-            triggerId: this.triggerId,
-            trigger: this.trigger,
-            notificationId: this.notificationId,
-            notification: this.notification,
-        };
-    }
-}

package/dist/denotifyclient.js

@@ -1,125 +0,0 @@
-import { createClient } from "@supabase/supabase-js";
-import { Notification } from "./notifications/notification.js";
-import { Trigger } from "./triggers/trigger.js";
-import fetch from 'node-fetch';
-const toFunctionsUrl = (id) => {
-    return `https://${id}.functions.supabase.co/`;
-};
-const toApiUrl = (id) => {
-    return `https://${id}.supabase.co/`;
-};
-const PROD_PROJECT_ID = 'fdgtrxmmrtlokhgkvcjz';
-// const API_URL = ''
-const ANON_KEY = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6ImZkZ3RyeG1tcnRsb2toZ2t2Y2p6Iiwicm9sZSI6ImFub24iLCJpYXQiOjE2NzMwODcwNzYsImV4cCI6MTk4ODY2MzA3Nn0.sAMxjlcJSSozBGr-LNcsudyxzUEM9e-UspMHHQLqLr4';
-export class DeNotifyClient {
-    url;
-    token;
-    headers = {};
-    constructor(url, token) {
-        this.url = url;
-        this.token = token;
-        this.headers = {
-            'Authorization': `Bearer ${token}`,
-            'Content-Type': 'application/json'
-        };
-    }
-    static async create(options) {
-        if (options.key) {
-            // TODO
-            throw new Error('Auth by key not yet supported');
-        }
-        else if (options.email && options.password) {
-            const url = options.projectId ? toApiUrl(options.projectId) : toApiUrl(PROD_PROJECT_ID);
-            const functionsUrl = options.projectId ? toFunctionsUrl(options.projectId) : toFunctionsUrl(PROD_PROJECT_ID);
-            const anonKey = options.anonKey ? options.anonKey : ANON_KEY;
-            const supabase = createClient(url, anonKey);
-            const { data: login, error } = await supabase.auth.signInWithPassword({
-                email: options.email,
-                password: options.password,
-            });
-            if (error)
-                throw error;
-            if (login.session?.access_token === undefined)
-                throw new Error('Access token not found');
-            return new DeNotifyClient(functionsUrl, login.session?.access_token);
-        }
-        else {
-            throw new Error('Authentication Required. DeNotify supports either username/password or API key authentication');
-        }
-    }
-    async alertHistory(id, pagination) {
-        const url = `alert-history`;
-        const params = pagination ? pagination : {};
-        if (id)
-            params.id = id;
-        if (Object.keys(params).length > 0) {
-            return await this.request('get', url, { params: pagination });
-        }
-        else {
-            return await this.request('get', url);
-        }
-    }
-    // TODO - Beutify the reponse
-    async getAlert(id) {
-        const alerts = await this.request('get', `alerts/${id}`);
-        return alerts[0];
-    }
-    async getAlerts() {
-        const alerts = await this.request('get', 'alerts');
-        return alerts;
-    }
-    async createAlert(config) {
-        const trigger = Trigger.SimpleToRaw(config.name, config.triggerId, config.network, config.trigger);
-        const notification = Notification.SimpleToRaw(config.notificationId, config.notification);
-        const alert = await this.request('post', `alerts`, { body: { trigger, notification } });
-        return alert;
-    }
-    async deleteAlert(id) {
-        const alerts = await this.request('delete', `alerts/${id}`);
-        return alerts;
-    }
-    async request(method, path, options = {}) {
-        const url = new URL(`${this.url}${path}`);
-        // append params
-        if (options.params) {
-            for (const param of Object.keys(options.params)) {
-                url.searchParams.append(param, options.params[param]);
-            }
-        }
-        const payload = {
-            method,
-            headers: this.headers
-        };
-        if (options.body)
-            payload.body = JSON.stringify(options.body);
-        const res = await fetch(url.toString(), payload);
-        if (!res.ok)
-            throw new Error(`unexpected response ${res.statusText}`);
-        return await res.json();
-    }
-    async getAbi(network, address) {
-        const ret = await this.request('get', `abi/${network}/${address}`);
-        return ret;
-    }
-    async getAbiHash(abi) {
-        const ret = await this.request('post', 'abi', { body: abi });
-        return ret.hash;
-    }
-    async setAlertName(triggerId, name) {
-        throw new Error('Not yet supported - Sorry!');
-    }
-    async enableAlert(triggerId) {
-        throw new Error('Not yet supported - Sorry!');
-    }
-    async disableAlert(triggerId) {
-        throw new Error('Not yet supported - Sorry!');
-    }
-    async updateNotification(triggerId) {
-        throw new Error('Not yet supported - Sorry!');
-    }
-    async updateTrigger(triggerId, update) {
-        // TODO - Input validation
-        const ret = await this.request('patch', `alerts/trigger-handler/${triggerId}`, { body: update });
-        return ret;
-    }
-}

package/dist/examples/balance-monitor.js

@@ -1,54 +0,0 @@
-import { AlertBuilder } from "../alertbuilder.js";
-import { DeNotifyClient } from "../denotifyclient.js";
-import { FunctionBuilder } from "../functionbuilder.js";
-import { FilterBuilder } from "../util/filter.js";
-import * as dotenv from 'dotenv';
-// Load config from .env file in root directory
-// See dotenv package for info
-dotenv.config();
-// Simple App to demonstrate usage. Created a balance monitoring alert, updates it and deletes it
-async function main() {
-    const api = await DeNotifyClient.create({
-        email: process.env.EMAIL,
-        password: process.env.PASSWORD,
-        anonKey: process.env.ANON_KEY,
-        projectId: process.env.PROJECT_ID
-    });
-    const network = 'avalanche';
-    const address = '0x26985888d5b7019ff2A7444fB567D8F386c3b538';
-    const myAddress = '0x7601630eC802952ba1ED2B6e4db16F699A0a5A87';
-    const { abi } = await api.getAbi(network, address);
-    const webhook = process.env.DISCORD_WEBHOOK;
-    console.log(abi);
-    const builder = FunctionBuilder.create(api);
-    await builder.addFunction(address, 'getBalance', [myAddress], abi);
-    // Create the Balance Monitor alert
-    const alert = await AlertBuilder.create('Test Alert')
-        .onNetwork('avalanche')
-        .withTrigger('PollFunctionV2', {
-        timeBase: 'time',
-        timePeriod: '100s',
-        functions: builder.get(),
-        triggerOn: 'always',
-    })
-        .withNotification('Discord', {
-        url: webhook,
-        message: `Your avax balance is [{func_0_ret_0 / 1e18}](https://snowtrace.io/address/${myAddress})`,
-    })
-        .config();
-    // Create the alert with the API
-    const triggerId = await api.createAlert(alert);
-    console.log(triggerId);
-    // Update the period to every 10s
-    await api.updateTrigger(triggerId, { timePeriod: '10s' });
-    // Update the Filter using the filter builder
-    const filter = FilterBuilder.new()
-        .addCondition('WHERE', 'func_0_ret_0', 'Number', 'gt', 3)
-        .finalise();
-    await api.updateTrigger(13, { triggerOn: 'filter', filter, filterVersion: FilterBuilder.version() });
-    // Delete the filter in 10s
-    setTimeout(async () => {
-        await api.deleteAlert(triggerId);
-    }, 10 * 1000);
-}
-main();

package/dist/examples/delete-alert.js

@@ -1,11 +0,0 @@
-import { DeNotifyClient } from "../denotifyclient.js";
-// Simple App to demonstrate deleting an alert
-async function main() {
-    const api = await DeNotifyClient.create({
-        email: process.env.EMAIL,
-        password: process.env.PASSWORD,
-    });
-    const alertId = 11;
-    await api.deleteAlert(alertId);
-}
-main();

package/dist/functionbuilder.js

@@ -1,41 +0,0 @@
-import { ethers } from "ethers";
-import * as yup from 'yup';
-export class FunctionBuilder {
-    api;
-    data = [];
-    constructor(api) {
-        this.api = api;
-    }
-    static create(api) {
-        return new FunctionBuilder(api);
-    }
-    getAbiHash(abi) {
-        if (this.api === undefined)
-            throw new Error('FunctionBuilder must be initialised with api');
-        return this.api.getAbiHash(abi);
-    }
-    async addFunction(address, func, args, abi) {
-        const contract = new ethers.Contract(address, abi);
-        contract.interface.encodeFunctionData(func, args);
-        const abiHash = await this.getAbiHash(abi);
-        console.log(abiHash);
-        this.data.push({
-            address,
-            bytecode: contract.interface.encodeFunctionData(func, args),
-            abiHash,
-            function: func,
-        });
-        return this;
-    }
-    get() {
-        return this.data;
-    }
-    static schema() {
-        return yup.array().of(yup.object({
-            address: yup.string().required(),
-            bytecode: yup.string().matches(/^(0x)?([0-9a-fA-F]{2})*$/).required(),
-            abiHash: yup.string().matches(/^[A-Fa-f0-9]{64}/).required(),
-            function: yup.string().required()
-        }));
-    }
-}