@upcoming/bee-js 0.1.0 → 0.2.0

package/dist/types/modules/gsoc.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="ws" />
+import WebSocket from 'isomorphic-ws';
+import { BeeRequestOptions, UploadOptions } from '..';
+import { SingleOwnerChunk } from '../chunk/soc';
+import { BatchId, Reference } from '../utils/typed-bytes';
+export declare function send(requestOptions: BeeRequestOptions, soc: SingleOwnerChunk, stamp: BatchId, options?: UploadOptions): Promise<import("..").UploadResult>;
+export declare function subscribe(url: string, reference: Reference, headers?: Record<string, string>): WebSocket;

package/dist/types/types/debug.d.ts

@@ -1,17 +1,18 @@
-import { EthAddress, PublicKey, TransactionId } from '../utils/typed-bytes';
+import { BZZ, DAI } from '../utils/tokens';
+import { EthAddress, PeerAddress, PublicKey, TransactionId } from '../utils/typed-bytes';
 import { NumberString } from './index';
 export interface Settlements {
     peer: string;
-    received: NumberString;
-    sent: NumberString;
+    received: BZZ;
+    sent: BZZ;
 }
 export interface AllSettlements {
-    totalReceived: NumberString;
-    totalSent: NumberString;
+    totalReceived: BZZ;
+    totalSent: BZZ;
     settlements: Settlements[];
 }
 export interface NodeAddresses {
-    overlay: string;
+    overlay: PeerAddress;
     underlay: string[];
     ethereum: EthAddress;
     publicKey: PublicKey;
@@ -25,8 +26,8 @@ export interface ChequebookAddressResponse {
     chequebookAddress: string;
 }
 export interface ChequebookBalanceResponse {
-    totalBalance: NumberString;
-    availableBalance: NumberString;
+    totalBalance: BZZ;
+    availableBalance: BZZ;
 }
 export interface TransactionOptions {
     /**
@@ -41,12 +42,12 @@ export interface TransactionOptions {
 export type CashoutOptions = TransactionOptions;
 export interface CashoutResult {
     recipient: string;
-    lastPayout: NumberString;
+    lastPayout: BZZ;
     bounced: boolean;
 }
 export interface LastCashoutActionResponse {
     peer: string;
-    uncashedAmount: NumberString;
+    uncashedAmount: BZZ;
     transactionHash: string | null;
     lastCashedCheque: Cheque | null;
     result: CashoutResult | null;
@@ -57,7 +58,7 @@ export interface TransactionResponse {
 export interface Cheque {
     beneficiary: EthAddress;
     chequebook: EthAddress;
-    payout: NumberString;
+    payout: BZZ;
 }
 export interface LastChequesForPeerResponse {
     peer: string;
@@ -113,7 +114,7 @@ export declare enum BeeModes {
 }
 export declare function toBeeMode(value: string): BeeModes;
 export interface RedistributionState {
-    minimumGasFunds: NumberString;
+    minimumGasFunds: DAI;
     hasSufficientFunds: boolean;
     isFrozen: boolean;
     isFullySynced: boolean;
@@ -125,8 +126,8 @@ export interface RedistributionState {
     lastSelectedRound: number;
     lastSampleDurationSeconds: number;
     block: number;
-    reward: NumberString;
-    fees: NumberString;
+    reward: BZZ;
+    fees: DAI;
     isHealthy: boolean;
 }
 /**
@@ -219,8 +220,8 @@ export interface ChainState {
     currentPrice: NumberString;
 }
 export interface WalletBalance {
-    bzzBalance: NumberString;
-    nativeTokenBalance: NumberString;
+    bzzBalance: BZZ;
+    nativeTokenBalance: DAI;
     chainID: number;
     chequebookContractAddress: string;
     walletAddress: string;

package/dist/types/types/index.d.ts

@@ -261,6 +261,14 @@ export interface PssMessageHandler {
     onMessage: (message: Bytes, subscription: PssSubscription) => void;
     onError: (error: BeeError, subscription: PssSubscription) => void;
 }
+export interface GsocSubscription {
+    readonly address: EthAddress;
+    cancel: () => void;
+}
+export interface GsocMessageHandler {
+    onMessage: (message: Bytes, subscription: GsocSubscription) => void;
+    onError: (error: BeeError, subscription: GsocSubscription) => void;
+}
 export interface ReferenceResponse {
     reference: Reference;
 }

package/dist/types/utils/expose.d.ts

@@ -2,4 +2,4 @@ export { getCollectionSize } from './collection';
 export { getFolderSize } from './collection.node';
 export { makeMaxTarget } from './pss';
 export { approximateOverheadForRedundancyLevel, getRedundancyStat, getRedundancyStats } from './redundancy';
-export { getAmountForTtl, getDepthForCapacity, getStampCostInBzz, getStampCostInPlur, getStampEffectiveBytes, getStampMaximumCapacityBytes, getStampTtlSeconds, getStampUsage, } from './stamps';
+export { getAmountForTtl, getDepthForCapacity, getStampCost, getStampEffectiveBytes, getStampMaximumCapacityBytes, getStampTtlSeconds, getStampUsage, } from './stamps';

package/dist/types/utils/pss.d.ts

@@ -1,3 +1,4 @@
+import { PeerAddress } from './typed-bytes';
 /**
  * Utility function that for given strings/reference takes the most specific
  * target that Bee node will except.
@@ -5,4 +6,4 @@
  * @param target is a non-prefixed hex string Bee address
  * @see [Bee docs - PSS](https://docs.ethswarm.org/docs/develop/tools-and-features/pss)
  */
-export declare function makeMaxTarget(target: string): string;
+export declare function makeMaxTarget(target: PeerAddress | Uint8Array | string): string;

package/dist/types/utils/stamps.d.ts

@@ -1,5 +1,6 @@
 import { EnvelopeWithBatchId, NumberString } from '../types';
 import { Bytes } from './bytes';
+import { BZZ } from './tokens';
 /**
  * Utility function that calculates usage of postage batch based on its utilization, depth and bucket depth.
  *
@@ -27,18 +28,8 @@ export declare function getStampMaximumCapacityBytes(depth: number): number;
 export declare function getStampEffectiveBytes(depth: number): number;
 /**
  * Utility function that calculates the cost of a postage batch based on its depth and amount.
- *
- * @returns {number} The cost of the postage batch in PLUR (10000000000000000 [1e16] PLUR = 1 BZZ)
- */
-export declare function getStampCostInPlur(depth: number, amount: NumberString | string | bigint): bigint;
-/**
- * Utility function that calculates the cost of a postage batch based on its depth and amount.
- *
- * The returned number is lossy and should be used for display purposes only.
- *
- * @returns {number} The cost of the postage batch in BZZ (1 BZZ = 10000000000000000 [1e16] PLUR)
  */
-export declare function getStampCostInBzz(depth: number, amount: NumberString | string | bigint): number;
+export declare function getStampCost(depth: number, amount: NumberString | string | bigint): BZZ;
 /**
  * Utility function that calculates the TTL of a postage batch based on its amount, price per block and block time.
  *

package/dist/types/utils/tokens.d.ts

@@ -0,0 +1,21 @@
+import { NumberString } from '..';
+export declare class BZZ {
+    static readonly DIGITS = 16;
+    private state;
+    private constructor();
+    static fromDecimalString(string: string): BZZ;
+    static fromPLUR(plur: NumberString | string | bigint): BZZ;
+    toPLURString(): string;
+    toPLURBigInt(): bigint;
+    toDecimalString(): string;
+}
+export declare class DAI {
+    static readonly DIGITS = 18;
+    private state;
+    private constructor();
+    static fromDecimalString(string: string): DAI;
+    static fromWei(wei: NumberString | string | bigint): DAI;
+    toWeiString(): string;
+    toWeiBigInt(): bigint;
+    toDecimalString(): string;
+}

package/dist/types/utils/type.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import * as stream from 'stream';
-import { AllTagsOptions, BeeRequestOptions, CashoutOptions, CollectionUploadOptions, FileUploadOptions, NumberString, PostageBatchOptions, PssMessageHandler, Tag, TransactionOptions, UploadOptions } from '../types';
+import { AllTagsOptions, BeeRequestOptions, CashoutOptions, CollectionUploadOptions, FileUploadOptions, GsocMessageHandler, NumberString, PostageBatchOptions, PssMessageHandler, Tag, TransactionOptions, UploadOptions } from '../types';
 export declare function isReadable(obj: unknown): obj is stream.Readable;
 export declare function asNumberString(value: unknown, options?: {
     name?: string;
@@ -20,6 +20,7 @@ export declare function assertFileUploadOptions(value: unknown): asserts value i
 export declare function assertCollectionUploadOptions(value: unknown): asserts value is CollectionUploadOptions;
 export declare function isTag(value: unknown): value is Tag;
 export declare function assertPssMessageHandler(value: unknown): asserts value is PssMessageHandler;
+export declare function assertGsocMessageHandler(value: unknown): asserts value is GsocMessageHandler;
 export declare function assertPostageBatchOptions(value: unknown): asserts value is PostageBatchOptions;
 export declare function assertTransactionOptions(value: unknown, name?: string): asserts value is TransactionOptions;
 export declare function assertCashoutOptions(value: unknown): asserts value is CashoutOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@upcoming/bee-js",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",
@@ -63,7 +63,7 @@
   },
   "dependencies": {
     "axios": "^0.28.1",
-    "cafe-utility": "^27.5.0",
+    "cafe-utility": "^27.6.0",
     "isomorphic-ws": "^4.0.1",
     "semver": "^7.3.5",
     "ws": "^8.7.0"