@ethersphere/bee-js 8.3.1 → 9.0.2

package/dist/types/chunk/span.d.ts

@@ -1,10 +0,0 @@
-import { Bytes } from '../utils/bytes';
-export declare const SPAN_SIZE = 8;
-/**
- * Create a span for storing the length of the chunk
- *
- * The length is encoded in 64-bit little endian.
- *
- * @param length The length of the span
- */
-export declare function makeSpan(length: number): Bytes<8>;

package/dist/types/feed/json.d.ts

@@ -1,4 +0,0 @@
-import { Bee } from '../bee';
-import { AnyJson, BatchId, BeeRequestOptions, FeedReader, FeedWriter, JsonFeedOptions, UploadOptions, UploadResult } from '../types';
-export declare function getJsonData<T extends AnyJson>(bee: Bee, reader: FeedReader): Promise<T>;
-export declare function setJsonData(bee: Bee, writer: FeedWriter, postageBatchId: BatchId, data: AnyJson, options?: JsonFeedOptions & UploadOptions, requestOptions?: BeeRequestOptions): Promise<UploadResult>;

package/dist/types/feed/topic.d.ts

@@ -1,3 +0,0 @@
-import { Topic } from '../types';
-export declare function makeTopic(topic: Uint8Array | string): Topic;
-export declare function makeTopicFromString(s: string): Topic;

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

@@ -1,6 +0,0 @@
-declare const feedTypes: readonly ["sequence", "epoch"];
-export type FeedType = typeof feedTypes[number];
-export declare const DEFAULT_FEED_TYPE: FeedType;
-export declare function isFeedType(type: unknown): type is FeedType;
-export declare function assertFeedType(type: unknown): asserts type is FeedType;
-export {};

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

@@ -1,10 +0,0 @@
-import type { BeeGenericResponse, BeeRequestOptions } from '../../types';
-/**
- * Check if chunk at address exists locally
- *
- * @param requestOptions Options for making requests
- * @param address  Swarm address of chunk
- *
- * @returns BeeGenericResponse if chunk is found or throws an exception
- */
-export declare function checkIfChunkExistsLocally(requestOptions: BeeRequestOptions, address: string): Promise<BeeGenericResponse>;

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

@@ -1,8 +0,0 @@
-import { BeeRequestOptions, ExtendedTag } from '../../types';
-/**
- * Retrieve tag with extended information from Bee node
- *
- * @param requestOptions Options for making requests
- * @param uid UID of tag to be retrieved
- */
-export declare function retrieveExtendedTag(requestOptions: BeeRequestOptions, uid: number): Promise<ExtendedTag>;

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

@@ -1,67 +0,0 @@
-import { BrandedString, Signer } from '../types';
-import { Bytes } from './bytes';
-import { HexString } from './hex';
-export type OverlayAddress = BrandedString<'OverlayAddress'>;
-export type EthAddress = Bytes<20>;
-export type HexEthAddress = HexString<40>;
-export declare function capitalizeAddressERC55(address: string): string;
-export declare function makeEthAddress(address: EthAddress | Uint8Array | string | unknown): EthAddress;
-export declare function makeHexEthAddress(address: EthAddress | Uint8Array | string | unknown): HexEthAddress;
-/**
- * Check if is valid ethereum address
- *
- * Pretty much typed version from web3js
- * https://github.com/ChainSafe/web3.js/blob/1.x/packages/web3-utils/src/utils.js
- *
- * @param address  Ethereum address as hex string
- *
- * @return True if is valid eth address
- */
-export declare function isHexEthAddress(address: string | HexString | HexEthAddress): address is HexEthAddress;
-/**
- * Convert big-endian hex or number to little-endian.
- * Note: Before conversion it is automatically padded to even length hexstring
- *
- * @param bigEndian Big-endian hex string or number to convert
- * @param pad       Length to which the string should be padded before conversion (defaul: 2)
- *
- * @return little-endian encoded hexstring
- */
-export declare function toLittleEndian(bigEndian: number | string | HexString, pad?: number): HexString | never;
-/**
- * Convert little-endian hex or number to big-endian
- * Note: Before conversion it is automatically padded to even length hexstring
- *
- * @param littleEndian Little-endian hex string or number to convert
- * @param pad          Length to which the string should be padded before conversion (defaul: 2)
- *
- * @return big-endian encoded hexstring
- */
-export declare function fromLittleEndian(littleEndian: number | string | HexString, pad?: number): HexString | never;
-/**
- * Get swarm overlay address from public ethereum address and swarm network id
- *
- * @param ethAddress  Public ethereum address
- * @param networkId   Swarm network id
- *
- * @return Swarm overlay address
- */
-export declare function ethToSwarmAddress(ethAddress: string | HexString | HexEthAddress, networkId?: number): OverlayAddress;
-interface RequestArguments {
-    method: string;
-    jsonrpc?: string;
-    params?: unknown[] | Record<string, unknown>;
-}
-export interface JsonRPC {
-    request?(args: RequestArguments): Promise<unknown>;
-    sendAsync?(args: RequestArguments): Promise<unknown>;
-}
-/**
- * Function that takes Ethereum EIP-1193 compatible provider and create an Signer instance that
- * uses `personal_sign` method to sign requested data.
- *
- * @param provider Injected web3 provider like window.ethereum or other compatible with EIP-1193
- * @param ethAddress Optional address of the account which the data should be signed with. If not specified `eth_requestAccounts` request is used to get the account address.
- */
-export declare function makeEthereumWalletSigner(provider: JsonRPC, ethAddress?: string | HexString | HexEthAddress): Promise<Signer>;
-export {};

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

