Wallet SDK

TypeScript client library reference for wallet integrations.

Generated from published @canton-network/wallet-sdk TypeDoc snapshots.

Table of Contents

Name	Kind	Summary	Introduced	Changed	Deprecated	Removed
AmuletNamespace	Class	-	1.3.1	-	-	-
AssetNamespace	Class	-	1.3.1	-	-	-
ExtendedInitializedSDK	Class	-	1.3.1	-	-	-
InitializedSDK	Class	-	1.3.1	-	-	-
LedgerProvider	Class	-	1.3.1	-	-	-
OfflineInitializedSDK	Class	-	1.3.1	-	-	-
PreapprovalNamespace	Class	-	1.3.1	-	-	-
PreparedTransaction	Class	-	1.3.1	-	-	-
SDK	Class	-	1.3.1	-	-	-
SDKPlugin	Class	-	1.3.1	-	-	-
SignedTransaction	Class	-	1.3.1	-	-	-
TokenNamespace	Class	-	1.3.1	-	-	-
FeaturedAppService	Interface	-	1.3.1	-	-	-
AmuletConfig	Type Alias	-	1.3.1	-	-	-
AmuletNamespaceConfig	Type Alias	-	1.3.1	-	-	-
AssetBody	Type Alias	-	1.3.1	-	-	-
AssetConfig	Type Alias	-	1.3.1	-	-	-
AssetContext	Type Alias	-	1.3.1	-	-	-
BasicSDKInterface	Type Alias	-	1.3.1	-	-	-
BasicSDKOptions	Type Alias	Options for configuring the Wallet SDK instance.	1.3.1	-	-	-
Event	Type Alias	-	1.3.1	-	-	-
EventsConfig	Type Alias	-	1.3.1	-	-	-
ExecuteOptions	Type Alias	-	1.3.1	-	-	-
ExtendedFullSDKInterface	Type Alias	-	1.3.1	-	-	-
ExtendedSDKInterface	Type Alias	-	1.3.1	-	-	-
ExtendedSDKOptions	Type Alias	-	1.3.1	-	-	-
FeaturedAppRight	Type Alias	-	1.3.1	-	-	-
GetExtendedKeys	Type Alias	-	1.3.1	-	-	-
GrantFeaturedAppRightsOptions	Type Alias	-	1.3.1	-	-	-
LedgerTypes	Type Alias	-	1.3.1	-	-	-
LookupFeaturedAppRightsOptions	Type Alias	-	1.3.1	-	-	-
NullableExtendedFullSDKInterface	Type Alias	-	1.3.1	-	-	-
OfflineSDKContext	Type Alias	-	1.3.1	-	-	-
OfflineSDKInterface	Type Alias	-	1.3.1	-	-	-
PreapprovalParties	Type Alias	-	1.3.1	-	-	-
PreparedCommand	Type Alias	-	1.3.1	-	-	-
PrepareOptions	Type Alias	-	1.3.1	-	-	-
RegisteredPlugins	Type Alias	-	1.3.1	-	-	-
SDKContext	Type Alias	-	1.3.1	-	-	-
SDKInterface	Type Alias	-	1.3.1	-	-	-
SDKOptions	Type Alias	-	1.3.1	-	-	-
TokenConfig	Type Alias	-	1.3.1	-	-	-
TokenNamespaceConfig	Type Alias	-	1.3.1	-	-	-
TokenProviderConfig	Type Alias	-	1.3.1	-	-	-
EXTENDED_SDK_OPTION_KEYS	Variable	-	1.3.1	-	-	-
localNetStaticConfig	Variable	-	1.3.1	-	-	-
fetchAmulet	Function	-	1.3.1	-	-	-
findAsset	Function	-	1.3.1	-	-	-
getPublicKeyFromPrivate	Function	-	1.3.1	-	-	-
signTransactionHash	Function	-	1.3.1	-	-	-

Version Change Summary

Version	Added	Changed	Removed
1.3.1	50	-	-

Reference

Classes

AmuletNamespace

• Kind: Class
• Introduced: 1.3.1
• Source: dist/wallet/namespace/amulet/namespace.d.ts:16

Members

Member	Type	Description
constructor	void	-
featuredApp	FeaturedAppNamespace	-
preapproval	PreapprovalNamespace	-
traffic	TrafficNamespace	-
tap	void	-
tapInternal	void	-

AssetNamespace

• Kind: Class
• Introduced: 1.3.1
• Source: dist/wallet/namespace/asset/index.d.ts:17

