API Reference

---

Class: PICReplica

Defined in: services/pic/pic.ts:87

Implementation of the Replica for PocketIC. Manages a local PocketIC instance for testing and development.

Implements

• Replica

Constructors

Constructor

new PICReplica(opts): PICReplica

Defined in: services/pic/pic.ts:121

Creates a new PICReplica instance.

Parameters

Parameter	Type	Description
opts	{ host?: string; manual?: boolean; picConfig?: CreateInstanceOptions; port: number; ttlSeconds?: number; }	-
opts.host?	string	The host to bind to (default: http://0.0.0.0).
opts.manual?	boolean	If true, assumes PocketIC is already running and connects to it.
opts.picConfig?	CreateInstanceOptions	Configuration for the PocketIC instance (subnets, state).
opts.port	number	The port to bind to.
opts.ttlSeconds?	number	Time-to-live for the instance.

Returns

PICReplica

Properties

client?

optional client: PocketIcClient

Defined in: services/pic/pic.ts:95

---

ctx

ctx: ReplicaContext | undefined

Defined in: services/pic/pic.ts:97

---

host

host: string

Defined in: services/pic/pic.ts:88

The host URL of the replica.

Implementation of

Replica.host

---

manual?

readonly optional manual: boolean

Defined in: services/pic/pic.ts:91

---

monitor

monitor: Monitor | undefined

Defined in: services/pic/pic.ts:94

---

pic?

optional pic: PocketIc

Defined in: services/pic/pic.ts:96

---

picConfig

readonly picConfig: CreateInstanceOptions

Defined in: services/pic/pic.ts:92

---

port

port: number

Defined in: services/pic/pic.ts:89

The port number of the replica.

Implementation of

Replica.port

---

ttlSeconds

readonly ttlSeconds: number

Defined in: services/pic/pic.ts:90

Methods

createActor()

createActor<_SERVICE>(params): Promise<ActorSubclass<_SERVICE>>

Defined in: services/pic/pic.ts:810

Creates a typed actor for interacting with a canister.

Type Parameters

Type Parameter
_SERVICE

Parameters

Parameter	Type
params	CreateActorParams

Returns

Promise<ActorSubclass<_SERVICE>>

Implementation of

Replica.createActor

---

createCanister()

createCanister(params): Promise<string>

Defined in: services/pic/pic.ts:478

Creates a new canister, returns the canister ID.

Parameters

Parameter	Type
params	CreateCanisterParams

Returns

Promise<string>

Implementation of

Replica.createCanister

---

getCanisterInfo()

getCanisterInfo(params): Promise<CanisterStatusResult>

Defined in: services/pic/pic.ts:335

Gets detailed information about a canister.

Parameters

Parameter	Type
params	GetCanisterStatusParams

Returns

Promise<CanisterStatusResult>

Implementation of

Replica.getCanisterInfo

---

getCanisterStatus()

getCanisterStatus(params): Promise<CanisterStatus>

Defined in: services/pic/pic.ts:316

Gets the status of a canister (running, stopped, etc.).

Parameters

Parameter	Type
params	GetCanisterStatusParams

Returns

Promise<CanisterStatus>

Implementation of

Replica.getCanisterStatus

---

getTopology()

getTopology(): Promise<SubnetTopology[]>

Defined in: services/pic/pic.ts:292

Gets the subnet topology.

Returns

Promise<SubnetTopology[]>

Implementation of

Replica.getTopology

---

installCode()

installCode(params): Promise<void>

Defined in: services/pic/pic.ts:624

Installs Wasm code to a canister.

Parameters

Parameter	Type
params	InstallCodeParams

Returns

Promise<void>

Implementation of

Replica.installCode

---

removeCanister()

removeCanister(params): Promise<void>

Defined in: services/pic/pic.ts:608

Removes/deletes a canister.

Parameters

Parameter	Type
params	GetCanisterStatusParams

Returns

Promise<void>

Implementation of

Replica.removeCanister

---

start()

start(ctx): Promise<void>

Defined in: services/pic/pic.ts:152

Starts the replica.

Parameters

Parameter	Type
ctx	ReplicaContext

Returns

Promise<void>

Implementation of

Replica.start

---

stop()

stop(args, ctx?): Promise<void>

Defined in: services/pic/pic.ts:252

Stops the replica.

Parameters

Parameter	Type
args	StopOptions
ctx?	ReplicaContext

Returns

Promise<void>

Implementation of

Replica.stop

---

stopCanister()

stopCanister(params): Promise<void>

Defined in: services/pic/pic.ts:592

Stops a running canister.

Parameters

Parameter	Type
params	GetCanisterStatusParams

Returns

Promise<void>

Implementation of

Replica.stopCanister