@cityofzion/blockchain-service 0.1.1 → 0.2.0

package/dist/BSAgreggator.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BSAgreggator = void 0;
-const excpetions_1 = require("./excpetions");
+const exceptions_1 = require("./exceptions");
 class BSAgreggator {
     constructor(blockchainservices) {
         this.blockchainservices = blockchainservices;
@@ -17,46 +17,46 @@ class BSAgreggator {
     }
     addBlockchain(name, blockchain) {
         if (this.blockchainservices[name])
-            excpetions_1.exception.blockchainAlreadyExist(name);
+            exceptions_1.exceptions.blockchainAlreadyExist(name);
         this.blockchainservices[name] = blockchain;
         this.bsList = Object.values(this.blockchainservices);
     }
     validateAddressesAllBlockchains(address) {
         if (this.haveBlockchainServices())
-            excpetions_1.exception.invalidBlockchainService(JSON.stringify(this.blockchainservices));
+            exceptions_1.exceptions.invalidBlockchainService(JSON.stringify(this.blockchainservices));
         return this.bsList.some(bs => bs.validateAddress(address));
     }
     validateTextAllBlockchains(text) {
         if (this.haveBlockchainServices())
-            excpetions_1.exception.invalidBlockchainService(JSON.stringify(this.blockchainservices));
+            exceptions_1.exceptions.invalidBlockchainService(JSON.stringify(this.blockchainservices));
         return this.bsList.some(bs => [bs.validateAddress(text), bs.validateEncryptedKey(text), bs.validateWif(text)].some(it => it === true));
     }
     validateWifAllBlockchains(wif) {
         if (this.haveBlockchainServices())
-            excpetions_1.exception.invalidBlockchainService(JSON.stringify(this.blockchainservices));
+            exceptions_1.exceptions.invalidBlockchainService(JSON.stringify(this.blockchainservices));
         return this.bsList.some(bs => bs.validateWif(wif));
     }
     validateEncryptedKeyAllBlockchains(encryptedKey) {
         if (this.haveBlockchainServices())
-            excpetions_1.exception.invalidBlockchainService(JSON.stringify(this.blockchainservices));
+            exceptions_1.exceptions.invalidBlockchainService(JSON.stringify(this.blockchainservices));
         return this.bsList.some(bs => bs.validateEncryptedKey(encryptedKey));
     }
     getBlockchainByAddress(address) {
         var _a;
         if (this.haveBlockchainServices())
-            excpetions_1.exception.invalidBlockchainService(JSON.stringify(this.blockchainservices));
+            exceptions_1.exceptions.invalidBlockchainService(JSON.stringify(this.blockchainservices));
         return (_a = this.bsList.find(bs => bs.validateAddress(address))) !== null && _a !== void 0 ? _a : null;
     }
     getBlockchainByWif(wif) {
         var _a;
         if (this.haveBlockchainServices())
-            excpetions_1.exception.invalidBlockchainService(JSON.stringify(this.blockchainservices));
+            exceptions_1.exceptions.invalidBlockchainService(JSON.stringify(this.blockchainservices));
         return (_a = this.bsList.find(bs => bs.validateWif(wif))) !== null && _a !== void 0 ? _a : null;
     }
     getBlockchainByEncryptedKey(encryptedKey) {
         var _a;
         if (this.haveBlockchainServices())
-            excpetions_1.exception.invalidBlockchainService(JSON.stringify(this.blockchainservices));
+            exceptions_1.exceptions.invalidBlockchainService(JSON.stringify(this.blockchainservices));
         return (_a = this.bsList.find(bs => bs.validateEncryptedKey(encryptedKey))) !== null && _a !== void 0 ? _a : null;
     }
     getBlockchainsClaimable() {

package/dist/{excpetions.d.ts → exceptions.d.ts}

@@ -1,4 +1,4 @@
-export declare const exception: {
+export declare const exceptions: {
     invalidBlockchainService: (message?: string) => never;
     blockchainAlreadyExist: (blockchainName: string) => never;
 };

package/dist/{excpetions.js → exceptions.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.exception = void 0;
-exports.exception = {
+exports.exceptions = void 0;
+exports.exceptions = {
     invalidBlockchainService: (message) => {
         throw new Error(`Invalid blockchainServices => ${message}`);
     },

package/dist/functions.d.ts

@@ -0,0 +1,3 @@
+import { BlockchainService, Claimable, NeoNameService } from "./interfaces";
+export declare function hasNNS(service: BlockchainService): service is NeoNameService & BlockchainService;
+export declare function isClaimable(service: BlockchainService): service is Claimable & BlockchainService;

package/dist/functions.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isClaimable = exports.hasNNS = void 0;
+function hasNNS(service) {
+    return "getNeoNsRecord" in service && "getOwnerOfNeoNsRecord" in service && "validateNNSDomain" in service;
+}
+exports.hasNNS = hasNNS;
+function isClaimable(service) {
+    return "claim" in this && "tokenClaim" in this && "getUnclaimed" in this.dataService;
+}
+exports.isClaimable = isClaimable;

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './interfaces';
 export * from './BSAgreggator';
 export * from './exchanges';
+export * from "./functions";

package/dist/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./interfaces"), exports);
 __exportStar(require("./BSAgreggator"), exports);
 __exportStar(require("./exchanges"), exports);
+__exportStar(require("./functions"), exports);

package/dist/interfaces.d.ts

@@ -8,10 +8,6 @@ export type IntentTransactionParam = {
     tokenHash: string;
     amount: number;
 };
-export interface Account {
-    getWif(): string;
-    getAddress(): string;
-}
 export type CalculateTransferFeeDetails = {
     systemFee?: string;
     networkFee?: string;
@@ -21,12 +17,13 @@ export type ExchangeInfo = {
     symbol: string;
     amount: number;
 };
+export type ClaimResponse = {
+    txid: string;
+    symbol: string;
+    hash: string;
+};
 export interface Claimable {
-    claim(account: Account): Promise<{
-        txid: string;
-        symbol: string;
-        hash: string;
-    }>;
+    claim(account: Account): Promise<ClaimResponse>;
     dataService: BlockchainDataService & BDSClaimable;
     tokenClaim: {
         hash: string;
@@ -40,23 +37,10 @@ export declare enum NNSRecordTypes {
     TEXT = "16",
     IPV6 = "28"
 }
-export type NNSResponse = {
-    jsonrpc: string;
-    id: number;
-    result: {
-        script: string;
-        state: string;
-        gasconsumed: string;
-        exception: string;
-        stack: {
-            type: string;
-            value: string;
-        }[];
-    };
-};
 export interface NeoNameService {
-    getNeoNsRecord(domainName: string, type: typeof NNSRecordTypes): Promise<NNSResponse>;
-    getOwnerOfNeoNsRecord(domainName: string): Promise<NNSResponse>;
+    getNNSRecord(domainName: string, type: NNSRecordTypes): Promise<string>;
+    getOwnerOfNNS(domainName: string): Promise<string>;
+    validateNNSFormat(domainName: string): boolean;
 }
 export type Token = {
     name: string;
@@ -64,6 +48,14 @@ export type Token = {
     hash: string;
     decimals: number;
 };
+export type Account = {
+    wif: string;
+    address: string;
+};
+export type CalculateTransferFeeResponse = {
+    result: number;
+    details?: CalculateTransferFeeDetails;
+};
 export interface BlockchainService<BSCustomName extends string = string> {
     readonly dataService: BlockchainDataService;
     readonly blockchainName: BSCustomName;
@@ -78,22 +70,13 @@ export interface BlockchainService<BSCustomName extends string = string> {
     sendTransaction(param: SendTransactionParam): Promise<string>;
     generateMnemonic(): string;
     generateWif(mnemonic: string, index: number): string;
-    generateAccount(mnemonic: string, index: number): {
-        wif: string;
-        address: string;
-    };
+    generateAccount(mnemonic: string, index: number): Account;
     generateAccountFromWif(wif: string): string;
-    decryptKey(encryptedKey: string, password: string): Promise<{
-        wif: string;
-        address: string;
-    }>;
+    decryptKey(encryptedKey: string, password: string): Promise<Account>;
     validateAddress(address: string): boolean;
     validateEncryptedKey(encryptedKey: string): boolean;
     validateWif(wif: string): boolean;
-    calculateTransferFee(param: SendTransactionParam, details?: boolean): Promise<{
-        result: number;
-        details?: CalculateTransferFeeDetails;
-    }>;
+    calculateTransferFee(param: SendTransactionParam, details?: boolean): Promise<CalculateTransferFeeResponse>;
 }
 export type TransactionNotifications = {
     contract: string;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@cityofzion/blockchain-service",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "repository": "https://github.com/CityOfZion/blockchain-services",
   "author": "Coz",
   "license": "MIT",
   "files": ["/dist"],
@@ -16,10 +17,5 @@
     "ts-node": "10.9.1",
     "typescript": "4.9.5",
     "typedoc": "0.23.24"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/CityOfZion/blockchain-services",
-    "directory": "packages/blockchain-service"
   }
 }