@blockchyp/blockchyp-ts 1.0.0

package/itest/UploadStatusITestSpec.ts

@@ -0,0 +1,71 @@
+/**
+ * Copyright 2019-2024 BlockChyp, Inc. All rights reserved. Use of this code is governed
+ * by a license that can be found in the LICENSE file.
+ *
+ * This file was generated automatically by the BlockChyp SDK Generator. Changes to this
+ * file will be lost every time the code is regenerated.
+ */
+import * as fs from 'fs';
+import { v4 as uuidv4 } from 'uuid';
+import { Config } from './support/config';
+import * as BlockChyp from '../index';
+
+describe('UploadStatus', function () {
+  let originalTimeout: number;
+  let client: typeof BlockChyp.BlockChypClient;
+  Config.load();
+
+  beforeEach(function () {
+    originalTimeout = jasmine.DEFAULT_TIMEOUT_INTERVAL;
+    jasmine.DEFAULT_TIMEOUT_INTERVAL = 60000;
+  });
+
+  it('checks the status of a file upload.', function (done) {
+    client = BlockChyp.newClient(Config.getCreds(""));
+    client.setGatewayHost(Config.getGatewayHost());
+    client.setTestGatewayHost(Config.getTestGatewayHost());
+    client.setDashboardHost(Config.getDashboardHost());
+
+    const testDelay = process.env.BC_TEST_DELAY;
+    let testDelayInt = 0;
+    if (testDelay) {
+      testDelayInt = parseInt(testDelay);
+    }
+
+    console.log('Running uploadStatus...');
+
+    setTimeout(async function () {
+      try {
+        // setup request object
+        const setupRequest = new BlockChyp.UploadMetadata();
+          setupRequest.fileName = 'aviato.png';
+        setupRequest.fileSize = 18843;
+        setupRequest.uploadId = uuidv4();
+        let setupResponse: BlockChyp.MediaMetadata = new BlockChyp.MediaMetadata();
+        const content = fs.readFileSync('support/aviato.png');
+        const setupHttpResponse = await client.uploadMedia(setupRequest, content);
+                if (setupHttpResponse.status !== 200) {
+          console.log('Error:', setupHttpResponse.statusText);
+          fail(setupHttpResponse.statusText);
+          done();
+        }
+        setupResponse = setupHttpResponse.data
+
+        // setup request object
+        const request = new BlockChyp.UploadStatusRequest();
+        request.uploadId = setupResponse.id;
+
+        const httpResponse = await client.uploadStatus(request)
+        const response: BlockChyp.UploadStatus = httpResponse.data;
+        // response assertions
+        expect(response.success).toBe(true);
+
+      } catch (error) {
+        console.log('Error:', error);
+        fail(error);
+      } finally {
+        done();
+      }
+    }, testDelayInt * 1000);
+  });
+});

package/itest/support/config.js

@@ -0,0 +1,67 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const is_windows_1 = __importDefault(require("is-windows"));
+const ITestConfig = {
+    defaultTerminalAddress: '',
+    defaultTerminalName: '',
+    gatewayHost: '',
+    dashboardHost: '',
+    testGatewayHost: '',
+    apiKey: '',
+    bearerToken: '',
+    signingKey: '',
+    profiles: {},
+    load: function () {
+        let configHome = '';
+        if ((0, is_windows_1.default)()) {
+            configHome = process.env.userprofile || '';
+        }
+        else {
+            configHome = process.env.XDG_CONFIG_HOME || path_1.default.join(require('os').homedir(), '/.config');
+        }
+        const fileLocation = path_1.default.join(configHome, 'blockchyp', 'sdk-itest-config.json');
+        const data = fs_1.default.readFileSync(fileLocation, 'utf-8');
+        Object.assign(ITestConfig, JSON.parse(data));
+    },
+    getTerminalAddress: function () {
+        return ITestConfig.defaultTerminalAddress;
+    },
+    getTerminalName: function () {
+        return ITestConfig.defaultTerminalName;
+    },
+    getGatewayHost: function () {
+        return ITestConfig.gatewayHost;
+    },
+    getDashboardHost: function () {
+        return ITestConfig.dashboardHost;
+    },
+    getTestGatewayHost: function () {
+        return ITestConfig.testGatewayHost;
+    },
+    getApiKey: function () {
+        return ITestConfig.apiKey;
+    },
+    getBearerToken: function () {
+        return ITestConfig.bearerToken;
+    },
+    getSigningKey: function () {
+        return ITestConfig.signingKey;
+    },
+    getCreds: function (profile) {
+        if (profile) {
+            return ITestConfig.profiles[profile];
+        }
+        return {
+            apiKey: ITestConfig.apiKey,
+            bearerToken: ITestConfig.bearerToken,
+            signingKey: ITestConfig.signingKey,
+        };
+    },
+};
+exports.Config = ITestConfig;