Members

Member	Type	Description
constructor	void	-
list	void	-
find	void	-

ExtendedInitializedSDK

• Kind: Class
• Introduced: 1.3.1
• Source: dist/wallet/init/initializedSDK.d.ts:30

Type Parameters

Name	Constraint	Default	Description
ExtendedItems	keyof ExtendedSDKOptions	-	-

Members

Member	Type	Description
amulet	ExtendedItems extends "amulet" ? AmuletNamespace : never	-
asset	ExtendedItems extends "asset" ? AssetNamespace : never	-
ctx	SDKContext	-
events	ExtendedItems extends "events" ? EventsNamespace : never	-
keys	KeysNamespace	-
ledger	LedgerNamespace	-
party	PartyNamespace	-
token	ExtendedItems extends "token" ? TokenNamespace : never	-
user	UserNamespace	-
utils	SDKUtilsNamespace	-
extend	void	-
registerPlugins	void	-
create	void	-

InitializedSDK

• Kind: Class
• Introduced: 1.3.1
• Source: dist/wallet/init/initializedSDK.d.ts:13

Members

Member	Type	Description
constructor	void	-
ctx	SDKContext	-
keys	KeysNamespace	-
ledger	LedgerNamespace	-
party	PartyNamespace	-
user	UserNamespace	-
utils	SDKUtilsNamespace	-
extend	void	-
registerPlugins	void	-

LedgerProvider

• Kind: Class
• Introduced: 1.3.1
• Source: node_modules/@canton-network/core-provider-ledger/dist/LedgerProvider.d.ts:8

Members

Member	Type	Description
constructor	void	-
listeners	{}	-
emit	void	-
on	void	-
removeListener	void	-
request	void	-

OfflineInitializedSDK

• Kind: Class
• Introduced: 1.3.1
• Source: dist/wallet/init/initializedSDK.d.ts:24

Members

Member	Type	Description
constructor	void	-
ctx	OfflineSDKContext	-
keys	KeysNamespace	-
utils	SDKUtilsNamespace	-

PreapprovalNamespace

• Kind: Class
• Introduced: 1.3.1
• Source: dist/wallet/namespace/amulet/preapproval.d.ts:5

Members

Member	Type	Description
constructor	void	-
command	{ cancel: (args: { parties: PreapprovalParties }) => Promise<[{ ExerciseCommand: { choice: string; choiceArgument: unknown; contractId: string; templateId: string } & { choice: string; choiceArgument: unknown; contractId: string; templateId: string } }, { contractId?: string; createdEventBlob: string; synchronizerId?: string; templateId?: string } & { contractId?: string; createdEventBlob: string; synchronizerId?: string; templateId?: string }[]] | readonly [null, readonly []]>; create: (args: { parties: PreapprovalParties }) => Promise<{ CreateCommand: { createArguments: unknown; templateId: string } & { createArguments: unknown; templateId: string } }> }	Commands for managing transfer preapprovals. The return result can be used as an argument to pass to signing and execution of a transaction. Transfer preapprovals allow receivers to automatically accept incoming transfers.		fetchQuick	void	-
fetchStatus	void	-
renew	void	-

PreparedTransaction

• Kind: Class
• Introduced: 1.3.1
• Source: dist/wallet/namespace/transactions/prepared.d.ts:6

Members

Member	Type	Description
constructor	void	-
preparedPromise	Promise<{ costEstimation?: { confirmationRequestTrafficCostEstimation: number; confirmationResponseTrafficCostEstimation: number; estimationTimestamp: string; totalTrafficCostEstimation: number }; hashingDetails?: string; hashingSchemeVersion: "HASHING_SCHEME_VERSION_UNSPECIFIED" | "HASHING_SCHEME_VERSION_V2" | "HASHING_SCHEME_VERSION_V3"; preparedTransaction: string; preparedTransactionHash: string }>	-
decode	void	-
sign	void	-
toJSON	void	-

SDK

• Kind: Class
• Introduced: 1.3.1
• Source: dist/wallet/sdk.d.ts:32

Members

Member	Type	Description
constructor	void	-
create	void	-
createOffline	void	-

SDKPlugin

• Kind: Class
• Introduced: 1.3.1
• Source: dist/wallet/init/plugin.d.ts:3

Members

Member	Type	Description
constructor	void	-
ctx	SDKContext	-
logger	SDKLogger	-
name	string	-

SignedTransaction