@@ -1,9 +0,0 @@
-import { Message } from 'js-sha3';
-import { Bytes } from './bytes';
-/**
- * Helper function for calculating the keccak256 hash with
- * correct types.
- *
- * @param messages Any number of messages (strings, byte arrays etc.)
- */
-export declare function keccak256Hash(...messages: Message[]): Bytes<32>;

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

@@ -1,86 +0,0 @@
-import { Bytes } from './bytes';
-import { BrandedType, FlavoredType } from '../types';
-/**
- * Nominal type to represent hex strings WITHOUT '0x' prefix.
- * For example for 32 bytes hex representation you have to use 64 length.
- * TODO: Make Length mandatory: https://github.com/ethersphere/bee-js/issues/208
- */
-export type HexString<Length extends number = number> = FlavoredType<string & {
-    readonly length: Length;
-}, 'HexString'>;
-/**
- * Type for HexString with prefix.
- * The main hex type used internally should be non-prefixed HexString
- * and therefore this type should be used as least as possible.
- * Because of that it does not contain the Length property as the variables
- * should be validated and converted to HexString ASAP.
- */
-export type PrefixedHexString = BrandedType<string, 'PrefixedHexString'>;
-/**
- * Creates unprefixed hex string from wide range of data.
- *
- * TODO: Make Length mandatory: https://github.com/ethersphere/bee-js/issues/208
- *
- * @param input
- * @param len of the resulting HexString WITHOUT prefix!
- */
-export declare function makeHexString<L extends number>(input: string | number | Uint8Array | unknown, len?: L): HexString<L>;
-/**
- * Converts a hex string to Uint8Array
- *
- * @param hex string input without 0x prefix!
- */
-export declare function hexToBytes<Length extends number, LengthHex extends number = number>(hex: HexString<LengthHex>): Bytes<Length>;
-/**
- * Converts array of number or Uint8Array to HexString without prefix.
- *
- * @param bytes   The input array
- * @param len     The length of the non prefixed HexString
- */
-export declare function bytesToHex<Length extends number = number>(bytes: Uint8Array, len?: Length): HexString<Length>;
-/**
- * Converts integer number to hex string.
- *
- * Optionally provides '0x' prefix or padding
- *
- * @param int         The positive integer to be converted
- * @param len     The length of the non prefixed HexString
- */
-export declare function intToHex<Length extends number = number>(int: number, len?: Length): HexString<Length>;
-/**
- * Type guard for HexStrings.
- * Requires no 0x prefix!
- *
- * TODO: Make Length mandatory: https://github.com/ethersphere/bee-js/issues/208
- *
- * @param s string input
- * @param len expected length of the HexString
- */
-export declare function isHexString<Length extends number = number>(s: unknown, len?: number): s is HexString<Length>;
-/**
- * Type guard for PrefixedHexStrings.
- * Does enforce presence of 0x prefix!
- *
- * @param s string input
- */
-export declare function isPrefixedHexString(s: unknown): s is PrefixedHexString;
-/**
- * Verifies if the provided input is a HexString.
- *
- * TODO: Make Length mandatory: https://github.com/ethersphere/bee-js/issues/208
- *
- * @param s string input
- * @param len expected length of the HexString
- * @param name optional name for the asserted value
- * @returns HexString or throws error
- */
-export declare function assertHexString<Length extends number = number>(s: unknown, len?: number, name?: string): asserts s is HexString<Length>;
-/**
- * Verifies if the provided input is a PrefixedHexString.
- *
- * @param s string input
- * @param len expected length of the HexString
- * @param name optional name for the asserted value
- * @returns HexString or throws error
- */
-export declare function assertPrefixedHexString(s: string, name?: string): asserts s is PrefixedHexString;

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

@@ -1,2 +0,0 @@
-import { BytesReference, Reference } from '../types';
-export declare function makeBytesReference(reference: Uint8Array | BytesReference | Reference, offset?: number): BytesReference;