Skip to main content
Version: 1.15.0

Function: parseCantonInstrumentId()

parseCantonInstrumentId(instrument: string): CantonInstrumentId

Defined in: canton/types.ts:183

Parse a Canton instrument string party::fingerprint::tokenId into CantonInstrumentId for ledger Holding filters and CCIP fee/token fields.

Parameters​

ParameterType
instrumentstring

Returns​

CantonInstrumentId

Example​

TypeScript
parseCantonInstrumentId(
'ccipOwner::1220e382…::link-token',
)
// => { admin: 'ccipOwner::1220e382…', id: 'link-token' }

Throws​

CCIPArgumentInvalidError if the string is not three ::-separated parts.