package/itest/support/config.ts

@@ -0,0 +1,106 @@
+import fs from 'fs';
+import path from 'path';
+import isWindows from 'is-windows';
+
+interface ITestConfigData {
+  defaultTerminalAddress: string;
+  defaultTerminalName: string;
+  gatewayHost: string;
+  dashboardHost: string;
+  testGatewayHost: string;
+  apiKey: string;
+  bearerToken: string;
+  signingKey: string;
+  profiles: {
+    [key: string]: {
+      apiKey: string;
+      bearerToken: string;
+      signingKey: string;
+    };
+  };
+}
+
+interface ITestConfigFunctions {
+  load: () => void;
+  getTerminalAddress: () => string;
+  getTerminalName: () => string;
+  getGatewayHost: () => string;
+  getDashboardHost: () => string;
+  getTestGatewayHost: () => string;
+  getApiKey: () => string;
+  getBearerToken: () => string;
+  getSigningKey: () => string;
+  getCreds: (profile?: string) => { apiKey: string; bearerToken: string; signingKey: string };
+}
+
+type ITestConfig = ITestConfigData & ITestConfigFunctions;
+
+const ITestConfig: ITestConfig = {
+  defaultTerminalAddress: '',
+  defaultTerminalName: '',
+  gatewayHost: '',
+  dashboardHost: '',
+  testGatewayHost: '',
+  apiKey: '',
+  bearerToken: '',
+  signingKey: '',
+  profiles: {},
+
+  load: function () {
+    let configHome = '';
+    if (isWindows()) {
+      configHome = process.env.userprofile || '';
+    } else {
+      configHome = process.env.XDG_CONFIG_HOME || path.join(require('os').homedir(), '/.config');
+    }
+
+    const fileLocation = path.join(configHome, 'blockchyp', 'sdk-itest-config.json');
+    const data = fs.readFileSync(fileLocation, 'utf-8');
+    Object.assign(ITestConfig, JSON.parse(data));
+  },
+
+  getTerminalAddress: function () {
+    return ITestConfig.defaultTerminalAddress;
+  },
+
+  getTerminalName: function () {
+    return ITestConfig.defaultTerminalName;
+  },
+
+  getGatewayHost: function () {
+    return ITestConfig.gatewayHost;
+  },
+
+  getDashboardHost: function () {
+    return ITestConfig.dashboardHost;
+  },
+
+  getTestGatewayHost: function () {
+    return ITestConfig.testGatewayHost;
+  },
+
+  getApiKey: function () {
+    return ITestConfig.apiKey;
+  },
+
+  getBearerToken: function () {
+    return ITestConfig.bearerToken;
+  },
+
+  getSigningKey: function () {
+    return ITestConfig.signingKey;
+  },
+
+  getCreds: function (profile?: string) {
+    if (profile) {
+      return ITestConfig.profiles[profile];
+    }
+    return {
+      apiKey: ITestConfig.apiKey,
+      bearerToken: ITestConfig.bearerToken,
+      signingKey: ITestConfig.signingKey,
+    };
+  },
+};
+
+export const Config: ITestConfig = ITestConfig;

package/itest/support/jasmine.json

