@ethersphere/bee-dashboard 0.19.0 → 0.19.1

package/lib/src/types.d.ts

@@ -0,0 +1,36 @@
+import type { NodeAddresses, Topology } from '@ethersphere/bee-js';
+import type { Token } from './models/Token';
+import { CheckState } from './providers/Bee';
+export interface StatusHookCommon {
+    checkState: CheckState;
+}
+export interface StatusNodeVersionHook extends StatusHookCommon {
+    userVersion?: string;
+    latestVersion?: string;
+    latestUrl: string;
+    isLatestBeeVersion: boolean;
+}
+export interface StatusEthereumConnectionHook extends StatusHookCommon {
+    nodeAddresses: NodeAddresses | null;
+}
+export interface StatusTopologyHook extends StatusHookCommon {
+    topology: Topology | null;
+}
+export interface ChequebookBalance {
+    totalBalance: Token;
+    availableBalance: Token;
+}
+export interface Balance {
+    peer: string;
+    balance: Token;
+}
+export interface Settlement {
+    peer: string;
+    received: Token;
+    sent: Token;
+}
+export interface Settlements {
+    totalReceived: Token;
+    totalSent: Token;
+    settlements: Settlement[];
+}

package/lib/src/utils/bzz-abi.d.ts

@@ -0,0 +1,16 @@
+export declare const BZZ_TOKEN_ADDRESS = "0xdBF3Ea6F5beE45c02255B2c26a16F300502F68da";
+export declare const bzzABI: {
+    type: string;
+    stateMutability: string;
+    payable: boolean;
+    outputs: {
+        type: string;
+        name: string;
+    }[];
+    name: string;
+    inputs: {
+        type: string;
+        name: string;
+    }[];
+    constant: boolean;
+}[];

package/lib/src/utils/bzz-faucet.d.ts

@@ -0,0 +1 @@
+export declare function requestBzz(address: string): Promise<void>;

package/lib/src/utils/chain.d.ts

@@ -0,0 +1 @@
+export declare function chainIdToName(chainId: number): string;

package/lib/src/utils/date.d.ts

@@ -0,0 +1 @@
+export declare function getPrettyDateString(date: Date): string;

package/lib/src/utils/desktop.d.ts

@@ -0,0 +1,18 @@
+import { Token } from '../models/Token';
+interface DesktopStatus {
+    status: 0 | 1 | 2;
+    address: string | null;
+    config: Record<string, any>;
+}
+export declare const BEE_DESKTOP_LATEST_RELEASE_PAGE = "https://github.com/ethersphere/bee-desktop/releases/latest";
+export declare function getDesktopStatus(): Promise<DesktopStatus>;
+export declare function getBzzPriceAsDai(): Promise<Token>;
+export declare function upgradeToLightNode(rpcProvider: string): Promise<void>;
+export declare function setJsonRpcInDesktop(value: string): Promise<void>;
+export declare function restartBeeNode(): Promise<void>;
+export declare function createGiftWallet(address: string): Promise<void>;
+export declare function performSwap(daiAmount: string): Promise<void>;
+export declare function getBeeDesktopLogs(): Promise<string>;
+export declare function getBeeLogs(): Promise<string>;
+export declare function getLatestBeeDesktopVersion(): Promise<string>;
+export {};

package/lib/src/utils/file.d.ts

@@ -0,0 +1,14 @@
+interface DetectedIndex {
+    indexPath: string;
+    commonPrefix?: string;
+}
+export declare function detectIndexHtml(files: FilePath[]): DetectedIndex | false;
+export declare function getHumanReadableFileSize(bytes: number): string;
+export declare function getAssetNameFromFiles(files: FilePath[]): string;
+export declare function getMetadata(files: FilePath[]): Metadata;
+export declare function getPath(file: FilePath): string;
+/**
+ * Utility function that is needed to have correct directory structure as webkitRelativePath is read only
+ */
+export declare function packageFile(file: FilePath, pathOverwrite?: string): FilePath;
+export {};

package/lib/src/utils/hash.d.ts

@@ -0,0 +1 @@
+export declare function shortenHash(hash: string, sliceLength?: number): string;

package/lib/src/utils/identity.d.ts

@@ -0,0 +1,9 @@
+import { Bee, BeeDebug } from '@ethersphere/bee-js';
+import { Wallet } from 'ethers';
+import { Identity, IdentityType } from '../providers/Feeds';
+export declare function generateWallet(): Wallet;
+export declare function persistIdentity(identities: Identity[], identity: Identity): void;
+export declare function persistIdentitiesWithoutUpdate(identities: Identity[]): void;
+export declare function convertWalletToIdentity(identity: Wallet, type: IdentityType, name: string, password?: string): Promise<Identity>;
+export declare function importIdentity(name: string, data: string): Promise<Identity | null>;
+export declare function updateFeed(beeApi: Bee, beeDebugApi: BeeDebug | null, identity: Identity, hash: string, stamp: string, password?: string): Promise<void>;

