Class: SetRateLimitConfig

Defined in: cct/canton/token-pool/operations/set-rate-limit-config.ts:66

Pool setRateLimitConfig operation.

Extends

• CantonOperation<SetRateLimitConfigParams>

Constructors

Constructor

new SetRateLimitConfig(): SetRateLimitConfig

Returns

SetRateLimitConfig

Inherited from

CantonOperation<SetRateLimitConfigParams>.constructor

Properties

name

readonly name: "setRateLimitConfig" = 'setRateLimitConfig'

Defined in: cct/canton/token-pool/operations/set-rate-limit-config.ts:67

camelCase id; matches the token-manager facade method and error context.

Overrides

CantonOperation.name

Methods

buildCommands()

protected buildCommands(chain: CantonChain, p: GenerateSetRateLimitConfigParams): Promise<{ actAs: string[]; commandId: string; commands: ({ CreateAndExerciseCommand: { choice: string; choiceArgument: unknown; createArguments: unknown; templateId: string; }; } | { CreateCommand: { createArguments: unknown; templateId: string; }; } | { ExerciseByKeyCommand: { choice: string; choiceArgument: unknown; contractKey: unknown; templateId: string; }; } | { ExerciseCommand: { choice: string; choiceArgument: unknown; contractId: string; templateId: string; }; })[]; deduplicationPeriod?: { DeduplicationDuration: { value: { nanos: number; seconds: number; unknownFields?: { fields: {[key: string]: { fixed32?: ... | ...; fixed64?: ... | ...; lengthDelimited?: ... | ...; varint?: ... | ...; }; }; }; }; }; } | { DeduplicationOffset: { value: number; }; } | { Empty: Record<string, never>; }; disclosedContracts?: { contractId?: string; createdEventBlob: string; synchronizerId?: string; templateId?: string; }[]; minLedgerTimeAbs?: string; minLedgerTimeRel?: { nanos: number; seconds: number; unknownFields?: { fields: {[key: string]: { fixed32?: number[]; fixed64?: number[]; lengthDelimited?: string[]; varint?: number[]; }; }; }; }; packageIdSelectionPreference?: string[]; prefetchContractKeys?: { contractKey: unknown; templateId: string; }[]; readAs?: string[]; submissionId?: string; synchronizerId?: string; userId?: string; workflowId?: string; }>

Defined in: cct/canton/token-pool/operations/set-rate-limit-config.ts:106

Builds the SetRateLimitConfig exercise command against the pool.

Parameters

Parameter	Type
chain	CantonChain
p	GenerateSetRateLimitConfigParams

Returns

Promise<{ actAs: string[]; commandId: string; commands: ({ CreateAndExerciseCommand: { choice: string; choiceArgument: unknown; createArguments: unknown; templateId: string; }; } | { CreateCommand: { createArguments: unknown; templateId: string; }; } | { ExerciseByKeyCommand: { choice: string; choiceArgument: unknown; contractKey: unknown; templateId: string; }; } | { ExerciseCommand: { choice: string; choiceArgument: unknown; contractId: string; templateId: string; }; })[]; deduplicationPeriod?: { DeduplicationDuration: { value: { nanos: number; seconds: number; unknownFields?: { fields: {[key: string]: { fixed32?: ... | ...; fixed64?: ... | ...; lengthDelimited?: ... | ...; varint?: ... | ...; }; }; }; }; }; } | { DeduplicationOffset: { value: number; }; } | { Empty: Record<string, never>; }; disclosedContracts?: { contractId?: string; createdEventBlob: string; synchronizerId?: string; templateId?: string; }[]; minLedgerTimeAbs?: string; minLedgerTimeRel?: { nanos: number; seconds: number; unknownFields?: { fields: {[key: string]: { fixed32?: number[]; fixed64?: number[]; lengthDelimited?: string[]; varint?: number[]; }; }; }; }; packageIdSelectionPreference?: string[]; prefetchContractKeys?: { contractKey: unknown; templateId: string; }[]; readAs?: string[]; submissionId?: string; synchronizerId?: string; userId?: string; workflowId?: string; }>

Overrides

CantonOperation.buildCommands

---

execute()

execute(chain: CantonChain, params: ExecuteSetRateLimitConfigParams): Promise<ExecuteSetRateLimitConfigResult>

Defined in: cct/canton/token-pool/operations/set-rate-limit-config.ts:151

Validates the wallet, derives sender from wallet.party, builds the commands, and submits via submitCantonCommands. Returns the confirmed updateId plus the raw ledger response for result parsing.

Parameters

Parameter	Type
chain	CantonChain
params	ExecuteSetRateLimitConfigParams

Returns

Promise<ExecuteSetRateLimitConfigResult>

Overrides

CantonOperation.execute

---

generate()

generate(chain: CantonChain, params: CantonGenerateParams<SetRateLimitConfigParams>): Promise<UnsignedCantonTx>

Defined in: cct/canton/operation.ts:86

Run prepare and buildCommands; no signing.

Parameters

Parameter	Type
chain	CantonChain
params	CantonGenerateParams<SetRateLimitConfigParams>

Returns

Promise<UnsignedCantonTx>

Inherited from

CantonOperation.generate

---

prepare()

protected prepare(p: GenerateSetRateLimitConfigParams): GenerateSetRateLimitConfigParams

Defined in: cct/canton/token-pool/operations/set-rate-limit-config.ts:70

Validates the pool/limiter targets and mirrors the on-ledger config constraints.

Parameters

Parameter	Type
p	GenerateSetRateLimitConfigParams

Returns

GenerateSetRateLimitConfigParams

Overrides

CantonOperation.prepare