• Kind: Class
• Introduced: 1.3.1
• Source: dist/wallet/namespace/transactions/signed.d.ts:5

Members

Member	Type	Description
constructor	void	-
signedPromise	Promise<{ response: { costEstimation?: { confirmationRequestTrafficCostEstimation: number; confirmationResponseTrafficCostEstimation: number; estimationTimestamp: string; totalTrafficCostEstimation: number }; hashingDetails?: string; hashingSchemeVersion: "HASHING_SCHEME_VERSION_UNSPECIFIED" | "HASHING_SCHEME_VERSION_V2" | "HASHING_SCHEME_VERSION_V3"; preparedTransaction: string; preparedTransactionHash: string }; signature: string }>	-
execute	void	-
response	void	-
signature	void	-

TokenNamespace

• Kind: Class
• Introduced: 1.3.1
• Source: dist/wallet/namespace/token/namespace.d.ts:14

Members

Member	Type	Description
constructor	void	-
allocation	AllocationNamespace	-
transfer	TransferNamespace	-
utxos	UtxoNamespace	-
holdings	void	-
transactionsById	void	-

Interfaces

FeaturedAppService

• Kind: Interface
• Introduced: 1.3.1
• Source: dist/wallet/namespace/amulet/types.d.ts:6

Signature

interface FeaturedAppService

Members

Member	Type	Description
grant	(options?: GrantFeaturedAppRightsOptions) => Promise<FeaturedAppRight>	Submits a command to grant feature app rights for validator operator.
rights	(options: LookupFeaturedAppRightsOptions) => Promise<FeaturedAppRight>	Looks up if a party has FeaturedAppRight. Has an in built retry and delay between attempts

Type Aliases

AmuletConfig

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/config.d.ts:2

Signature

type AmuletConfig = { auth: TokenProviderConfig; registryUrl: URL; scanApiUrl: string | URL; validatorUrl: string | URL }

AmuletNamespaceConfig

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/namespace/amulet/namespace.d.ts:9

Signature

type AmuletNamespaceConfig = { amuletService: AmuletService; commonCtx: SDKContext; registry: URL | AssetBody; tokenStandardService: TokenStandardService; validatorParty: PartyId }

AssetBody

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/namespace/asset/index.d.ts:4

Signature

type AssetBody = { admin: PartyId; displayName: string; id: string; registryUrl: string; symbol: string }

AssetConfig

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/config.d.ts:13

Signature

type AssetConfig = { auth: TokenProviderConfig; registries: URL[] }

AssetContext

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/namespace/asset/index.d.ts:11

Signature

type AssetContext = { error: SDKErrorHandler; list: AssetBody[]; registries: URL[]; tokenStandardService: TokenStandardService }

BasicSDKInterface

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/sdk.d.ts:46

Signature

type BasicSDKInterface<CurrentlyExtended extends keyof ExtendedSDKOptions = never> = Readonly<{ extend: (config: Pick<ExtendedSDKOptions, ExtendedItems>) => Promise<SDKInterface<ExtendedItems | CurrentlyExtended>>; keys: KeysNamespace; ledger: LedgerNamespace; party: PartyNamespace; registerPlugins: (plugins: P) => BasicSDKInterface<CurrentlyExtended> & RegisteredPlugins<P>; user: UserNamespace; utils: SDKUtilsNamespace }>

Type Parameters

Name	Constraint	Default	Description
CurrentlyExtended	keyof ExtendedSDKOptions	never	-

BasicSDKOptions

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/sdk.d.ts:23

Signature

type BasicSDKOptions<L extends LedgerTypes = void> = Readonly<{ logAdapter?: AllowedLogAdapters; websocketUrl?: string | URL } & { auth: TokenProviderConfig; ledgerClientUrl: string | URL } | { ledgerProvider: Provider<L> }>

Options for configuring the Wallet SDK instance.

Type Parameters

Name	Constraint	Default	Description
L	LedgerTypes	-	-

Event

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/namespace/events/types.d.ts:28

Signature

type Event = LedgerCommonSchemas["JsGetUpdatesResponse"]

EventsConfig

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/config.d.ts:17

Signature

type EventsConfig = { auth: TokenProviderConfig; websocketURL: string }

ExecuteOptions

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/namespace/ledger/types.d.ts:11

Signature

type ExecuteOptions = { partyId: PartyId; submissionId?: string }

ExtendedFullSDKInterface

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/sdk.d.ts:55

Signature