package/lib/src/utils/image.d.ts

@@ -0,0 +1,27 @@
+interface Dimensions {
+    width: number;
+    height: number;
+}
+/**
+ * Get the dimensions of the image after resize
+ *
+ * @param imgWidth  Current image width
+ * @param imgHeight Current image height
+ * @param maxWidth  Desired max width
+ * @param maxHeight Desired max height
+ *
+ * @returns Downscaled dimensions of the image to fit in the bounding box
+ */
+export declare function getDimensions(imgWidth: number, imgHeight: number, maxWidth?: number, maxHeight?: number): Dimensions;
+/**
+ * Resize image passed to fit in the bounding box defined with maxWidth and maxHeight.
+ * Note that one or both of the bounding box dimensions may be omitted
+ *
+ * @param file      Image file to be resized
+ * @param maxWidth  Maximal image width
+ * @param maxHeight Maximal image height
+ *
+ * @returns Promise that resolves into the resized image blob
+ */
+export declare function resize(file: File, maxWidth?: number, maxHeight?: number): Promise<Blob>;
+export {};

package/lib/src/utils/index.d.ts

@@ -0,0 +1,72 @@
+import { BatchId, BeeDebug, PostageBatch } from '@ethersphere/bee-js';
+import { BigNumber } from 'bignumber.js';
+import { Token } from '../models/Token';
+/**
+ * Test if value is an integer
+ *
+ * @param value Value to be tested if it is an integer
+ *
+ * @returns True if the passed in value is integer
+ */
+export declare function isInteger(value: unknown): value is BigNumber | bigint;
+/**
+ *Convert value into a BigNumber if not already
+ *
+ * @param value Value to be converted
+ *
+ * @throws {TypeError} if the value is not convertible to a BigNumber
+ *
+ * @returns BigNumber - but it may still be NaN or Infinite
+ */
+export declare function makeBigNumber(value: BigNumber | bigint | number | string): BigNumber | never;
+export declare type PromiseSettlements<T> = {
+    fulfilled: PromiseFulfilledResult<T>[];
+    rejected: PromiseRejectedResult[];
+};
+export declare type UnwrappedPromiseSettlements<T> = {
+    fulfilled: T[];
+    rejected: string[];
+};
+export declare function sleepMs(ms: number): Promise<void>;
+/**
+ * Maps the returned results of `Promise.allSettled` to an object
+ * with `fulfilled` and `rejected` arrays for easy access.
+ *
+ * The results still need to be unwrapped to get the fulfilled values or rejection reasons.
+ */
+export declare function mapPromiseSettlements<T>(promises: PromiseSettledResult<T>[]): PromiseSettlements<T>;
+/**
+ * Maps the returned values of `Promise.allSettled` to an object
+ * with `fulfilled` and `rejected` arrays for easy access.
+ *
+ * For rejected promises, the value is the stringified `reason`,
+ * or `'Unknown error'` string when it is unavailable.
+ */
+export declare function unwrapPromiseSettlements<T>(promiseSettledResults: PromiseSettledResult<T>[]): UnwrappedPromiseSettlements<T>;
+/**
+ * Wraps a `Promise<T>` or async function inside a new `Promise<T>`,
+ * which retries the original function up to `maxRetries` times,
+ * waiting `delayMs` milliseconds between failed attempts.
+ *
+ * If all attempts fail, then this `Promise<T>` also rejects.
+ */
+export declare function makeRetriablePromise<T>(fn: () => Promise<T>, maxRetries?: number, delayMs?: number): Promise<T>;
+export declare function extractSwarmHash(string: string): string | undefined;
+export declare function extractSwarmCid(s: string): string | undefined;
+export declare const regexpEns: RegExp;
+export declare function extractEns(value: string): string | undefined;
+export declare function recognizeEnsOrSwarmHash(value: string): string;
+export declare function uuidV4(): string;
+export declare function formatEnum(string: string): string;
+export declare function secondsToTimeString(seconds: number): string;
+export declare function convertDepthToBytes(depth: number): number;
+export declare function convertAmountToSeconds(amount: number, pricePerBlock: number): number;
+export declare function calculateStampPrice(depth: number, amount: bigint): Token;
+export declare function shortenText(text: string, length?: number, separator?: string): string;
+interface Options {
+    pollingFrequency?: number;
+    timeout?: number;
+}
+export declare function waitUntilStampUsable(batchId: BatchId, beeDebug: BeeDebug, options?: Options): Promise<PostageBatch>;
+export declare function waitUntilStampExists(batchId: BatchId, beeDebug: BeeDebug, options?: Options): Promise<PostageBatch>;
+export {};

package/lib/src/utils/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/src/utils/local-storage.d.ts

@@ -0,0 +1,12 @@
+export declare enum HISTORY_KEYS {
+    UPLOAD_HISTORY = "UPLOAD_HISTORY",
+    DOWNLOAD_HISTORY = "DOWNLOAD_HISTORY"
+}
+export interface HistoryItem {
+    createdAt: number;
+    name: string;
+    hash: string;
+}
+export declare function putHistory(key: string, hash: string, name: string): void;
+export declare function getHistorySafe(key: string): HistoryItem[];
+export declare function determineHistoryName(hash: string, indexDocument?: string | null): string;

