Skip to content

refactor: group and organize export statements by category #202

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.

Sign up for GitHub

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

Open
faisalnugroho wants to merge 1 commit into
base: main
Choose a base branch
from
+47 −0
Open

refactor: group and organize export statements by category #202

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 47 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,62 @@
// ============================================================
// Public Actions
// ============================================================
export { type ProvenWithdrawal } from './actions/public/L1/readProvenWithdrawals.js'

// ============================================================
// Wallet Actions
// ============================================================
export { type ProveWithdrawalTransactionParameters } from './actions/wallet/L1/writeProveWithdrawalTransaction.js'

// ============================================================
// Public Decorators
// ============================================================
export { type PublicL1OpStackActions, publicL1OpStackActions } from './decorators/publicL1OpStackActions.js'
export { type PublicL2OpStackActions, publicL2OpStackActions } from './decorators/publicL2OpStackActions.js'

// ============================================================
// Wallet Decorators
// ============================================================
export { type WalletL1OpStackActions, walletL1OpStackActions } from './decorators/walletL1OpStackActions.js'
export { type WalletL2OpStackActions, walletL2OpStackActions } from './decorators/walletL2OpStackActions.js'

// ============================================================
// Types - Addresses
// ============================================================
export type { Addresses, ContractAddress, RawOrContractAddress } from './types/addresses.js'

// ============================================================
// Types - Deposit Transactions
// ============================================================
export type { DepositERC20Parameters } from './types/depositERC20.js'
export type { DepositETHParameters } from './types/depositETH.js'
export type { DepositTransaction, TransactionDepositedEvent } from './types/depositTransaction.js'
export { DEPOSIT_TX_PREFIX, SourceHashDomain } from './types/depositTransaction.js'

// ============================================================
// Types - Gas Price Oracle
// ============================================================
export type {
BlockOptions,
GasPriceOracleEstimator,
GasPriceOracleParameters,
OracleTransactionParameters,
} from './types/gasPriceOracle.js'

// ============================================================
// Types - OP Stack Contracts
// ============================================================
export { type OpStackL2ChainContracts, opStackL2ChainContracts, OpStackL2Contract } from './types/opStackContracts.js'

// ============================================================
// Types - Withdrawals
// ============================================================
export type { MessagePassedEvent } from './types/withdrawal.js'
export type { WithdrawETHParameters, WithdrawToParameters } from './types/withdrawTo.js'

// ============================================================
// Utilities - Deposit Transactions
// ============================================================
export type { GetDepositTransactionParams } from './utils/getDepositTransaction.js'
export { getDepositTransaction } from './utils/getDepositTransaction.js'
export { getL2HashFromL1DepositInfo } from './utils/getL2HashFromL1DepositInfo.js'
Expand All @@ -28,5 +67,13 @@ export type {
TransactionDepositedEventDetails,
} from './utils/getTransactionDepositedEvents.js'
export { getTransactionDepositedEvents } from './utils/getTransactionDepositedEvents.js'

// ============================================================
// Utilities - Withdrawals
// ============================================================
export { getWithdrawalMessageStorageSlot } from './utils/getWithdrawalMessageStorageSlot.js'

// ============================================================
// Utilities - Encoding
// ============================================================
export { rlpEncodeDepositTransaction } from './utils/rlpEncodeDepositTransaction.js'