CreateInstanceOptions
Defined in: packages/pic/src/pocket-ic-types.ts:14
Options for creating a PocketIc instance.
Properties
Section titled “Properties”application?
Section titled “application?”
optionalapplication:ApplicationSubnetConfig[]
Defined in: packages/pic/src/pocket-ic-types.ts:57
Configuration options for creating application subnets. An application subnet will be created for each configuration object provided. If no config objects are provided, no application subnets are setup.
bitcoin?
Section titled “bitcoin?”
optionalbitcoin:BitcoinSubnetConfig
Defined in: packages/pic/src/pocket-ic-types.ts:43
Configuration options for creating a Bitcoin subnet. If no config is provided, the Bitcoin subnet is not setup.
disableIngressValidation?
Section titled “disableIngressValidation?”
optionaldisableIngressValidation:boolean
Defined in: packages/pic/src/pocket-ic-types.ts:99
Disables ingress message validation on the PocketIC instance.
When enabled, the PocketIC server skips the validation that would normally reject malformed or otherwise invalid ingress messages. This is useful for testing canister behavior against ingress messages that the replica would ordinarily refuse to process.
Defaults to false.
fiduciary?
Section titled “fiduciary?”
optionalfiduciary:FiduciarySubnetConfig
Defined in: packages/pic/src/pocket-ic-types.ts:37
Configuration options for creating a Fiduciary subnet. If no config is provided, the Fiduciary subnet is not setup.
icpConfig?
Section titled “icpConfig?”
optionalicpConfig:IcpConfig
Defined in: packages/pic/src/pocket-ic-types.ts:82
Determines what non-mainnet features should be enabled for the PocketIC instance.
icpFeatures?
Section titled “icpFeatures?”
optionalicpFeatures:IcpFeatures
Defined in: packages/pic/src/pocket-ic-types.ts:87
Determines what ICP features should be enabled for the PocketIC instance.
optionalii:IiSubnetConfig
Defined in: packages/pic/src/pocket-ic-types.ts:31
Configuration options for creating an II subnet. If no config is provided, the II subnet is not setup.
ingressMaxRetries?
Section titled “ingressMaxRetries?”
optionalingressMaxRetries:number
Defined in: packages/pic/src/pocket-ic-types.ts:77
Deprecated
Section titled “Deprecated”This option is no longer used. The PocketIC server now handles
ingress message processing internally via the await_ingress_message endpoint.
Use CreateInstanceOptions.processingTimeoutMs to control how long update
calls can wait for ingress processing to complete.
optionalnns:NnsSubnetConfig
Defined in: packages/pic/src/pocket-ic-types.ts:19
Configuration options for creating an NNS subnet. If no config is provided, the NNS subnet is not setup.
processingTimeoutMs?
Section titled “processingTimeoutMs?”
optionalprocessingTimeoutMs:number
Defined in: packages/pic/src/pocket-ic-types.ts:69
How long the PocketIC client should wait for a response from the server.
optionalsns:SnsSubnetConfig
Defined in: packages/pic/src/pocket-ic-types.ts:25
Configuration options for creating an SNS subnet. If no config is provided, the SNS subnet is not setup.
system?
Section titled “system?”
optionalsystem:SystemSubnetConfig[]
Defined in: packages/pic/src/pocket-ic-types.ts:50
Configuration options for creating system subnets. A system subnet will be created for each configuration object provided. If no config objects are provided, no system subnets are setup.
verifiedApplication?
Section titled “verifiedApplication?”
optionalverifiedApplication:VerifiedApplicationSubnetConfig[]
Defined in: packages/pic/src/pocket-ic-types.ts:64
Configuration options for creating verified application subnets. A verified application subnet will be created for each configuration object provided. If no config objects are provided, no verified application subnets are setup.