type ExtendedFullSDKInterface = Readonly<{ amulet: AmuletNamespace; asset: AssetNamespace; events: EventsNamespace; token: TokenNamespace }>

ExtendedSDKInterface

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/sdk.d.ts:64

Signature

type ExtendedSDKInterface<ExtendedItems extends keyof ExtendedSDKOptions = void> = { [K in keyof Pick<ExtendedSDKOptions, ExtendedItems>]: ExtendedFullSDKInterface[K] } & { extend: (config: Pick<ExtendedSDKOptions, NewExtendedItems>) => Promise<SDKInterface<NewExtendedItems | ExtendedItems>> }

Type Parameters

Name	Constraint	Default	Description
ExtendedItems	keyof ExtendedSDKOptions	-	-

ExtendedSDKOptions

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/sdk.d.ts:36

Signature

type ExtendedSDKOptions = EnforceKeys<typeof EXTENDED_SDK_OPTION_KEYS[number], Readonly<{ amulet: AmuletConfig; asset: AssetConfig; events: EventsConfig; token: TokenConfig }>>

FeaturedAppRight

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/namespace/amulet/types.d.ts:19

Signature

type FeaturedAppRight = { contract_id: string; created_at: string; created_event_blob: string; payload: Record<string, never>; template_id: string }

GetExtendedKeys

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/sdk.d.ts:43

Signature

type GetExtendedKeys<T extends void = void> = { [K in keyof ExtendedSDKOptions]: K extends keyof T ? undefined extends T[K] ? never : K : never }[keyof ExtendedSDKOptions]

Type Parameters

Name	Constraint	Default	Description
T	-	-	-

GrantFeaturedAppRightsOptions

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/namespace/amulet/types.d.ts:31

Signature

type GrantFeaturedAppRightsOptions = { delayMs?: number; maxRetries?: number; synchronizerId?: string }

LedgerTypes

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/sdk.d.ts:16

Signature

type LedgerTypes = LedgerCommonSchemas

LookupFeaturedAppRightsOptions

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/namespace/amulet/types.d.ts:26

Signature

type LookupFeaturedAppRightsOptions = { delayMs?: number; maxRetries?: number; partyId: string }

NullableExtendedFullSDKInterface

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/sdk.d.ts:61

Signature

type NullableExtendedFullSDKInterface = { [K in keyof ExtendedFullSDKInterface]: ExtendedFullSDKInterface[K] | null }

OfflineSDKContext

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/sdk.d.ts:24

Signature

type OfflineSDKContext = { error: SDKErrorHandler; logger: SDKLogger }

OfflineSDKInterface

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/sdk.d.ts:70

Signature

type OfflineSDKInterface = Readonly<{ keys: KeysNamespace; utils: SDKUtilsNamespace }>

PreapprovalParties

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/namespace/amulet/types.d.ts:2

Signature

type PreapprovalParties = { provider?: PartyId; receiver: PartyId }

PreparedCommand

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/namespace/transactions/types.d.ts:3

Signature

type PreparedCommand<K extends keyof RawCommandMap | keyof RawCommandMap[] = ["ExerciseCommand", "CreateCommand"]> = [K extends keyof RawCommandMap[] ? WrappedCommand<K[number]> : K extends keyof RawCommandMap ? WrappedCommand<K> : never, LedgerTypes["DisclosedContract"][]]

Type Parameters

Name	Constraint	Default	Description
K	keyof RawCommandMap | keyof RawCommandMap[]	["ExerciseCommand", "CreateCommand"]	-

PrepareOptions

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/namespace/ledger/types.d.ts:4

Signature

type PrepareOptions = { commandId?: string; commands: WrappedCommand | WrappedCommand[] | unknown; disclosedContracts?: LedgerTypes["DisclosedContract"][]; partyId: PartyId; synchronizerId?: string }

RegisteredPlugins

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/sdk.d.ts:74

Signature

type RegisteredPlugins<P extends Record<string, (ctx: SDKContext) => SDKPlugin> = Record<string, (ctx: SDKContext) => SDKPlugin>> = { [K in keyof P]: InstanceType<P[K]> }

Type Parameters

Name	Constraint	Default	Description
P	Record<string, (ctx: SDKContext) => SDKPlugin>	Record<string, (ctx: SDKContext) => SDKPlugin>	-

SDKContext

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/sdk.d.ts:17

Signature

type SDKContext = { defaultSynchronizerId: string; error: SDKErrorHandler; ledgerProvider: AbstractLedgerProvider; logger: SDKLogger; userId: string }

