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.6

Generated 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.

ExportDescription
shrincsPaymasterAbi
shrincsWalletAbi
shrincsWalletBeta2Abi

Enums

Erc1271ValidationResult

Prop

Type

PaymasterValidationFailure

Prop

Type

UserOpValidationFailure

Prop

Type

Namespaces

ShrincsCodec

Prop

Type

Error classes

ErrorConstructor
AccountChangedErrorconstructor(expectedAccount: string, availableAccounts: readonly string[], opts?: QuipErrorOptions)
AlreadyInitializedErrorconstructor(opts?: QuipErrorOptions)
AuthLeafInTargetsErrorconstructor(leaf: number, opts?: QuipErrorOptions)
BalanceTooLowErrorconstructor(required: bigint, available: bigint, opts?: QuipErrorOptions)
ChainChangedErrorconstructor(expectedChainId: number, actualChainId: number, opts?: QuipErrorOptions)
ClassicalTransferOwnershipDisabledErrorconstructor(opts?: QuipErrorOptions)
ClassicalWithdrawDisabledErrorconstructor(opts?: QuipErrorOptions)
CommitmentMismatchErrorconstructor(suppliedCommitment?: Hex, onChainCommitment?: Hex, opts?: QuipErrorOptions)
DelegateExecuteDisabledErrorconstructor(opts?: QuipErrorOptions)
EmptyLeavesErrorconstructor(opts?: QuipErrorOptions)
ExecuteFeeExceedsCapErrorconstructor(fee?: bigint, maxFee?: bigint, opts?: QuipErrorOptions)
ExecuteTargetHasNoCodeErrorconstructor(target: Address, opts?: QuipErrorOptions)
GasEstimationErrorconstructor(message: string, opts?: QuipErrorOptions)
GuardedSlotTamperedErrorconstructor(slotIndex: number, opts?: QuipErrorOptions)
IdentityMismatchErrorconstructor(opts?: QuipErrorOptions)
ImplementationDeprecatedErrorconstructor(opts?: QuipErrorOptions)
ImplementationNotVettedErrorconstructor(opts?: QuipErrorOptions)
InsufficientWalletBalanceErrorconstructor(required: bigint, available: bigint, opts?: QuipErrorOptions)
InvalidEntryPointErrorconstructor(opts?: QuipErrorOptions)
InvalidFactoryErrorconstructor(opts?: QuipErrorOptions)
InvalidKeyAcceptanceErrorconstructor(reason?: string, opts?: QuipErrorOptions)
InvalidOwnerAcceptanceErrorconstructor(reason?: string, opts?: QuipErrorOptions)
InvalidSignatureErrorconstructor(opts?: QuipErrorOptions)
InvalidSponsorshipWindowErrorconstructor(validUntil: number, validAfter: number, reason: string, opts?: QuipErrorOptions)
LeafBitmapReadErrorconstructor(wordIndex: number, opts?: QuipErrorOptions)
LeafOutOfRangeErrorconstructor(leaf: number, maxSignatures?: number, opts?: QuipErrorOptions)
MalformedCodecPayloadErrorconstructor(expectedMin: bigint, actual: bigint, opts?: QuipErrorOptions)
NotUpgradingErrorconstructor(opts?: QuipErrorOptions)
OwnerMismatchErrorconstructor(expected: Address, actual: Address, opts?: QuipErrorOptions)
OwnershipHandoverDisabledErrorconstructor(opts?: QuipErrorOptions)
RenounceDisabledErrorconstructor(opts?: QuipErrorOptions)
ShrincsHdDerivationErrorconstructor(message: string, opts?: QuipErrorOptions)
ShrincsInvalidMnemonicErrorconstructor(opts?: QuipErrorOptions)
ShrincsKeyDerivationSelfTestErrorconstructor(publicKeyCommitment: Hex, opts?: QuipErrorOptions)
StaleActionNonceErrorconstructor(expected?: bigint, provided?: bigint, opts?: QuipErrorOptions)
StaleStatefulLeafErrorconstructor(leaf?: number, opts?: QuipErrorOptions)
StandardExecuteDisabledErrorconstructor(opts?: QuipErrorOptions)
StatefulBudgetExhaustedErrorconstructor(maxSignatures?: number, used?: number, opts?: QuipErrorOptions)
StatefulTreeSpentErrorconstructor(treeId?: Hex, opts?: QuipErrorOptions)
StatelessTreeSpentErrorconstructor(treeId?: Hex, opts?: QuipErrorOptions)
StorageStoreDisabledErrorconstructor(opts?: QuipErrorOptions)
TransactionRevertedErrorconstructor(transactionHash: Hex, opts?: QuipErrorOptions)
UnauthorizedErrorconstructor(opts?: QuipErrorOptions)
UnknownContractErrorconstructor(errorName: string | undefined, args: readonly unknown[] | undefined, opts?: QuipErrorOptions)
UnknownWalletVersionErrorconstructor(implementation: Hex, opts?: QuipErrorOptions)
UnsupportedByWalletVersionErrorconstructor(versionLabel: string, operation: string, opts?: QuipErrorOptions)
UnsupportedHashSuiteErrorconstructor(opts?: QuipErrorOptions)
UnsupportedNetworkErrorconstructor(chainId: number, opts?: QuipErrorOptions)
UpgradeFailedErrorconstructor(opts?: QuipErrorOptions)
VerifierMismatchErrorconstructor(suppliedCommitment: Hex, onChainCommitment: Hex, opts?: QuipErrorOptions)
VerifierProfileMismatchErrorconstructor(opts?: QuipErrorOptions)
ZeroAddressFactoryErrorconstructor(opts?: QuipErrorOptions)
ZeroAddressOwnerErrorconstructor(opts?: QuipErrorOptions)
ZeroAddressVerifierErrorconstructor(opts?: QuipErrorOptions)
ZeroErc1271CommitmentErrorconstructor(opts?: QuipErrorOptions)
ZeroMaxSignaturesErrorconstructor(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.

ExportDescription
entryPointV07Abi
walletFactoryAbi

Enums

Erc1271ValidationResult

Prop

Type

PaymasterValidationFailure

Prop

Type

UserOpValidationFailure

Prop

Type

Error classes

ErrorConstructor
AlreadyVettedErrorconstructor(opts?: QuipErrorOptions)
ClassicalTransferOwnershipDisabledErrorconstructor(opts?: QuipErrorOptions)
ClassicalWithdrawDisabledErrorconstructor(opts?: QuipErrorOptions)
DuplicateKeyErrorconstructor(opts?: QuipErrorOptions)
EmptyCodeErrorconstructor(opts?: QuipErrorOptions)
EmptyKeysErrorconstructor(opts?: QuipErrorOptions)
FeeExceedsMaxErrorconstructor(fee: bigint, maxFee: bigint, opts?: QuipErrorOptions)
GuardedSlotTamperedErrorconstructor(slotIndex: number, opts?: QuipErrorOptions)
GuardedSlotWriteDeniedErrorconstructor(opts?: QuipErrorOptions)
ImplementationDeprecatedErrorconstructor(opts?: QuipErrorOptions)
ImplementationNotVettedErrorconstructor(opts?: QuipErrorOptions)
IncorrectRecoveryKeyAmountErrorconstructor(opts?: QuipErrorOptions)
IncorrectTransactionKeyAmountErrorconstructor(opts?: QuipErrorOptions)
IncorrectVerificationKeyAmountErrorconstructor(opts?: QuipErrorOptions)
InsufficientBalanceErrorconstructor(requested: bigint, available: bigint, opts?: QuipErrorOptions)
InsufficientCreationFeeErrorconstructor(sent: bigint, required: bigint, opts?: QuipErrorOptions)
InvalidEntryPointErrorconstructor(opts?: QuipErrorOptions)
InvalidFactoryErrorconstructor(opts?: QuipErrorOptions)
InvalidSignatureErrorconstructor(opts?: QuipErrorOptions)
InvalidSigningKeysetErrorconstructor(opts?: QuipErrorOptions)
KeyAdditionFailedErrorconstructor(opts?: QuipErrorOptions)
KeyInUseErrorconstructor(opts?: QuipErrorOptions)
KeyRemovalFailedErrorconstructor(opts?: QuipErrorOptions)
MalformedCodecPayloadErrorconstructor(expected: bigint, actual: bigint, opts?: QuipErrorOptions)
MalformedPayloadErrorconstructor(opts?: QuipErrorOptions)
NoActiveImplementationErrorconstructor(opts?: QuipErrorOptions)
NotDeprecatedErrorconstructor(opts?: QuipErrorOptions)
NotUpgradingErrorconstructor(opts?: QuipErrorOptions)
NoVaultFoundErrorconstructor(vaultId: Hex, opts?: QuipErrorOptions)
OnlyWalletErrorconstructor(opts?: QuipErrorOptions)
OwnershipHandoverDisabledErrorconstructor(opts?: QuipErrorOptions)
OwnerStateMismatchErrorconstructor(opts?: QuipErrorOptions)
PqVerifierNotRegisteredErrorconstructor(opts?: QuipErrorOptions)
RegistryDesyncErrorconstructor(opts?: QuipErrorOptions)
RenounceDisabledErrorconstructor(opts?: QuipErrorOptions)
SameKeyErrorconstructor(opts?: QuipErrorOptions)
SameOwnerErrorconstructor(opts?: QuipErrorOptions)
UnknownContractErrorconstructor(errorName: string | undefined, args: readonly unknown[] | undefined, opts?: QuipErrorOptions)
UnknownDisasterRecoveryKeyErrorconstructor(opts?: QuipErrorOptions)
UnknownKeyErrorconstructor(opts?: QuipErrorOptions)
UnknownOwnershipKeyErrorconstructor(opts?: QuipErrorOptions)
VerifierKeyInUseErrorconstructor(opts?: QuipErrorOptions)
VerifierMismatchErrorconstructor(sender: Hex, suppliedVerifier: { publicSeed: Hex; publicKeyHash: Hex; }, onChainVerifier: { publicSeed: Hex; publicKeyHash: Hex; }, opts?: QuipErrorOptions)
WalletAlreadyExistsErrorconstructor(vaultId: Hex, opts?: QuipErrorOptions)
ZeroAddressFactoryErrorconstructor(opts?: QuipErrorOptions)
ZeroAddressOwnerErrorconstructor(opts?: QuipErrorOptions)
ZeroCommitmentErrorconstructor(opts?: QuipErrorOptions)
ZeroMaxFeeErrorconstructor(opts?: QuipErrorOptions)
ZeroValuePqVerifierKeyErrorconstructor(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.

ExportDescription
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

On this page