Ethereum SDK
Types exported by @quip.network/ethereum-sdk, the account client for EVM chains.
Documented version: 1.0.6.
TypeScript SDK for post-quantum-secured smart-contract wallets on EVM chains. Only the subpaths below can be imported: the package has no root entry point.
npm install @quip.network/ethereum-sdk@1.0.6Generated at build from the type declarations in the published package. A description is the first paragraph of the package’s own doc comment, and an export with none shows its type alone. For walkthroughs, see the SDK guide.
@quip.network/ethereum-sdk/v1/shrincs
The current wallet family: the SHRINCS clients.
Classes
QuipError
constructor(code: string, message: string, opts?: QuipErrorOptions)Prop
Type
ShrincsFactoryClient
constructor(params: ShrincsFactoryClientParams)Prop
Type
ShrincsKeyPair
constructor(wasm: ShrincsWasmModule, stateful: ShrincsKeyMaterial, stateless?: ShrincsKeyMaterial)Prop
Type
ShrincsPaymasterClient
constructor(params: ShrincsPaymasterClientParams)Prop
Type
ShrincsSigner
Prop
Type
Static members:
Prop
Type
ShrincsWalletClient
constructor(params: ShrincsWalletClientParams)Prop
Type
Functions
Prop
Type
Constants
Prop
Type
ABIs and long literals
Their literal types run too long to print here.
| Export | Description |
|---|---|
shrincsPaymasterAbi | |
shrincsWalletAbi | |
shrincsWalletBeta2Abi |
Enums
Erc1271ValidationResult
Prop
Type
PaymasterValidationFailure
Prop
Type
UserOpValidationFailure
Prop
Type
Namespaces
ShrincsCodec
Prop
Type
Error classes
| Error | Constructor |
|---|---|
AccountChangedError | constructor(expectedAccount: string, availableAccounts: readonly string[], opts?: QuipErrorOptions) |
AlreadyInitializedError | constructor(opts?: QuipErrorOptions) |
AuthLeafInTargetsError | constructor(leaf: number, opts?: QuipErrorOptions) |
BalanceTooLowError | constructor(required: bigint, available: bigint, opts?: QuipErrorOptions) |
ChainChangedError | constructor(expectedChainId: number, actualChainId: number, opts?: QuipErrorOptions) |
ClassicalTransferOwnershipDisabledError | constructor(opts?: QuipErrorOptions) |
ClassicalWithdrawDisabledError | constructor(opts?: QuipErrorOptions) |
CommitmentMismatchError | constructor(suppliedCommitment?: Hex, onChainCommitment?: Hex, opts?: QuipErrorOptions) |
DelegateExecuteDisabledError | constructor(opts?: QuipErrorOptions) |
EmptyLeavesError | constructor(opts?: QuipErrorOptions) |
ExecuteFeeExceedsCapError | constructor(fee?: bigint, maxFee?: bigint, opts?: QuipErrorOptions) |
ExecuteTargetHasNoCodeError | constructor(target: Address, opts?: QuipErrorOptions) |
GasEstimationError | constructor(message: string, opts?: QuipErrorOptions) |
GuardedSlotTamperedError | constructor(slotIndex: number, opts?: QuipErrorOptions) |
IdentityMismatchError | constructor(opts?: QuipErrorOptions) |
ImplementationDeprecatedError | constructor(opts?: QuipErrorOptions) |
ImplementationNotVettedError | constructor(opts?: QuipErrorOptions) |
InsufficientWalletBalanceError | constructor(required: bigint, available: bigint, opts?: QuipErrorOptions) |
InvalidEntryPointError | constructor(opts?: QuipErrorOptions) |
InvalidFactoryError | constructor(opts?: QuipErrorOptions) |
InvalidKeyAcceptanceError | constructor(reason?: string, opts?: QuipErrorOptions) |
InvalidOwnerAcceptanceError | constructor(reason?: string, opts?: QuipErrorOptions) |
InvalidSignatureError | constructor(opts?: QuipErrorOptions) |
InvalidSponsorshipWindowError | constructor(validUntil: number, validAfter: number, reason: string, opts?: QuipErrorOptions) |
LeafBitmapReadError | constructor(wordIndex: number, opts?: QuipErrorOptions) |
LeafOutOfRangeError | constructor(leaf: number, maxSignatures?: number, opts?: QuipErrorOptions) |
MalformedCodecPayloadError | constructor(expectedMin: bigint, actual: bigint, opts?: QuipErrorOptions) |
NotUpgradingError | constructor(opts?: QuipErrorOptions) |
OwnerMismatchError | constructor(expected: Address, actual: Address, opts?: QuipErrorOptions) |
OwnershipHandoverDisabledError | constructor(opts?: QuipErrorOptions) |
RenounceDisabledError | constructor(opts?: QuipErrorOptions) |
ShrincsHdDerivationError | constructor(message: string, opts?: QuipErrorOptions) |
ShrincsInvalidMnemonicError | constructor(opts?: QuipErrorOptions) |
ShrincsKeyDerivationSelfTestError | constructor(publicKeyCommitment: Hex, opts?: QuipErrorOptions) |
StaleActionNonceError | constructor(expected?: bigint, provided?: bigint, opts?: QuipErrorOptions) |
StaleStatefulLeafError | constructor(leaf?: number, opts?: QuipErrorOptions) |
StandardExecuteDisabledError | constructor(opts?: QuipErrorOptions) |
StatefulBudgetExhaustedError | constructor(maxSignatures?: number, used?: number, opts?: QuipErrorOptions) |
StatefulTreeSpentError | constructor(treeId?: Hex, opts?: QuipErrorOptions) |
StatelessTreeSpentError | constructor(treeId?: Hex, opts?: QuipErrorOptions) |
StorageStoreDisabledError | constructor(opts?: QuipErrorOptions) |
TransactionRevertedError | constructor(transactionHash: Hex, opts?: QuipErrorOptions) |
UnauthorizedError | constructor(opts?: QuipErrorOptions) |
UnknownContractError | constructor(errorName: string | undefined, args: readonly unknown[] | undefined, opts?: QuipErrorOptions) |
UnknownWalletVersionError | constructor(implementation: Hex, opts?: QuipErrorOptions) |
UnsupportedByWalletVersionError | constructor(versionLabel: string, operation: string, opts?: QuipErrorOptions) |
UnsupportedHashSuiteError | constructor(opts?: QuipErrorOptions) |
UnsupportedNetworkError | constructor(chainId: number, opts?: QuipErrorOptions) |
UpgradeFailedError | constructor(opts?: QuipErrorOptions) |
VerifierMismatchError | constructor(suppliedCommitment: Hex, onChainCommitment: Hex, opts?: QuipErrorOptions) |
VerifierProfileMismatchError | constructor(opts?: QuipErrorOptions) |
ZeroAddressFactoryError | constructor(opts?: QuipErrorOptions) |
ZeroAddressOwnerError | constructor(opts?: QuipErrorOptions) |
ZeroAddressVerifierError | constructor(opts?: QuipErrorOptions) |
ZeroErc1271CommitmentError | constructor(opts?: QuipErrorOptions) |
ZeroMaxSignaturesError | constructor(opts?: QuipErrorOptions) |
Interfaces
ActionContext
Prop
Type
BuildUserOpParams
Prop
Type
ContractCallParams
Prop
Type
CostEstimate
Prop
Type
CreateShrincsWalletParams
Prop
Type
CreationCostEstimate
Prop
Type
DeriveKeyPairParams
Prop
Type
Erc1271KeySetEvent
Prop
Type
ExecuteCostEstimate
Prop
Type
ExecuteParams
Prop
Type
ExecutionSucceededEvent
Prop
Type
FeeOverrides
Prop
Type
ForsEntry
Prop
Type
ForsSignature
Prop
Type
GetShrincsWalletParams
Prop
Type
HdNode
Prop
Type
HypertreeLayerSignature
Prop
Type
KeyRotatedEvent
Prop
Type
LeafConsumedOnlyEvent
Prop
Type
LeafRevocationSkippedEvent
Prop
Type
LeafRevokedEvent
Prop
Type
OwnershipAcceptance
Prop
Type
PackedUserOperation
Prop
Type
PaymasterInitializedEvent
Prop
Type
PaymasterValidationRejectedEvent
Prop
Type
PreparedExecute
Prop
Type
PreparedTx
Prop
Type
PrepareTxParams
Prop
Type
QuipErrorOptions
Prop
Type
QuipHdPathOptions
Prop
Type
RotationContext
Prop
Type
RotationTarget
Prop
Type
ShrincsCall
Prop
Type
ShrincsFactoryClientParams
Prop
Type
ShrincsKeygenOptions
Prop
Type
ShrincsNetworkAddresses
Prop
Type
ShrincsPaymasterClientParams
Prop
Type
ShrincsPublicKey
Prop
Type
ShrincsTxKeyOptions
Prop
Type
ShrincsVerifierSetEvent
Prop
Type
ShrincsVerifierState
Prop
Type
ShrincsWalletClientParams
Prop
Type
ShrincsWalletState
Prop
Type
SignedWalletUserOp
Prop
Type
SignPaymasterUserOpParams
Prop
Type
SignWalletUserOpParams
Prop
Type
SponsorshipVerifiedEvent
Prop
Type
StatefulRotationTarget
Prop
Type
StatefulSignature
Prop
Type
StatefulSignatureVerifiedEvent
Prop
Type
StatelessSignature
Prop
Type
TxOptions
Prop
Type
UserOpEnvelope
Prop
Type
UserOpSponsoredEvent
Prop
Type
UserOpValidationRejectedEvent
Prop
Type
WalletInitializedEvent
Prop
Type
WalletMigratedEvent
Prop
Type
WalletVersionDescriptor
Prop
Type
WalletVersionQuirks
Prop
Type
WotsCSignature
Prop
Type
Type aliases
Erc1271KeySpec
type Erc1271KeySpec = {
derivationIndex: number;
maxSignatures?: number;
} | {
publicKey: ShrincsPublicKey;
};EstimateCreationCostParams
type EstimateCreationCostParams = CreateShrincsWalletParams;ExecuteFundingSource
type ExecuteFundingSource = "sender" | "wallet";LogSource
type LogSource = TransactionReceipt | readonly Log[];ShrincsWasmModule
type ShrincsWasmModule = typeof import("./profiles/256s-keccak/nodejs/hashsigs_rs.js");WalletVersionId
type WalletVersionId = "v1.0.1-beta.2" | "latest";@quip.network/ethereum-sdk/v1
The surface shared across wallet families.
Also exports these, documented above: DEFAULT_GAS_MULTIPLIER, MIN_GAS_MULTIPLIER, MAX_GAS_MULTIPLIER, applyGasMultiplier, resolveGasMultiplier, resolveFeeOptions, preflightBalanceCheck, TxOptions, FeeOverrides, PreparedTx, ContractCallParams, PrepareTxParams, CANONICAL_ENTRYPOINT_V07, CHAIN_IDS, QuipErrorOptions, QuipError, UnsupportedNetworkError, ChainChangedError, AccountChangedError, GasEstimationError, BalanceTooLowError, computeUserOpHash, PackedUserOperation.
Functions
Prop
Type
Constants
Prop
Type
ABIs and long literals
Their literal types run too long to print here.
| Export | Description |
|---|---|
entryPointV07Abi | |
walletFactoryAbi |
Enums
Erc1271ValidationResult
Prop
Type
PaymasterValidationFailure
Prop
Type
UserOpValidationFailure
Prop
Type
Error classes
| Error | Constructor |
|---|---|
AlreadyVettedError | constructor(opts?: QuipErrorOptions) |
ClassicalTransferOwnershipDisabledError | constructor(opts?: QuipErrorOptions) |
ClassicalWithdrawDisabledError | constructor(opts?: QuipErrorOptions) |
DuplicateKeyError | constructor(opts?: QuipErrorOptions) |
EmptyCodeError | constructor(opts?: QuipErrorOptions) |
EmptyKeysError | constructor(opts?: QuipErrorOptions) |
FeeExceedsMaxError | constructor(fee: bigint, maxFee: bigint, opts?: QuipErrorOptions) |
GuardedSlotTamperedError | constructor(slotIndex: number, opts?: QuipErrorOptions) |
GuardedSlotWriteDeniedError | constructor(opts?: QuipErrorOptions) |
ImplementationDeprecatedError | constructor(opts?: QuipErrorOptions) |
ImplementationNotVettedError | constructor(opts?: QuipErrorOptions) |
IncorrectRecoveryKeyAmountError | constructor(opts?: QuipErrorOptions) |
IncorrectTransactionKeyAmountError | constructor(opts?: QuipErrorOptions) |
IncorrectVerificationKeyAmountError | constructor(opts?: QuipErrorOptions) |
InsufficientBalanceError | constructor(requested: bigint, available: bigint, opts?: QuipErrorOptions) |
InsufficientCreationFeeError | constructor(sent: bigint, required: bigint, opts?: QuipErrorOptions) |
InvalidEntryPointError | constructor(opts?: QuipErrorOptions) |
InvalidFactoryError | constructor(opts?: QuipErrorOptions) |
InvalidSignatureError | constructor(opts?: QuipErrorOptions) |
InvalidSigningKeysetError | constructor(opts?: QuipErrorOptions) |
KeyAdditionFailedError | constructor(opts?: QuipErrorOptions) |
KeyInUseError | constructor(opts?: QuipErrorOptions) |
KeyRemovalFailedError | constructor(opts?: QuipErrorOptions) |
MalformedCodecPayloadError | constructor(expected: bigint, actual: bigint, opts?: QuipErrorOptions) |
MalformedPayloadError | constructor(opts?: QuipErrorOptions) |
NoActiveImplementationError | constructor(opts?: QuipErrorOptions) |
NotDeprecatedError | constructor(opts?: QuipErrorOptions) |
NotUpgradingError | constructor(opts?: QuipErrorOptions) |
NoVaultFoundError | constructor(vaultId: Hex, opts?: QuipErrorOptions) |
OnlyWalletError | constructor(opts?: QuipErrorOptions) |
OwnershipHandoverDisabledError | constructor(opts?: QuipErrorOptions) |
OwnerStateMismatchError | constructor(opts?: QuipErrorOptions) |
PqVerifierNotRegisteredError | constructor(opts?: QuipErrorOptions) |
RegistryDesyncError | constructor(opts?: QuipErrorOptions) |
RenounceDisabledError | constructor(opts?: QuipErrorOptions) |
SameKeyError | constructor(opts?: QuipErrorOptions) |
SameOwnerError | constructor(opts?: QuipErrorOptions) |
UnknownContractError | constructor(errorName: string | undefined, args: readonly unknown[] | undefined, opts?: QuipErrorOptions) |
UnknownDisasterRecoveryKeyError | constructor(opts?: QuipErrorOptions) |
UnknownKeyError | constructor(opts?: QuipErrorOptions) |
UnknownOwnershipKeyError | constructor(opts?: QuipErrorOptions) |
VerifierKeyInUseError | constructor(opts?: QuipErrorOptions) |
VerifierMismatchError | constructor(sender: Hex, suppliedVerifier: { publicSeed: Hex; publicKeyHash: Hex; }, onChainVerifier: { publicSeed: Hex; publicKeyHash: Hex; }, opts?: QuipErrorOptions) |
WalletAlreadyExistsError | constructor(vaultId: Hex, opts?: QuipErrorOptions) |
ZeroAddressFactoryError | constructor(opts?: QuipErrorOptions) |
ZeroAddressOwnerError | constructor(opts?: QuipErrorOptions) |
ZeroCommitmentError | constructor(opts?: QuipErrorOptions) |
ZeroMaxFeeError | constructor(opts?: QuipErrorOptions) |
ZeroValuePqVerifierKeyError | constructor(opts?: QuipErrorOptions) |
Interfaces
NetworkAddresses
Shared, wallet-family-agnostic network addresses. Both the SHRINCS family (through its own getShrincsAddresses) and the sunset WOTS+ family rely on the same ERC-4337 EntryPoint; the WalletFactory address is shared across every chain reached by the same operator (CreateX sender-guarded CREATE3).
Prop
Type
WotsNetworkAddresses
WOTS+-family address set. The WOTS+ wallet family (QuipSigner, QuipClient, QuipPaymasterClient, …) moved to ./deprecated/v1; these fields exist only for that sunset family and are not part of the shared NetworkAddresses surface. The live SHRINCS family resolves through getShrincsAddresses.
Prop
Type
@quip.network/ethereum-sdk/v1/abi
Also exports these, documented above: walletFactoryAbi, entryPointV07Abi.
Constants
Prop
Type
ABIs and long literals
Their literal types run too long to print here.
| Export | Description |
|---|---|
quipPaymasterAbi | |
wotsPlusImplementationAbi |
@quip.network/ethereum-sdk/v1/addresses
Also exports these, documented above: getNetworkAddresses, isMidlNetwork, getVaultAddress, computeVaultAddress, computeCreate3Address, NetworkAddresses, WotsNetworkAddresses, CANONICAL_ENTRYPOINT_V07, CHAIN_IDS, NETWORK_ADDRESSES.
@quip.network/ethereum-sdk/v1/errors
Also exports these, documented above: QuipErrorOptions, QuipError, ZeroAddressFactoryError, ZeroAddressOwnerError, InvalidFactoryError, InvalidSignatureError, RenounceDisabledError, ClassicalWithdrawDisabledError, ClassicalTransferOwnershipDisabledError, OwnershipHandoverDisabledError, OnlyWalletError, OwnerStateMismatchError, SameOwnerError, RegistryDesyncError, ZeroCommitmentError, DuplicateKeyError, KeyInUseError, SameKeyError, UnknownKeyError, KeyAdditionFailedError, KeyRemovalFailedError, EmptyKeysError, IncorrectRecoveryKeyAmountError, NotUpgradingError, IncorrectTransactionKeyAmountError, IncorrectVerificationKeyAmountError, InvalidSigningKeysetError, MalformedPayloadError, MalformedCodecPayloadError, ImplementationNotVettedError, ImplementationDeprecatedError, UnknownDisasterRecoveryKeyError, UnknownOwnershipKeyError, GuardedSlotTamperedError, GuardedSlotWriteDeniedError, InsufficientBalanceError, FeeExceedsMaxError, EmptyCodeError, AlreadyVettedError, NotDeprecatedError, NoActiveImplementationError, InsufficientCreationFeeError, ZeroMaxFeeError, InvalidEntryPointError, ZeroValuePqVerifierKeyError, PqVerifierNotRegisteredError, VerifierKeyInUseError, VerifierMismatchError, UserOpValidationFailure, PaymasterValidationFailure, Erc1271ValidationResult, WalletAlreadyExistsError, NoVaultFoundError, UnsupportedNetworkError, ChainChangedError, AccountChangedError, GasEstimationError, BalanceTooLowError, UnknownContractError.
@quip.network/ethereum-sdk/v1/gas
Also exports these, documented above: applyGasMultiplier, resolveGasMultiplier, resolveFeeOptions, preflightBalanceCheck, prepareTx, DEFAULT_GAS_MULTIPLIER, MIN_GAS_MULTIPLIER, MAX_GAS_MULTIPLIER, TxOptions, FeeOverrides, PreparedTx, ContractCallParams, PrepareTxParams, QuipError.
Functions
Prop
Type
@quip.network/ethereum-sdk/v1/userOpCodec
Also exports these, documented above: packUint128Pair, packAccountGasLimits, packGasFees, unpackAccountGasLimits, unpackGasFees, computeUserOpHash, PackedUserOperation.
@quip.network/ethereum-sdk/deprecated/v0
Deprecated. This module targets the original (pre-v1) QuipWallet/QuipFactory deployments: the single-pqOwner model, the two-key recovery payload, and the v0 upgrade payload layout. It is kept solely so existing v0 wallets remain operable. For all new integrations import from @quip.network/ethereum-sdk/v1 instead.
No tables for this entry point. It exports these:
CHAIN_IDS, DEFAULT_CONFIRMATIONS, DEPLOYER_ADDRESS, DeployEvent, DeployerInterface, Deployer, ERRORS, EVENTS, NETWORK_ADDRESSES, NetworkAddresses, NetworkType, QUIP_FACTORY_ADDRESS, QuipClient, QuipCreatedEvent, QuipFactory__factory, QuipFactory, QuipSigner, QuipWalletClient, QuipWallet__factory, QuipWallet, SUPPORTED_NETWORKS, WOTSPLUS_GAS_ESTIMATE, WOTS_PLUS_ADDRESS, WalletProvider, WinternitzKeyPair, WinternitzPublicKey, computeVaultAddress, getNetworkAddresses, getVaultAddress, isMidlNetwork, pqTransferEvent