SDKInterface

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/sdk.d.ts:69

Signature

type SDKInterface<ExtendedItems extends keyof ExtendedFullSDKInterface = never> = BasicSDKInterface<ExtendedItems> & ExtendedSDKInterface<ExtendedItems>

Type Parameters

Name	Constraint	Default	Description
ExtendedItems	keyof ExtendedFullSDKInterface	never	-

SDKOptions

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/sdk.d.ts:42

Signature

type SDKOptions<ExtendedItems extends keyof ExtendedSDKOptions = never> = BasicSDKOptions<LedgerTypes> & Pick<ExtendedSDKOptions, ExtendedItems>

Type Parameters

Name	Constraint	Default	Description
ExtendedItems	keyof ExtendedSDKOptions	never	-

TokenConfig

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/init/types/config.d.ts:8

Signature

type TokenConfig = { auth: TokenProviderConfig; registries: URL[] | string[]; validatorUrl: string | URL }

TokenNamespaceConfig

• Kind: Type Alias
• Introduced: 1.3.1
• Source: dist/wallet/namespace/token/namespace.d.ts:8

Signature

type TokenNamespaceConfig = { commonCtx: SDKContext; registryUrls: URL[]; tokenStandardService: TokenStandardService; validatorParty: PartyId }

TokenProviderConfig

• Kind: Type Alias
• Introduced: 1.3.1
• Source: node_modules/@canton-network/core-wallet-auth/dist/auth-token-provider.d.ts:4

Signature

type TokenProviderConfig = { method: "static"; token: string } | { credentials: ClientCredentials; issuer: string; method: "self_signed" } | { configUrl: string; credentials: ClientCredentials; method: "client_credentials" }

Variables

EXTENDED_SDK_OPTION_KEYS

• Kind: Variable
• Introduced: 1.3.1
• Source: dist/wallet/init/types/sdk.d.ts:32

Signature

const EXTENDED_SDK_OPTION_KEYS: readonly ["amulet", "token", "asset", "events"]

localNetStaticConfig

• Kind: Variable
• Introduced: 1.3.1
• Source: dist/config.d.ts:1

Signature

const localNetStaticConfig: { LOCALNET_APP_USER_LEDGER_URL: URL; LOCALNET_APP_VALIDATOR_URL: URL; LOCALNET_REGISTRY_API_URL: URL; LOCALNET_SCAN_API_URL: URL; LOCALNET_TOKEN_STANDARD_URL: URL; LOCALNET_USER_ID: string }

Functions

fetchAmulet

• Kind: Function
• Introduced: 1.3.1
• Source: dist/wallet/namespace/amulet/namespace.d.ts:63

Signature

fetchAmulet(amuletCtx: AmuletNamespaceConfig): Promise<AssetBody>

Call Signatures

fetchAmulet(amuletCtx: AmuletNamespaceConfig): Promise<AssetBody>

Parameter	Type	Required	Description
amuletCtx	AmuletNamespaceConfig	yes	-

Returns: Promise<AssetBody>

findAsset

• Kind: Function
• Introduced: 1.3.1
• Source: dist/wallet/namespace/asset/index.d.ts:23

Signature

findAsset(assets: AssetBody[], id: string, error: SDKErrorHandler, registryUrl?: string | URL): AssetBody

Call Signatures

findAsset(assets: AssetBody[], id: string, error: SDKErrorHandler, registryUrl?: string | URL): AssetBody

Parameter	Type	Required	Description
assets	AssetBody[]	yes	-
id	string	yes	-
error	SDKErrorHandler	yes	-
registryUrl	string | URL	no	-

Returns: AssetBody

getPublicKeyFromPrivate

• Kind: Function
• Introduced: 1.3.1
• Source: node_modules/@canton-network/core-signing-lib/dist/index.d.ts:30

Signature

getPublicKeyFromPrivate(privateKeyBase64: string): string

Call Signatures

getPublicKeyFromPrivate(privateKeyBase64: string): string

Parameter	Type	Required	Description
privateKeyBase64	string	yes	-

Returns: string

signTransactionHash

• Kind: Function
• Introduced: 1.3.1
• Source: node_modules/@canton-network/core-signing-lib/dist/index.d.ts:28

Signature

signTransactionHash(txHash: string, privateKey: string): string

Call Signatures

signTransactionHash(txHash: string, privateKey: string): string

Parameter	Type	Required	Description
txHash	string	yes	-
privateKey	string	yes	-

Returns: string