@@ -0,0 +1,11 @@
+{
+  "spec_dir": "spec",
+  "spec_files": [
+    "**/*[sS]pec.js"
+  ],
+  "helpers": [
+    "../node_modules/jasmine-expect/index.js"
+  ],
+  "stopSpecOnExpectationFailure": false,
+  "random": true
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@blockchyp/blockchyp-ts",
+  "version": "1.0.0",
+  "description": "BlockChyp Typescript Client",
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint . --ext .ts",
+    "clean": "tsc --build --clean",
+    "test": "npm run build && jasmine",
+    "build": "tsc",
+    "prod": "npm run lint && npm run build",
+    "prepare": "npm run prod"
+  },
+  "files": [
+    "index.ts",
+    "src/",
+    "spec/",
+    "itest/",
+    ".eslintrc.json"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/blockchyp/blockchyp-ts.git"
+  },
+  "keywords": [
+    "payments",
+    "blockchain"
+  ],
+  "author": "jeffreydpayne",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/blockchyp/blockchyp-ts/issues"
+  },
+  "homepage": "https://github.com/blockchyp/blockchyp-ts#readme",
+  "devDependencies": {
+    "@types/aes-js": "^3.1.4",
+    "@types/create-hmac": "^1.1.3",
+    "@types/elliptic": "^6.4.18",
+    "@types/is-windows": "^1.0.2",
+    "@types/jasmine": "^5.1.4",
+    "@types/randombytes": "^2.0.3",
+    "@types/sha.js": "^2.4.4",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
+    "@typescript-eslint/parser": "^7.8.0",
+    "eslint": "^8.57.0",
+    "eslint-config-standard": "^11.0.0",
+    "eslint-plugin-import": "^2.12.0",
+    "eslint-plugin-node": "^6.0.1",
+    "eslint-plugin-promise": "^3.8.0",
+    "eslint-plugin-standard": "^3.1.0",
+    "fs": "0.0.1-security",
+    "is-windows": "^1.0.2",
+    "jasmine": "^3.99.0",
+    "jasmine-promises": "^0.4.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5",
+    "uuid": "^3.3.3"
+  },
+  "dependencies": {
+    "aes-js": "^3.1.1",
+    "axios": "^0.21.1",
+    "base32": "^0.0.7",
+    "bn.js": "^4.11.8",
+    "cached-path-relative": "^1.0.2",
+    "create-hmac": "^1.1.7",
+    "elliptic": "^6.5.5",
+    "moment": "^2.22.2",
+    "npm": "^6.13.4",
+    "randombytes": "^2.0.6",
+    "sha.js": "^2.4.11",
+    "uuidv4": "^6.2.13"
+  }
+}

package/spec/CryptoSpec.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const cryptoutils_1 = __importDefault(require("../src/cryptoutils"));
+console.log(cryptoutils_1.default);
+describe("Crypto", () => {
+    it("Should Exist", () => {
+        expect(cryptoutils_1.default).toBeDefined();
+    });
+    it("Should Generate Valid Headers", () => {
+        const creds = {
+            apiKey: "SGLATIFZD7PIMLAQJ2744MOEGI",
+            bearerToken: "FI2SWNNJHJVO6DBZEF26YEHHMY",
+            signingKey: "c3a8214c318dd470b0107d6c111f086b60ad695aaeb598bf7d1032eee95339a0"
+        };
+        const headers = cryptoutils_1.default.generateGatewayHeaders(creds);
+        console.log(JSON.stringify(headers));
+        expect(headers).toBeDefined();
+    });
+    it("Should Decrypt Go Encoded AES", () => {
+        const goCipher = '14b4e146a46ca9581d0900590b5d4bb9b945e7d3574834d239e9a695bc4ad5a7a7d05bc0e677f34cb8f125844b82a58c40ce2d1b07d44efe5a87a2dfc9cdd6d4';
+        const key = '7ef938ebbd24808f800bb368a4b97ba7';
+        const expectedPlainText = 'The quick brown fox jumped over the lazy dog.';
+        const plainText = cryptoutils_1.default.decrypt(key, goCipher);
+        expect(plainText).toBe(expectedPlainText);
+    });
+    it("Should Compute SHA 256 Hashes", () => {
+        const msg = 'f181167e704a9d06d66a2299b67882da7133d120c789e57d44041fa2a84ccad805a9f64788a905ac8734b990552c19070e18c09363b832680594b9aaa1dfc987179225d3cea9c8086aeaa04b3f72eb9fcf674dc6efd7ce158628b274677f0164beaf9eb0f54283b3fb7e592118db27069e231d1e4a3a500784ed123931db8240b7bbb99618b78348491bebe370b7850c459fb5390fb126b58c2212729d1e35c99880ca68e066949f03e6e56e261d15892828eddf250120e336a3580b5158ab32f5415bfce9ebeec70ef1e7bc8f50eec349d2175b9ec7dc4b6dfdc2201f4a55edf8becb860419871732c994e829caf7793ed695ca094a9154cb343659269addcf';
+        const expectedHash = 'f04e71b08dd61a4b9b88e695f09e4688b1d54dd0930450b52444bcd961b6ec6d';
+        const hash = cryptoutils_1.default.sha256Hash(msg);
+        expect(hash).toBe(expectedHash);
+    });
+});

