@cityofzion/blockchain-service 0.9.1 → 0.10.0

package/dist/functions.d.ts

@@ -1,7 +1,8 @@
-import { BlockchainService, BSCalculableFee, BSClaimable, BSWithExplorerService, BSWithNameService, BSWithNft } from './interfaces';
+import { BlockchainService, BSCalculableFee, BSClaimable, BSWithExplorerService, BSWithLedger, BSWithNameService, BSWithNft } from './interfaces';
 export declare function hasNameService(service: BlockchainService): service is BlockchainService & BSWithNameService;
 export declare function isClaimable(service: BlockchainService): service is BlockchainService & BSClaimable;
 export declare function isCalculableFee(service: BlockchainService): service is BlockchainService & BSCalculableFee;
 export declare function hasNft(service: BlockchainService): service is BlockchainService & BSWithNft;
 export declare function hasExplorerService(service: BlockchainService): service is BlockchainService & BSWithExplorerService;
+export declare function hasLedger(service: BlockchainService): service is BlockchainService & BSWithLedger;
 export declare function waitForTransaction(service: BlockchainService, txId: string): Promise<boolean>;

package/dist/functions.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitForTransaction = exports.hasExplorerService = exports.hasNft = exports.isCalculableFee = exports.isClaimable = exports.hasNameService = void 0;
+exports.waitForTransaction = exports.hasLedger = exports.hasExplorerService = exports.hasNft = exports.isCalculableFee = exports.isClaimable = exports.hasNameService = void 0;
 function hasNameService(service) {
     return 'resolveNameServiceDomain' in service && 'validateNameServiceDomainFormat' in service;
 }
@@ -30,6 +30,10 @@ function hasExplorerService(service) {
     return 'explorerService' in service;
 }
 exports.hasExplorerService = hasExplorerService;
+function hasLedger(service) {
+    return 'ledgerService' in service;
+}
+exports.hasLedger = hasLedger;
 function wait(ms) {
     return new Promise(resolve => setTimeout(resolve, ms));
 }

package/dist/interfaces.d.ts

@@ -1,7 +1,8 @@
+import Transport from '@ledgerhq/hw-transport';
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 export type Account = {
     key: string;
-    type: 'wif' | 'privateKey';
+    type: 'wif' | 'privateKey' | 'publicKey';
     address: string;
 };
 export type AccountWithDerivationPath = Account & {
@@ -24,12 +25,19 @@ export type IntentTransferParam = {
     amount: string;
     tokenDecimals?: number;
 };
+export type TransferParamWithLedger = {
+    isLedger: true;
+    ledgerTransport: Transport;
+};
+export type TransferParamWithoutLedger = {
+    isLedger?: false;
+};
 export type TransferParam = {
     senderAccount: Account;
     intent: IntentTransferParam;
     tipIntent?: IntentTransferParam;
     priorityFee?: string;
-};
+} & (TransferParamWithLedger | TransferParamWithoutLedger);
 export type TokenPricesResponse = {
     price: number;
     symbol: string;
@@ -76,6 +84,10 @@ export interface BSWithExplorerService {
 export interface BSWithNft {
     nftDataService: NftDataService;
 }
+export interface BSWithLedger {
+    ledgerService: LedgerService;
+    generateAccountFromPublicKey(publicKey: string): Account;
+}
 export type TransactionNotifications = {
     eventName: string;
     state: {
@@ -185,3 +197,7 @@ export interface ExplorerService {
     buildTransactionUrl(hash: string): string;
     buildNftUrl(params: BuildNftUrlParams): string;
 }
+export interface LedgerService {
+    getAddress(transport: Transport): Promise<string>;
+    getPublicKey(transport: Transport): Promise<string>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cityofzion/blockchain-service",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": "https://github.com/CityOfZion/blockchain-services",
@@ -17,6 +17,9 @@
     "ts-node": "10.9.1",
     "typescript": "4.9.5"
   },
+  "dependencies": {
+    "@ledgerhq/hw-transport": "~6.30.5"
+  },
   "scripts": {
     "build": "tsc",
     "lint": "eslint .",