Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update imports for Node 23 compatibility #28

Open
wants to merge 29 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
d2d1a0c
Update Indexer.d.ts
madschristensen99 Jan 23, 2025
668e9ea
Update types.js
madschristensen99 Jan 23, 2025
0e10485
Update builder.js
madschristensen99 Jan 23, 2025
57052af
Update AbstractFile.d.ts
madschristensen99 Jan 23, 2025
ee4a343
Update Downloader.js
madschristensen99 Jan 23, 2025
cc5b9bc
Update Uploader.js
madschristensen99 Jan 23, 2025
6dae02b
Update types.d.ts
madschristensen99 Jan 23, 2025
8afe9e9
Update Uploader.d.ts
madschristensen99 Jan 23, 2025
c145406
Update utils.d.ts
madschristensen99 Jan 23, 2025
38c411a
Update Indexer.d.ts
madschristensen99 Jan 23, 2025
423095f
Update Indexer.d.ts
madschristensen99 Jan 23, 2025
d4097cc
Update AbstractFile.d.ts
madschristensen99 Jan 23, 2025
5fc316f
Update types.d.ts
madschristensen99 Jan 23, 2025
8a4e084
Update Uploader.d.ts
madschristensen99 Jan 23, 2025
0f18896
Update utils.d.ts
madschristensen99 Jan 23, 2025
566c6fd
Update Indexer.ts
madschristensen99 Jan 23, 2025
d2c07ea
Update utils.ts
madschristensen99 Jan 23, 2025
6c5825c
Update builder.ts
madschristensen99 Jan 23, 2025
a9278ae
Update types.ts
madschristensen99 Jan 23, 2025
8e7aa2a
Update AbstractFile.ts
madschristensen99 Jan 23, 2025
9f2708f
Update Downloader.ts
madschristensen99 Jan 23, 2025
f820597
Update Uploader.ts
madschristensen99 Jan 23, 2025
c527c93
Update types.ts
madschristensen99 Jan 23, 2025
1634dd8
Update Indexer.d.ts
madschristensen99 Jan 23, 2025
202a5b5
Update AbstractFile.d.ts
madschristensen99 Jan 23, 2025
f86e0ba
Update types.d.ts
madschristensen99 Jan 23, 2025
6ef3c8d
Update Uploader.d.ts
madschristensen99 Jan 23, 2025
134ffa0
Update utils.d.ts
madschristensen99 Jan 23, 2025
612c629
Update README.md
madschristensen99 Jan 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ Use `ZgFile` to create a file object, then call `merkleTree` method to get the m