package/spec/CryptoSpec.ts

@@ -0,0 +1,35 @@
+import Crypto from '../src/cryptoutils';
+
+console.log(Crypto);
+
+describe("Crypto", () => {
+  it("Should Exist", () => {
+    expect(Crypto).toBeDefined();
+  });
+
+  it("Should Generate Valid Headers", () => {
+    const creds = {
+      apiKey: "SGLATIFZD7PIMLAQJ2744MOEGI",
+      bearerToken: "FI2SWNNJHJVO6DBZEF26YEHHMY",
+      signingKey: "c3a8214c318dd470b0107d6c111f086b60ad695aaeb598bf7d1032eee95339a0"
+    };
+    const headers = Crypto.generateGatewayHeaders(creds);
+    console.log(JSON.stringify(headers));
+    expect(headers).toBeDefined();
+  });
+
+  it("Should Decrypt Go Encoded AES", () => {
+    const goCipher = '14b4e146a46ca9581d0900590b5d4bb9b945e7d3574834d239e9a695bc4ad5a7a7d05bc0e677f34cb8f125844b82a58c40ce2d1b07d44efe5a87a2dfc9cdd6d4';
+    const key = '7ef938ebbd24808f800bb368a4b97ba7';
+    const expectedPlainText = 'The quick brown fox jumped over the lazy dog.';
+    const plainText = Crypto.decrypt(key, goCipher);
+    expect(plainText).toBe(expectedPlainText);
+  });
+
+  it("Should Compute SHA 256 Hashes", () => {
+    const msg = 'f181167e704a9d06d66a2299b67882da7133d120c789e57d44041fa2a84ccad805a9f64788a905ac8734b990552c19070e18c09363b832680594b9aaa1dfc987179225d3cea9c8086aeaa04b3f72eb9fcf674dc6efd7ce158628b274677f0164beaf9eb0f54283b3fb7e592118db27069e231d1e4a3a500784ed123931db8240b7bbb99618b78348491bebe370b7850c459fb5390fb126b58c2212729d1e35c99880ca68e066949f03e6e56e261d15892828eddf250120e336a3580b5158ab32f5415bfce9ebeec70ef1e7bc8f50eec349d2175b9ec7dc4b6dfdc2201f4a55edf8becb860419871732c994e829caf7793ed695ca094a9154cb343659269addcf';
+    const expectedHash = 'f04e71b08dd61a4b9b88e695f09e4688b1d54dd0930450b52444bcd961b6ec6d';
+    const hash = Crypto.sha256Hash(msg);
+    expect(hash).toBe(expectedHash);
+  });
+});

package/spec/SanitySpec.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const client_1 = __importDefault(require("../src/client"));
+describe("SanityTest", () => {
+    it("Should Exist", () => {
+        expect(client_1.default).toBeDefined();
+    });
+    it("Should Fetch Heartbeat", (done) => {
+        client_1.default.setGatewayHost('https://api.dev.blockchyp.com/');
+        client_1.default.heartbeat()
+            .then((response) => {
+            const hb = response.data;
+            expect(hb.success).toBe(true);
+            expect(hb.timestamp).toBeDefined();
+            expect(hb.latestTick).toBeDefined();
+            done();
+        })
+            .catch((error) => {
+            console.log("Error:", error);
+            done();
+        });
+    });
+});

package/spec/SanitySpec.ts

@@ -0,0 +1,23 @@
+import BlockChyp from '../src/client';
+
+describe("SanityTest", () => {
+  it("Should Exist", () => {
+    expect(BlockChyp).toBeDefined();
+  });
+
+  it("Should Fetch Heartbeat", (done) => {
+    BlockChyp.setGatewayHost('https://api.dev.blockchyp.com/');
+    BlockChyp.heartbeat()
+      .then((response: any) => {
+        const hb = response.data;
+        expect(hb.success).toBe(true);
+        expect(hb.timestamp).toBeDefined();
+        expect(hb.latestTick).toBeDefined();
+        done();
+      })
+      .catch((error: any) => {
+        console.log("Error:", error);
+        done();
+      });
+  });
+});

package/spec/support/jasmine.json

@@ -0,0 +1,11 @@
+{
+  "spec_dir": "spec",
+  "spec_files": [
+    "**/*[sS]pec.?(m)js"
+  ],
+  "helpers": [
+    "helpers/**/*.?(m)js"
+  ],
+  "stopSpecOnExpectationFailure": false,
+  "random": true
+}