@cityofzion/blockchain-service 0.12.0 → 1.0.0

package/dist/BSAggregator.d.ts

@@ -1,9 +1,9 @@
-import { AccountWithDerivationPath, BlockchainService, Network, PartialBy } from './interfaces';
+import { AccountWithDerivationPath, BlockchainService, PartialNetwork } from './interfaces';
 export declare class BSAggregator<BSCustomName extends string = string, BSCustom extends BlockchainService<BSCustomName> = BlockchainService<BSCustomName>> {
     #private;
     readonly blockchainServicesByName: Record<BSCustomName, BSCustom>;
     constructor(blockchainServices: Record<BSCustomName, BSCustom>);
-    setNetwork(network: PartialBy<Network, 'url'>): void;
+    setNetwork(network: PartialNetwork): void;
     addBlockchain(name: BSCustomName, blockchain: BSCustom): void;
     validateAddressAllBlockchains(address: string): boolean;
     validateTextAllBlockchains(text: string): boolean;

package/dist/CryptoCompareEDS.d.ts

@@ -1,8 +1,7 @@
-import { Currency, ExchangeDataService, GetTokenPriceHistory, NetworkType, Token, TokenPricesHistoryResponse, TokenPricesResponse } from './interfaces';
+import { Currency, ExchangeDataService, GetTokenPriceHistory, Token, TokenPricesHistoryResponse, TokenPricesResponse } from './interfaces';
 export declare class CryptoCompareEDS implements ExchangeDataService {
     #private;
-    networkType: NetworkType;
-    constructor(network: NetworkType, tokens?: Token[]);
+    constructor(tokens?: Token[]);
     getTokenPrices(currency: Currency): Promise<TokenPricesResponse[]>;
     getTokenPriceHistory(params: GetTokenPriceHistory): Promise<TokenPricesHistoryResponse[]>;
 }

package/dist/CryptoCompareEDS.js

@@ -27,17 +27,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CryptoCompareEDS = void 0;
 const axios_1 = __importDefault(require("axios"));
 class CryptoCompareEDS {
-    constructor(network, tokens = []) {
+    constructor(tokens = []) {
         _CryptoCompareEDS_axiosInstance.set(this, void 0);
         _CryptoCompareEDS_tokens.set(this, void 0);
-        this.networkType = network;
         __classPrivateFieldSet(this, _CryptoCompareEDS_tokens, tokens, "f");
         __classPrivateFieldSet(this, _CryptoCompareEDS_axiosInstance, axios_1.default.create({ baseURL: 'https://min-api.cryptocompare.com' }), "f");
     }
     getTokenPrices(currency) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.networkType !== 'mainnet')
-                throw new Error('Exchange is only available on mainnet');
             const tokenSymbols = __classPrivateFieldGet(this, _CryptoCompareEDS_tokens, "f").map(token => token.symbol);
             const { data: prices } = yield __classPrivateFieldGet(this, _CryptoCompareEDS_axiosInstance, "f").get('/data/pricemultifull', {
                 params: {

package/dist/interfaces.d.ts

@@ -1,6 +1,5 @@
 import Transport from '@ledgerhq/hw-transport';
 import TypedEmitter from 'typed-emitter';
-export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 export type Account = {
     key: string;
     type: 'wif' | 'privateKey' | 'publicKey';
@@ -15,11 +14,16 @@ export interface Token {
     hash: string;
     decimals: number;
 }
-export type NetworkType = 'mainnet' | 'testnet' | 'custom';
-export type Network = {
-    type: NetworkType;
+export type Network<T extends string = string> = {
+    id: T;
+    name: string;
     url: string;
 };
+export type PartialNetwork<T extends string = string> = {
+    id: T;
+    name?: string;
+    url?: string;
+};
 export type IntentTransferParam = {
     receiverAddress: string;
     tokenHash: string;
@@ -33,15 +37,15 @@ export type TransferParam = {
     priorityFee?: string;
     isLedger?: boolean;
 };
-export interface BlockchainService<BSCustomName extends string = string> {
+export interface BlockchainService<BSCustomName extends string = string, BSAvailableNetworks extends string = string> {
     readonly blockchainName: BSCustomName;
     readonly derivationPath: string;
     readonly feeToken: Token;
     exchangeDataService: ExchangeDataService;
     blockchainDataService: BlockchainDataService;
     tokens: Token[];
-    network: Network;
-    setNetwork: (network: PartialBy<Network, 'url'>) => void;
+    network: Network<BSAvailableNetworks>;
+    setNetwork: (partialNetwork: PartialNetwork<BSAvailableNetworks>) => void;
     generateAccountFromMnemonic(mnemonic: string | string, index: number): AccountWithDerivationPath;
     generateAccountFromKey(key: string): Account;
     decrypt(keyOrJson: string, password: string): Promise<Account>;
@@ -226,3 +230,59 @@ export interface LedgerService {
     getAddress(transport: Transport): Promise<string>;
     getPublicKey(transport: Transport): Promise<string>;
 }
+export type SwapRoute = {
+    assetToUseSymbol: string;
+    reservesToUse: string;
+    assetToReceiveSymbol: string;
+    reservesToReceive: string;
+};
+export type SwapControllerServiceEvents = {
+    accountToUse: (account: Account | null) => void | Promise<void>;
+    amountToUse: (amount: string | null) => void | Promise<void>;
+    tokenToUse: (token: Token | null) => void | Promise<void>;
+    reservesToUse: (reserves: string | null) => void | Promise<void>;
+    amountToReceive: (amount: string | null) => void | Promise<void>;
+    tokenToReceive: (token: Token | null) => void | Promise<void>;
+    reservesToReceive: (reserves: string | null) => void | Promise<void>;
+    minimumReceived: (minimumReceived: string | null) => void | Promise<void>;
+    maximumSelling: (maximumSelling: string | null) => void | Promise<void>;
+    deadline: (deadline: string) => void | Promise<void>;
+    slippage: (slippage: number) => void | Promise<void>;
+    liquidityProviderFee: (liquidityProviderFee: string | null) => void | Promise<void>;
+    priceImpact: (priceImpact: string | null) => void | Promise<void>;
+    priceInverse: (priceInverse: string | null) => void | Promise<void>;
+    routes: (routes: SwapRoute[] | null) => void | Promise<void>;
+    lastAmountChanged: (lastAmountChanged: 'amountToUse' | 'amountToReceive' | null) => void | Promise<void>;
+};
+export type SwapControllerServiceSwapArgs<T extends string> = {
+    amountToUse: string;
+    amountToReceive: string;
+    tokenToUse: Token;
+    tokenToReceive: Token;
+    address: string;
+    deadline: string;
+    network: Network<T>;
+};
+export type SwapControllerServiceSwapToUseArgs<T extends string> = {
+    minimumReceived: string;
+    type: 'swapTokenToUse';
+} & SwapControllerServiceSwapArgs<T>;
+export type SwapControllerServiceSwapToReceiveArgs<T extends string> = {
+    maximumSelling: string;
+    type: 'swapTokenToReceive';
+} & SwapControllerServiceSwapArgs<T>;
+export interface SwapControllerService<AvailableNetworkIds extends string> {
+    eventEmitter: TypedEmitter<SwapControllerServiceEvents>;
+    setAccountToUse(account: Account | null): void;
+    setAmountToUse(amount: string | null): void;
+    setTokenToUse(token: Token | null): void;
+    setAmountToReceive(amount: string | null): void;
+    setTokenToReceive(token: Token | null): void;
+    setDeadline(deadline: string): void;
+    setSlippage(slippage: number): void;
+    swap(isLedger?: boolean): void;
+    buildSwapArgs(): SwapControllerServiceSwapToUseArgs<AvailableNetworkIds> | SwapControllerServiceSwapToReceiveArgs<AvailableNetworkIds>;
+    setReserves(): void;
+    startListeningBlockGeneration(): void;
+    stopListeningBlockGeneration(): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cityofzion/blockchain-service",
-  "version": "0.12.0",
+  "version": "1.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": "https://github.com/CityOfZion/blockchain-services",
@@ -15,12 +15,12 @@
     "@typescript-eslint/parser": "^6.5.0",
     "eslint": "^8.48.0",
     "ts-node": "10.9.1",
-    "typescript": "4.9.5"
+    "typescript": "4.9.5",
+    "typed-emitter": "~2.1.0"
   },
   "dependencies": {
     "@ledgerhq/hw-transport": "~6.30.5",
-    "axios": "1.5.1",
-    "typed-emitter": "~2.1.0"
+    "axios": "1.5.1"
   },
   "scripts": {
     "build": "tsc",