package/lib/src/utils/net.d.ts

@@ -0,0 +1,3 @@
+export declare function getJson<T extends Record<string, any>>(url: string): Promise<T>;
+export declare function postJson<T extends Record<string, any>>(url: string, data?: T): Promise<T>;
+export declare function sendRequest(url: string, method: 'GET' | 'POST', data?: Record<string, unknown>): Promise<Record<string, any>>;

package/lib/src/utils/rpc.d.ts

@@ -0,0 +1,24 @@
+import { providers, BigNumber as BN } from 'ethers';
+declare function eth_getBalance(address: string, provider: providers.JsonRpcProvider): Promise<string>;
+declare function eth_getBlockByNumber(provider: providers.JsonRpcProvider): Promise<string>;
+declare function eth_getBalanceERC20(address: string, provider: providers.JsonRpcProvider, tokenAddress?: string): Promise<string>;
+interface TransferResponse {
+    transaction: providers.TransactionResponse;
+    receipt: providers.TransactionReceipt;
+}
+export declare function estimateNativeTransferTransactionCost(privateKey: string, jsonRpcProvider: string): Promise<{
+    gasPrice: BN;
+    totalCost: BN;
+}>;
+export declare function sendNativeTransaction(privateKey: string, to: string, value: string, jsonRpcProvider: string, externalGasPrice?: BN): Promise<TransferResponse>;
+export declare function sendBzzTransaction(privateKey: string, to: string, value: string, jsonRpcProvider: string): Promise<TransferResponse>;
+export declare const Rpc: {
+    sendNativeTransaction: typeof sendNativeTransaction;
+    sendBzzTransaction: typeof sendBzzTransaction;
+    _eth_getBalance: typeof eth_getBalance;
+    _eth_getBalanceERC20: typeof eth_getBalanceERC20;
+    eth_getBalance: typeof eth_getBalance & import("@material-ui/core/utils/debounce").Cancelable;
+    eth_getBalanceERC20: typeof eth_getBalanceERC20 & import("@material-ui/core/utils/debounce").Cancelable;
+    eth_getBlockByNumber: typeof eth_getBlockByNumber;
+};
+export {};

package/lib/src/utils/sentry.d.ts

@@ -0,0 +1 @@
+export declare function initSentry(): Promise<void>;

package/lib/src/utils/threshold.d.ts

@@ -0,0 +1,22 @@
+interface Threshold {
+    minimumValue: number;
+    explanation: string;
+    score: number;
+}
+declare type Thresholds = {
+    connectedPeers: Threshold[];
+    population: Threshold[];
+    depth: Threshold[];
+};
+declare type ThresholdValue = {
+    score: number;
+    maximumScore: number;
+    explanation: string;
+};
+export declare type ThresholdValues = {
+    connectedPeers: ThresholdValue;
+    population: ThresholdValue;
+    depth: ThresholdValue;
+};
+export declare function pickThreshold(key: keyof Thresholds, value: number): ThresholdValue;
+export {};

package/lib/src/utils/wallet.d.ts

@@ -0,0 +1,24 @@
+import { providers, Wallet } from 'ethers';
+import { BzzToken } from '../models/BzzToken';
+import { DaiToken } from '../models/DaiToken';
+export declare class WalletAddress {
+    address: string;
+    bzz: BzzToken;
+    dai: DaiToken;
+    provider: providers.JsonRpcProvider;
+    private constructor();
+    static make(address: string, provider: providers.JsonRpcProvider): Promise<WalletAddress>;
+    refresh(): Promise<WalletAddress>;
+}
+export declare class ResolvedWallet {
+    wallet: Wallet;
+    bzz: BzzToken;
+    dai: DaiToken;
+    provider: providers.JsonRpcProvider;
+    address: string;
+    privateKey: string;
+    private constructor();
+    static make(privateKeyOrWallet: string | Wallet, provider: providers.JsonRpcProvider): Promise<ResolvedWallet>;
+    refresh(): Promise<ResolvedWallet>;
+    transfer(destination: string, jsonRpcProvider: string): Promise<void>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-dashboard",
-  "version": "0.19.0",
+  "version": "0.19.1",
   "description": "An app which helps users to setup their Bee node and do actions like cash out cheques",
   "keywords": [
     "bee",
@@ -129,7 +129,7 @@
     "start": "react-scripts start",
     "desktop": "node ./desktop.mjs",
     "build": "react-scripts build",
-    "build:component": "rimraf ./lib && webpack --mode=production",
+    "build:component": "rimraf ./lib && webpack --mode=production && npm run compile:types",
     "compile:types": "tsc --project tsconfig.lib.json --emitDeclarationOnly --declaration",
     "test": "react-scripts test",
     "test:ui": "node ui-test/index.js",