StarknetOptions
type StarknetOptions = object;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:75
Configuration options for initializing Starknet chain
Properties
btcRelayContract?
optional btcRelayContract: string;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:104
Contract address of the BTC Relay contract, uses canonical deployment by default
btcRelayContractDeploymentHeight?
optional btcRelayContractDeploymentHeight: number;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:108
Optional BTC Relay contract deployment height, which acts as genesis when querying events
chainId?
optional chainId: constants.StarknetChainId;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:91
Starknet chain ID: mainnet or sepolia
fees?
optional fees: StarknetFees;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:132
Starknet network fee API
handlerContracts?
optional handlerContracts: object;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:120
Contract addresses of the refund and claim handlers, uses canonical deployment by default
claim?
optional claim: { [type in ChainSwapType]?: string };
refund?
optional refund: object;
refund.timelock?
optional timelock: string;
retryPolicy?
optional retryPolicy: object;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:87
Retry policy for the RPC calls
delay?
optional delay: number;
exponential?
optional exponential: boolean;
maxRetries?
optional maxRetries: number;
rpcUrl
rpcUrl: string | Provider;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:79
Starknet RPC URL or Provider object to use for Starknet network access
spvVaultContract?
optional spvVaultContract: string;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:112
Contract address of the UTXO-controlled vault (SPV Vault manager) contract, uses canonical deployment by default
spvVaultContractDeploymentHeight?
optional spvVaultContractDeploymentHeight: number;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:116
Optional UTXO-controlled vault (SPV Vault manager) contract deployment height, which acts as genesis when querying events
starknetConfig?
optional starknetConfig: StarknetConfig;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:137
Starknet configuration
swapContract?
optional swapContract: string;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:96
Contract address of the Escrow Manager contract, uses canonical deployment by default
swapContractDeploymentHeight?
optional swapContractDeploymentHeight: number;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:100
Optional Escrow Manager contract deployment height, which acts as genesis when querying events
wsUrl?
optional wsUrl: string | WebSocketChannel;
Defined in: atomiq-chain-starknet/src/starknet/StarknetInitializer.ts:83
Optional WebSocket URL or WebSocketChannel object to use for realtime events subscriptions