```js
import { Indexer, ZgFile } from '@0glabs/0g-ts-sdk';
import { ethers } from 'ethers';
import pkg from 'ethers';
const { ethers, BrowserProvider } = pkg;
import { exit } from 'process';

const file = await ZgFile.fromFilePath(<file_path>);
Expand Down
5 changes: 3 additions & 2 deletions lib.commonjs/file/AbstractFile.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { BytesLike } from 'ethers';
import pkg from 'ethers';
const { BytesLike } = pkg;
import { MerkleTree } from './MerkleTree.js';
import { SubmissionNodeStruct, SubmissionStruct } from '../contracts/flow/FixedPriceFlow.js';
import { Iterator } from './Iterator/index.js';
Expand All @@ -16,4 +17,4 @@ export declare abstract class AbstractFile {
createNode(offset: number, chunks: number): Promise<[SubmissionNodeStruct | null, Error | null]>;
createSegmentNode(offset: number, batch: number, size: number): Promise<[SubmissionNodeStruct | null, Error | null]>;
}
//# sourceMappingURL=AbstractFile.d.ts.map
//# sourceMappingURL=AbstractFile.d.ts.map
5 changes: 3 additions & 2 deletions lib.commonjs/indexer/Indexer.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ import { UploadOption, Uploader } from '../transfer/index.js';
import { StorageNode } from '../node/index.js';
import { RetryOpts } from '../types.js';
import { AbstractFile } from '../file/AbstractFile.js';
import { ethers } from 'ethers';
import pkg from 'ethers';
const { ethers } = pkg;
export declare class Indexer extends HttpProvider {
constructor(url: string);
getShardedNodes(): Promise<ShardedNodes>;
Expand All @@ -16,4 +17,4 @@ export declare class Indexer extends HttpProvider {
upload(file: AbstractFile, blockchain_rpc: string, signer: ethers.Wallet, opts?: UploadOption, retryOpts?: RetryOpts): Promise<[string, Error | null]>;
download(rootHash: string, filePath: string, proof: boolean): Promise<Error | null>;
}
//# sourceMappingURL=Indexer.d.ts.map
//# sourceMappingURL=Indexer.d.ts.map
5 changes: 3 additions & 2 deletions lib.commonjs/transfer/Uploader.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ import { StorageNode, SegmentWithProof, FileInfo } from '../node/index.js';
import { FixedPriceFlow } from '../contracts/flow/FixedPriceFlow.js';
import { RetryOpts } from '../types.js';
import { MerkleTree } from '../file/index.js';
import { ethers } from 'ethers';
import pkg from 'ethers';
const { ethers } = pkg;
import { UploadOption, UploadTask } from './types.js';
import { AbstractFile } from '../file/AbstractFile.js';
export declare class Uploader {
Expand All @@ -21,4 +22,4 @@ export declare class Uploader {
getSegment(file: AbstractFile, tree: MerkleTree, segIndex: number): Promise<[boolean, SegmentWithProof | null, Error | null]>;
uploadTask(file: AbstractFile, tree: MerkleTree, uploadTask: UploadTask): Promise<number | Error>;
}
//# sourceMappingURL=Uploader.d.ts.map
//# sourceMappingURL=Uploader.d.ts.map
5 changes: 3 additions & 2 deletions lib.commonjs/transfer/types.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ethers } from 'ethers';
import pkg from 'ethers';
const { ethers } = pkg;
export interface UploadTask {
clientIndex: number;
taskSize: number;
Expand All @@ -15,4 +16,4 @@ export interface UploadOption {
fee: bigint;
}
export declare var defaultUploadOption: UploadOption;
//# sourceMappingURL=types.d.ts.map
//# sourceMappingURL=types.d.ts.map
6 changes: 3 additions & 3 deletions lib.commonjs/utils.d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { Signer } from 'ethers';
import { ContractRunner } from 'ethers';
import pkg from 'ethers';
const { Signer, ContractRunner } = pkg;
export declare function getFlowContract(address: string, signer: Signer): import("./contracts/flow/FixedPriceFlow.js").FixedPriceFlow;
export declare function getMarketContract(address: string, runner: ContractRunner): import("./contracts/market/FixedPrice.js").FixedPrice;
export declare function checkExist(inputPath: string): boolean;
export declare function GetSplitNum(total: number, unit: number): number;
export declare const delay: (ms: number) => Promise<unknown>;
//# sourceMappingURL=utils.d.ts.map
//# sourceMappingURL=utils.d.ts.map
5 changes: 3 additions & 2 deletions lib.esm/file/AbstractFile.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { BytesLike } from 'ethers';
import pkg from 'ethers';
const { BytesLike } = pkg;
import { MerkleTree } from './MerkleTree.js';
import { SubmissionNodeStruct, SubmissionStruct } from '../contracts/flow/FixedPriceFlow.js';
import { Iterator } from './Iterator/index.js';
Expand All @@ -16,4 +17,4 @@ export declare abstract class AbstractFile {
createNode(offset: number, chunks: number): Promise<[SubmissionNodeStruct | null, Error | null]>;
createSegmentNode(offset: number, batch: number, size: number): Promise<[SubmissionNodeStruct | null, Error | null]>;
}
//# sourceMappingURL=AbstractFile.d.ts.map
//# sourceMappingURL=AbstractFile.d.ts.map
5 changes: 3 additions & 2 deletions lib.esm/indexer/Indexer.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ import { UploadOption, Uploader } from '../transfer/index.js';
import { StorageNode } from '../node/index.js';
import { RetryOpts } from '../types.js';
import { AbstractFile } from '../file/AbstractFile.js';
import { ethers } from 'ethers';
import pkg from 'ethers';
const { ethers } = pkg;
export declare class Indexer extends HttpProvider {
constructor(url: string);
getShardedNodes(): Promise<ShardedNodes>;
Expand All @@ -16,4 +17,4 @@ export declare class Indexer extends HttpProvider {
upload(file: AbstractFile, blockchain_rpc: string, signer: ethers.Wallet, opts?: UploadOption, retryOpts?: RetryOpts): Promise<[string, Error | null]>;
download(rootHash: string, filePath: string, proof: boolean): Promise<Error | null>;
}
//# sourceMappingURL=Indexer.d.ts.map
//# sourceMappingURL=Indexer.d.ts.map
5 changes: 3 additions & 2 deletions lib.esm/kv/builder.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions lib.esm/kv/types.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions lib.esm/transfer/Downloader.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions lib.esm/transfer/Uploader.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ import { StorageNode, SegmentWithProof, FileInfo } from '../node/index.js';
import { FixedPriceFlow } from '../contracts/flow/FixedPriceFlow.js';
import { RetryOpts } from '../types.js';
import { MerkleTree } from '../file/index.js';
import { ethers } from 'ethers';
import pkg from 'ethers';
const { ethers } = pkg;
import { UploadOption, UploadTask } from './types.js';
import { AbstractFile } from '../file/AbstractFile.js';
export declare class Uploader {
Expand All @@ -21,4 +22,4 @@ export declare class Uploader {
getSegment(file: AbstractFile, tree: MerkleTree, segIndex: number): Promise<[boolean, SegmentWithProof | null, Error | null]>;
uploadTask(file: AbstractFile, tree: MerkleTree, uploadTask: UploadTask): Promise<number | Error>;
}
//# sourceMappingURL=Uploader.d.ts.map
//# sourceMappingURL=Uploader.d.ts.map
5 changes: 3 additions & 2 deletions lib.esm/transfer/Uploader.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions lib.esm/transfer/types.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ethers } from 'ethers';
import pkg from 'ethers';
const { ethers } = pkg;
export interface UploadTask {
clientIndex: number;
taskSize: number;
Expand All @@ -15,4 +16,4 @@ export interface UploadOption {
fee: bigint;
}
export declare var defaultUploadOption: UploadOption;
//# sourceMappingURL=types.d.ts.map
//# sourceMappingURL=types.d.ts.map
6 changes: 3 additions & 3 deletions lib.esm/utils.d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { Signer } from 'ethers';
import { ContractRunner } from 'ethers';
import pkg from 'ethers';
const { Signer, ContractRunner } = pkg;
export declare function getFlowContract(address: string, signer: Signer): import("./contracts/flow/FixedPriceFlow.js").FixedPriceFlow;
export declare function getMarketContract(address: string, runner: ContractRunner): import("./contracts/market/FixedPrice.js").FixedPrice;
export declare function checkExist(inputPath: string): boolean;
export declare function GetSplitNum(total: number, unit: number): number;
export declare const delay: (ms: number) => Promise<unknown>;
//# sourceMappingURL=utils.d.ts.map
//# sourceMappingURL=utils.d.ts.map
3 changes: 2 additions & 1 deletion src.ts/file/AbstractFile.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { BytesLike } from 'ethers'
import pkg from 'ethers';
const { BytesLike } = pkg;
import { MerkleTree } from './MerkleTree.js'
import {
SubmissionNodeStruct,
Expand Down
3 changes: 2 additions & 1 deletion src.ts/indexer/Indexer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ import { UploadOption, Uploader, Downloader } from '../transfer/index.js'
import { StorageNode } from '../node/index.js'
import { RetryOpts } from '../types.js'
import { AbstractFile } from '../file/AbstractFile.js'
import { ethers } from 'ethers'
import pkg from 'ethers';
const { ethers } = pkg;
import { getFlowContract } from '../utils.js'

export class Indexer extends HttpProvider {
Expand Down
3 changes: 2 additions & 1 deletion src.ts/kv/builder.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ethers } from 'ethers'
import pkg from 'ethers';
const { ethers } = pkg;
import { MAX_KEY_SIZE, MAX_SET_SIZE, STREAM_DOMAIN } from './constants.js'
import { AccessControl, StreamData } from './types.js'
import { Bytes } from '@ethersproject/bytes'
Expand Down
4 changes: 2 additions & 2 deletions src.ts/kv/types.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ethers } from 'ethers'

import pkg from 'ethers';
const { ethers } = pkg;
// Assuming common.Hash and common.Address are hex strings
type Hash = string
type Address = string
Expand Down
3 changes: 2 additions & 1 deletion src.ts/transfer/Downloader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ import fs from 'fs'
import { DEFAULT_SEGMENT_MAX_CHUNKS, DEFAULT_CHUNK_SIZE } from '../constant.js'
import { GetSplitNum, checkExist } from '../utils.js'
import { StorageNode, Segment, FileInfo } from '../node/index.js'
import { decodeBase64 } from 'ethers'
import pkg from 'ethers';
const { decodeBase64 } = pkg;
import { Hash } from '../types.js'
import { getShardConfigs } from './utils.js'
import { ShardConfig } from '../common/index.js'
Expand Down
3 changes: 2 additions & 1 deletion src.ts/transfer/Uploader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ import { FixedPriceFlow } from '../contracts/flow/FixedPriceFlow.js'
import { delay, getMarketContract } from '../utils.js'
import { RetryOpts } from '../types.js'
import { MerkleTree, numSplits } from '../file/index.js'
import { encodeBase64, ethers } from 'ethers'
import pkg from 'ethers';
const { encodeBase64, ethers } = pkg;
import { calculatePrice, getShardConfigs } from './utils.js'
import { UploadOption, UploadTask } from './types.js'
import { AbstractFile } from '../file/AbstractFile.js'
Expand Down
3 changes: 2 additions & 1 deletion src.ts/transfer/types.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ethers } from 'ethers'
import pkg from 'ethers';
const { ethers } = pkg;

export interface UploadTask {
clientIndex: number
Expand Down
4 changes: 2 additions & 2 deletions src.ts/utils.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { Signer } from 'ethers'
import { FixedPriceFlow__factory } from './contracts/flow/index.js'
import { FixedPrice__factory } from './contracts/market/index.js'
import fs from 'fs'
import path from 'path'
import { ContractRunner } from 'ethers'
import pkg from 'ethers';
const { Signer, ContractRunner } = pkg;

export function getFlowContract(address: string, signer: Signer) {
return FixedPriceFlow__factory.connect(address, signer)
Expand Down
5 changes: 3 additions & 2 deletions types/file/AbstractFile.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { BytesLike } from 'ethers';
import pkg from 'ethers';
const { BytesLike } = pkg;
import { MerkleTree } from './MerkleTree.js';
import { SubmissionNodeStruct, SubmissionStruct } from '../contracts/flow/FixedPriceFlow.js';
import { Iterator } from './Iterator/index.js';
Expand All @@ -16,4 +17,4 @@ export declare abstract class AbstractFile {
createNode(offset: number, chunks: number): Promise<[SubmissionNodeStruct | null, Error | null]>;
createSegmentNode(offset: number, batch: number, size: number): Promise<[SubmissionNodeStruct | null, Error | null]>;
}
//# sourceMappingURL=AbstractFile.d.ts.map
//# sourceMappingURL=AbstractFile.d.ts.map
5 changes: 3 additions & 2 deletions types/indexer/Indexer.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ import { UploadOption, Uploader } from '../transfer/index.js';
import { StorageNode } from '../node/index.js';
import { RetryOpts } from '../types.js';
import { AbstractFile } from '../file/AbstractFile.js';
import { ethers } from 'ethers';
import pkg from 'ethers';
const { ethers } = pkg;
export declare class Indexer extends HttpProvider {
constructor(url: string);
getShardedNodes(): Promise<ShardedNodes>;
Expand All @@ -16,4 +17,4 @@ export declare class Indexer extends HttpProvider {
upload(file: AbstractFile, blockchain_rpc: string, signer: ethers.Wallet, opts?: UploadOption, retryOpts?: RetryOpts): Promise<[string, Error | null]>;
download(rootHash: string, filePath: string, proof: boolean): Promise<Error | null>;
}
//# sourceMappingURL=Indexer.d.ts.map
//# sourceMappingURL=Indexer.d.ts.map
5 changes: 3 additions & 2 deletions types/transfer/Uploader.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ import { StorageNode, SegmentWithProof, FileInfo } from '../node/index.js';
import { FixedPriceFlow } from '../contracts/flow/FixedPriceFlow.js';
import { RetryOpts } from '../types.js';
import { MerkleTree } from '../file/index.js';
import { ethers } from 'ethers';
import pkg from 'ethers';
const { ethers } = pkg;
import { UploadOption, UploadTask } from './types.js';
import { AbstractFile } from '../file/AbstractFile.js';
export declare class Uploader {
Expand All @@ -21,4 +22,4 @@ export declare class Uploader {
getSegment(file: AbstractFile, tree: MerkleTree, segIndex: number): Promise<[boolean, SegmentWithProof | null, Error | null]>;
uploadTask(file: AbstractFile, tree: MerkleTree, uploadTask: UploadTask): Promise<number | Error>;
}
//# sourceMappingURL=Uploader.d.ts.map
//# sourceMappingURL=Uploader.d.ts.map
5 changes: 3 additions & 2 deletions types/transfer/types.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { ethers } from 'ethers';
import pkg from 'ethers';
const { ethers } = pkg;
export interface UploadTask {
clientIndex: number;
taskSize: number;
Expand All @@ -15,4 +16,4 @@ export interface UploadOption {
fee: bigint;
}
export declare var defaultUploadOption: UploadOption;
//# sourceMappingURL=types.d.ts.map
//# sourceMappingURL=types.d.ts.map
6 changes: 3 additions & 3 deletions types/utils.d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { Signer } from 'ethers';
import { ContractRunner } from 'ethers';
import pkg from 'ethers';
const { Signer, ContractRunner } = pkg;
export declare function getFlowContract(address: string, signer: Signer): import("./contracts/flow/FixedPriceFlow.js").FixedPriceFlow;
export declare function getMarketContract(address: string, runner: ContractRunner): import("./contracts/market/FixedPrice.js").FixedPrice;
export declare function checkExist(inputPath: string): boolean;
export declare function GetSplitNum(total: number, unit: number): number;
export declare const delay: (ms: number) => Promise<unknown>;
//# sourceMappingURL=utils.d.ts.map
//# sourceMappingURL=utils.d.ts.map