Wallet SDK

TypeScript package

Wallet SDK

TypeScript client library reference for wallet integrations.

TypeScriptAdded 1.5.1 Updated 1.5.1 Exports removed in 1.5.1

Package@canton-network/wallet-sdk

Current release1.5.1

Compared releases4

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

Name	Kind	Summary	Introduced	Changed	Deprecated	Removed
`AmuletNamespace`	Class	-	`1.3.1`	`1.5.0`: members added: `isDevNet`	-	-
`AssetNamespace`	Class	-	`1.3.1`	`1.4.0`: details updated<br/>`1.5.0`: details updated	-	-
`CustomLogAdapter`	Class	CustomLogAdapter allows users to provide their own logging implementation. This adapter can be passed to SDKLogger to enable custom log handling logic, such as integrating with third-party logging services or frameworks.	`1.4.0`	-	-	-
`ExtendedInitializedSDK`	Class	-	`1.3.1`	`1.4.0`: details updated<br/>`1.5.0`: details updated	-	-
`InitializedSDK`	Class	-	`1.3.1`	`1.4.0`: type parameters added: `CurrentlyExtended`<br/>`1.5.0`: details updated	-	-
`LedgerProvider`	Class	-	`1.3.1`	-	-	-
`OfflineInitializedSDK`	Class	-	`1.3.1`	-	-	-
`PreapprovalNamespace`	Class	-	`1.3.1`	`1.5.0`: members updated: `command`	-	-
`PreparedTransaction`	Class	-	`1.3.1`	`1.5.0`: members updated: `preparedPromise`<br/>`1.5.1`: details updated	-	-
`ScanProxyClient`	Class	-	`1.5.0`	-	-	-
`SDK`	Class	-	`1.3.1`	`1.4.0`: details updated	-	-
`SDKPlugin`	Class	-	`1.3.1`	`1.4.0`: members added: `_ctx`<br/>`1.5.0`: type parameters added: `ExtendedNamespaceItems`; members updated: `_ctx`, `ctx`	-	-
`SignedTransaction`	Class	-	`1.3.1`	`1.5.0`: members updated: `signedPromise`<br/>`1.5.1`: details updated	-	-
`TokenNamespace`	Class	-	`1.3.1`	`1.5.0`: members added: `assets`, `find`	-	-
`FeaturedAppService`	Interface	-	`1.3.1`	-	-	-
`LogAdapter`	Interface	-	`1.4.0`	-	-	-
`AllowedLogAdapters`	Type Alias	-	`1.4.0`	-	-	-
`AmuletConfig`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated<br/>`1.5.0`: signature updated	-	-
`AmuletNamespaceConfig`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated	-	-
`AssetBody`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated	-	-
`AssetConfig`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated<br/>`1.5.0`: signature updated	-	-
`AssetContext`	Type Alias	-	`1.3.1`	`1.5.0`: signature updated	-	-
`BasicSDKInterface`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated<br/>`1.5.0`: details updated	-	-
`BasicSDKOptions`	Type Alias	Options for configuring the Wallet SDK instance.	`1.3.1`	`1.4.0`: signature updated	-	-
`CompletionEvent`	Type Alias	-	`1.4.0`	`1.5.1`: details updated	-	-
`DefaultLogAdapters`	Type Alias	-	`1.4.0`	-	-	-
`Event`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated	-	-
`EventsConfig`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated	-	-
`ExecuteOptions`	Type Alias	-	`1.3.1`	-	-	-
`ExtendedFullSDKInterface`	Type Alias	-	`1.3.1`	-	-	-
`ExtendedSDKInterface`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated<br/>`1.5.0`: signature updated	-	-
`ExtendedSDKOptions`	Type Alias	-	`1.3.1`	-	-	-
`FeaturedAppRight`	Type Alias	-	`1.3.1`	-	-	-
`GetExtendedKeys`	Type Alias	-	`1.3.1`	-	-	-
`GrantFeaturedAppRightsOptions`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated	-	-
`LedgerCommonSchemas`	Type Alias	-	`1.5.1`	-	-	-
`LogContext`	Type Alias	Contextual metadata for log entries.	`1.4.0`	-	-	-
`LogLevel`	Type Alias	-	`1.4.0`	-	-	-
`LookupFeaturedAppRightsOptions`	Type Alias	-	`1.3.1`	-	-	-
`NullableExtendedFullSDKInterface`	Type Alias	-	`1.3.1`	-	-	-
`OfflineSDKContext`	Type Alias	-	`1.3.1`	-	-	-
`OfflineSDKInterface`	Type Alias	-	`1.3.1`	-	-	-
`PluginConstructor`	Type Alias	-	`1.5.0`	-	-	-
`PreapprovalParties`	Type Alias	-	`1.3.1`	-	-	-
`PreparedCommand`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated<br/>`1.5.0`: details updated<br/>`1.5.1`: details updated	-	-
`PrepareOptions`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated<br/>`1.5.0`: details updated<br/>`1.5.1`: details updated	-	-
`RegisteredPlugins`	Type Alias	-	`1.3.1`	`1.5.0`: signature updated; type parameters updated: `P`	-	-
`RegistryAuth`	Type Alias	-	`1.5.0`	-	-	-
`SDKContext`	Type Alias	-	`1.3.1`	-	-	-
`SDKInterface`	Type Alias	-	`1.3.1`	-	-	-
`SDKOptions`	Type Alias	-	`1.3.1`	-	-	-
`SDKPluginContext`	Type Alias	-	`1.5.0`	-	-	-
`TokenConfig`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated<br/>`1.5.0`: signature updated	-	-
`TokenNamespaceConfig`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated	-	-
`TokenProviderConfig`	Type Alias	-	`1.3.1`	-	-	-
`UpdateEvent`	Type Alias	-	`1.4.0`	`1.5.1`: details updated	-	-
`LedgerTypes`	Type Alias	-	`1.3.1`	-	-	`1.5.1`
`EXTENDED_SDK_OPTION_KEYS`	Variable	-	`1.3.1`	-	-	-
`localNetStaticConfig`	Variable	-	`1.3.1`	`1.5.0`: signature updated	-	-
`fetchAmulet`	Function	-	`1.3.1`	-	-	-
`findAsset`	Function	-	`1.3.1`	`1.4.0`: call signatures updated<br/>`1.5.0`: call signatures updated	-	-
`getPublicKeyFromPrivate`	Function	-	`1.3.1`	-	-	-
`getValidatorParty`	Function	-	`1.4.0`	-	-	-
`signTransactionHash`	Function	-	`1.3.1`	-	-	-

Reference

Classes

AmuletNamespace

ClassUpdated 1.5.0

Kind: Class
Source: dist/wallet/namespace/amulet/namespace.d.ts:18

Members

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

AssetNamespace

ClassUpdated 1.5.0

Kind: Class
Source: dist/wallet/namespace/asset/index.d.ts:20

Members

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

CustomLogAdapter

ClassAdded 1.4.0

Kind: Class
Source: dist/wallet/logger/adapter/custom.d.ts:16

CustomLogAdapter allows users to provide their own logging implementation. This adapter can be passed to SDKLogger to enable custom log handling logic, such as integrating with third-party logging services or frameworks. Members

Member	Type	Description
`constructor`	`void`	-
`log`	`(type: "debug" \| "error" \| "info" \| "warn" \| "trace", ctx: Partial, message?: string) => void`	-

ExtendedInitializedSDK

ClassUpdated 1.5.0

Kind: Class
Source: dist/wallet/init/initializedSDK.d.ts:33

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

ClassUpdated 1.5.0

Kind: Class
Source: dist/wallet/init/initializedSDK.d.ts:12

Type Parameters

Name	Constraint	Default	Description
`CurrentlyExtended`	`keyof ExtendedSDKOptions`	`never`	-

Members

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

LedgerProvider

Class

Kind: Class
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

Class

Kind: Class
Source: dist/wallet/init/initializedSDK.d.ts:27

Members

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

PreapprovalNamespace

ClassUpdated 1.5.0

Kind: Class
Source: dist/wallet/namespace/amulet/preapproval.d.ts:6

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

ClassUpdated 1.5.1

Kind: Class
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" \| "HASHING_SCHEME_VERSION_V4"; preparedTransaction: string; preparedTransactionHash: string }>`	-
`decode`	`void`	-
`sign`	`void`	-
`toJSON`	`void`	-

ScanProxyClient

ClassAdded 1.5.0

Kind: Class
Source: node_modules/@canton-network/core-splice-client/dist/scan-proxy-client.d.ts:46

Members

Member	Type	Description
`constructor`	`void`	-
`get`	`void`	-
`getActiveOpenMiningRound`	`void`	-
`getAmuletRules`	`void`	-
`getAmuletSynchronizerId`	`void`	-
`getOpenMiningRounds`	`void`	-
`isDevNet`	`void`	-
`post`	`void`	-
`invalidateAmuletRulesCache`	`void`	-
`invalidateOpenMiningRoundsCache`	`void`	-

SDK

ClassUpdated 1.4.0

Kind: Class
Source: dist/wallet/sdk.d.ts:22

Members

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

SDKPlugin

ClassUpdated 1.5.0

Kind: Class
Source: dist/wallet/init/plugin.d.ts:7

Type Parameters

Name	Constraint	Default	Description
`ExtendedNamespaceItems`	`keyof ExtendedFullSDKInterface`	`never`	-

Members

Member	Type	Description
`constructor`	`void`	-
`_ctx`	`SDKPluginContext<ExtendedNamespaceItems>`	-
`ctx`	`SDKPluginContext<ExtendedNamespaceItems>`	-
`logger`	`SDKLogger`	-
`name`	`string`	-

SignedTransaction

ClassUpdated 1.5.1

Kind: Class
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" \| "HASHING_SCHEME_VERSION_V4"; preparedTransaction: string; preparedTransactionHash: string }; signature: string }>`	-
`execute`	`void`	-
`response`	`void`	-
`signature`	`void`	-

TokenNamespace

ClassUpdated 1.5.0

Kind: Class
Source: dist/wallet/namespace/token/namespace.d.ts:16

Members

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

Interfaces

FeaturedAppService

Interface

Kind: Interface
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

LogAdapter

InterfaceAdded 1.4.0

Kind: Interface
Source: dist/wallet/logger/types.d.ts:40

Signature

interface LogAdapter

Members

Member	Type	Description
`log`	`void`	-

Type Aliases

AllowedLogAdapters

Type AliasAdded 1.4.0

Kind: Type Alias
Source: dist/wallet/logger/types.d.ts:44

Signature

type AllowedLogAdapters = DefaultLogAdapters | CustomLogAdapter

AmuletConfig

Type AliasUpdated 1.5.0

Kind: Type Alias
Source: dist/wallet/init/types/config.d.ts:12

Signature

type AmuletConfig = RegistryAuthConfig & { auth: TokenProviderConfig; registryUrl: URLInput; scanApiUrl: URLInput; validatorUrl?: URLInput }

AmuletNamespaceConfig

Type AliasUpdated 1.4.0

Kind: Type Alias
Source: dist/wallet/namespace/amulet/namespace.d.ts:11

Signature

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

AssetBody

Type AliasUpdated 1.4.0

Kind: Type Alias
Source: dist/wallet/namespace/asset/index.d.ts:6

Signature

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

AssetConfig

Type AliasUpdated 1.5.0

Kind: Type Alias
Source: dist/wallet/init/types/config.d.ts:23

Signature

type AssetConfig = RegistryAuthConfig & { auth: TokenProviderConfig; registries: URLInput[] }

AssetContext

Type AliasUpdated 1.5.0

Kind: Type Alias
Source: dist/wallet/namespace/asset/index.d.ts:13

Signature

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

BasicSDKInterface

Type AliasUpdated 1.5.0

Kind: Type Alias
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) => SDKInterface<CurrentlyExtended> & RegisteredPlugins<P>; user: UserNamespace; utils: SDKUtilsNamespace }>

Type Parameters

Name	Constraint	Default	Description
`CurrentlyExtended`	`keyof ExtendedSDKOptions`	`never`	-

BasicSDKOptions

Type AliasUpdated 1.4.0

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

Signature

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

Options for configuring the Wallet SDK instance. Type Parameters

Name	Constraint	Default	Description
`L`	`LedgerTypes`	-	-

CompletionEvent

Type AliasAdded 1.4.0 Updated 1.5.1

Kind: Type Alias
Source: dist/wallet/namespace/events/types.d.ts:30

Signature

type CompletionEvent = LedgerCommonSchemas["CompletionStreamResponse"]

DefaultLogAdapters

Type AliasAdded 1.4.0

Kind: Type Alias
Source: dist/wallet/logger/types.d.ts:43

Signature

type DefaultLogAdapters = "console" | "pino"

Event

Type AliasUpdated 1.4.0

Kind: Type Alias
Source: dist/wallet/namespace/events/types.d.ts:31

Signature

type Event = UpdateEvent | CompletionEvent

EventsConfig

Type AliasUpdated 1.4.0

Kind: Type Alias
Source: dist/wallet/init/types/config.d.ts:27

Signature

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

ExecuteOptions

Type Alias

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

Signature

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

ExtendedFullSDKInterface

Type Alias

Kind: Type Alias
Source: dist/wallet/init/types/sdk.d.ts:59

Signature

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

ExtendedSDKInterface

Type AliasUpdated 1.5.0

Kind: Type Alias
Source: dist/wallet/init/types/sdk.d.ts:68

Signature

type ExtendedSDKInterface<ExtendedItems extends keyof ExtendedSDKOptions = void> = { [K in keyof Pick<ExtendedSDKOptions, ExtendedItems>]: ExtendedFullSDKInterface[K] }

Type Parameters

Name	Constraint	Default	Description
`ExtendedItems`	`keyof ExtendedSDKOptions`	-	-

ExtendedSDKOptions

Type Alias

Kind: Type Alias
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

Type Alias

Kind: Type Alias
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

Type Alias

Kind: Type Alias
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

Type AliasUpdated 1.4.0

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

Signature

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

LedgerCommonSchemas

Type AliasAdded 1.5.1

Kind: Type Alias
Source: node_modules/@canton-network/core-ledger-client-types/dist/index.d.ts:35

Signature

type LedgerCommonSchemas = Union<LedgerSchemasByVersion["3.5"], LedgerSchemasByVersion["3.6"]>

LogContext

Type AliasAdded 1.4.0

Kind: Type Alias
Source: dist/wallet/logger/types.d.ts:18

Signature

type LogContext = Partial<{ namespace: string; partyId: PartyId; response: unknown; timestamp: string; traceId: string }>

Contextual metadata for log entries.

LogLevel

Type AliasAdded 1.4.0

Kind: Type Alias
Source: dist/wallet/logger/types.d.ts:32

Signature

type LogLevel = typeof LOG_LEVELS_TUPLE[number]

LookupFeaturedAppRightsOptions

Type Alias

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

Signature

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

NullableExtendedFullSDKInterface

Type Alias

Kind: Type Alias
Source: dist/wallet/init/types/sdk.d.ts:65

Signature

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

OfflineSDKContext

Type Alias

Kind: Type Alias
Source: dist/wallet/init/types/context.d.ts:11

Signature

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

OfflineSDKInterface

Type Alias

Kind: Type Alias
Source: dist/wallet/init/types/sdk.d.ts:72

Signature

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

PluginConstructor

Type AliasAdded 1.5.0

Kind: Type Alias
Source: dist/wallet/init/types/sdk.d.ts:76

Signature

type PluginConstructor = (ctx: SDKPluginContext) => SDKPlugin

PreapprovalParties

Type Alias

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

Signature

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

PreparedCommand

Type AliasUpdated 1.5.1

Kind: Type Alias
Source: dist/wallet/namespace/transactions/types.d.ts:2

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, LedgerCommonSchemas["DisclosedContract"][]]

Type Parameters

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

PrepareOptions

Type AliasUpdated 1.5.1

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

Signature

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

RegisteredPlugins

Type AliasUpdated 1.5.0

Kind: Type Alias
Source: dist/wallet/init/types/sdk.d.ts:77

Signature

type RegisteredPlugins<P extends PluginConstructor[] | Record<string, PluginConstructor> = PluginConstructor[]> = P extends PluginConstructor[] ? { [K in InstanceType<P[number]>["name"]]: Extract<InstanceType<P[number]>, { name: K }> } : P extends Record<string, PluginConstructor> ? { [K in keyof P]: InstanceType<P[K]> } : never

Type Parameters

Name	Constraint	Default	Description
`P`	`PluginConstructor[] \| Record<string, PluginConstructor>`	`PluginConstructor[]`	-

RegistryAuth

Type AliasAdded 1.5.0

Kind: Type Alias
Source: dist/wallet/init/types/config.d.ts:3

Signature

type RegistryAuth = TokenProviderConfig | "none"

SDKContext

Type Alias

Kind: Type Alias
Source: dist/wallet/init/types/context.d.ts:4

Signature

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

SDKInterface

Type Alias

Kind: Type Alias
Source: dist/wallet/init/types/sdk.d.ts:71

Signature

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

Type Parameters

Name	Constraint	Default	Description
`ExtendedItems`	`keyof ExtendedFullSDKInterface`	`never`	-

SDKOptions

Type Alias

Kind: Type Alias
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`	-

SDKPluginContext

Type AliasAdded 1.5.0

Kind: Type Alias
Source: dist/wallet/init/plugin.d.ts:4

Signature

type SDKPluginContext<ExtendedItems extends keyof ExtendedFullSDKInterface = never> = SDKContext & { namespace: Omit<SDKInterface<ExtendedItems>, "extend" | "registerPlugins"> }

Type Parameters

Name	Constraint	Default	Description
`ExtendedItems`	`keyof ExtendedFullSDKInterface`	`never`	-

TokenConfig

Type AliasUpdated 1.5.0

Kind: Type Alias
Source: dist/wallet/init/types/config.d.ts:18

Signature

type TokenConfig = RegistryAuthConfig & { auth: TokenProviderConfig; registries: URLInput[]; validatorUrl?: URLInput }

TokenNamespaceConfig

Type AliasUpdated 1.4.0

Kind: Type Alias
Source: dist/wallet/namespace/token/namespace.d.ts:10

Signature

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

TokenProviderConfig

Type Alias

Kind: Type Alias
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" }

UpdateEvent

Type AliasAdded 1.4.0 Updated 1.5.1

Kind: Type Alias
Source: dist/wallet/namespace/events/types.d.ts:29

Signature

type UpdateEvent = LedgerCommonSchemas["JsGetUpdatesResponse"]

LedgerTypes

Type AliasRemoved in 1.5.1

Kind: Type Alias
Removed in 1.5.1. Retained for historical reference.
Source: dist/wallet/sdk.d.ts:16

Signature

type LedgerTypes = LedgerCommonSchemas

Variables

EXTENDED_SDK_OPTION_KEYS

Variable

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

Signature

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

localNetStaticConfig

VariableUpdated 1.5.0

Kind: Variable
Source: dist/config.d.ts:1

Signature

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

Functions

fetchAmulet

Function

Kind: Function
Source: dist/wallet/namespace/amulet/namespace.d.ts:69

Signature

fetchAmulet(amuletCtx: AmuletNamespaceConfig): Promise<AssetBody>

Call Signatures

fetchAmulet(amuletCtx: AmuletNamespaceConfig): Promise<AssetBody>

Parameter	Type	Required	Description
`amuletCtx`	`AmuletNamespaceConfig`	yes	-

Returns: Promise<AssetBody>

findAsset

FunctionUpdated 1.5.0

Kind: Function
Source: dist/wallet/namespace/asset/index.d.ts:26

Signature

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

Call Signatures

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

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

Returns: AssetBody

getPublicKeyFromPrivate

Function

Kind: Function
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

getValidatorParty

FunctionAdded 1.4.0

Kind: Function
Source: dist/wallet/sdk.d.ts:32

Signature

getValidatorParty(validatorUrl: URL, auth: AuthTokenProvider | TokenProviderConfig, sdkLogger?: SDKLogger): Promise<string>

Call Signatures

getValidatorParty(validatorUrl: URL, auth: AuthTokenProvider | TokenProviderConfig, sdkLogger?: SDKLogger): Promise<string>

Parameter	Type	Required	Description
`validatorUrl`	`URL`	yes	-
`auth`	`AuthTokenProvider \| TokenProviderConfig`	yes	-
`sdkLogger`	`SDKLogger`	no	-

Returns: Promise<string>

signTransactionHash

Function

Kind: Function
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

History

Exports removed in1.5.1

LedgerTypes: Last available in 1.5.0. Retained for historical reference.

Updated1.5.1

PreparedTransaction: details updated

SignedTransaction: details updated

CompletionEvent: details updated

PreparedCommand: details updated

PrepareOptions: details updated

UpdateEvent: details updated

Added1.5.1

1 exported symbol added.

Updated1.5.0

AmuletNamespace: members added: isDevNet

AssetNamespace: details updated

ExtendedInitializedSDK: details updated

InitializedSDK: details updated

PreapprovalNamespace: members updated: command

PreparedTransaction: members updated: preparedPromise

SDKPlugin: type parameters added: ExtendedNamespaceItems; members updated: _ctx, ctx

SignedTransaction: members updated: signedPromise

TokenNamespace: members added: assets, find

AmuletConfig: signature updated

AssetConfig: signature updated

AssetContext: signature updated

BasicSDKInterface: details updated

ExtendedSDKInterface: signature updated

PreparedCommand: details updated

PrepareOptions: details updated

RegisteredPlugins: signature updated; type parameters updated: P

TokenConfig: signature updated

localNetStaticConfig: signature updated

findAsset: call signatures updated

Added1.5.0

4 exported symbols added.

Updated1.4.0

AssetNamespace: details updated

ExtendedInitializedSDK: details updated

InitializedSDK: type parameters added: CurrentlyExtended

SDK: details updated

SDKPlugin: members added: _ctx

AmuletConfig: signature updated

AmuletNamespaceConfig: signature updated

AssetBody: signature updated

AssetConfig: signature updated

BasicSDKInterface: signature updated

BasicSDKOptions: signature updated

Event: signature updated

EventsConfig: signature updated

ExtendedSDKInterface: signature updated

GrantFeaturedAppRightsOptions: signature updated

PreparedCommand: signature updated

PrepareOptions: signature updated

TokenConfig: signature updated

TokenNamespaceConfig: signature updated

findAsset: call signatures updated

Added1.4.0

9 exported symbols added.

← Back to Documentation

Wallet SDK

​Wallet SDK

​Table of Contents

​Reference

​Classes

​AmuletNamespace

​AssetNamespace

​CustomLogAdapter

​ExtendedInitializedSDK

​InitializedSDK

​LedgerProvider

​OfflineInitializedSDK

​PreapprovalNamespace

​PreparedTransaction

​ScanProxyClient

​SDK

​SDKPlugin

​SignedTransaction

​TokenNamespace

​Interfaces

​FeaturedAppService

​LogAdapter

​Type Aliases

​AllowedLogAdapters

​AmuletConfig

​AmuletNamespaceConfig

​AssetBody

​AssetConfig

​AssetContext

​BasicSDKInterface

​BasicSDKOptions

​CompletionEvent

​DefaultLogAdapters

​Event

​EventsConfig

​ExecuteOptions

​ExtendedFullSDKInterface

​ExtendedSDKInterface

​ExtendedSDKOptions

​FeaturedAppRight

​GetExtendedKeys

​GrantFeaturedAppRightsOptions

​LedgerCommonSchemas

​LogContext

​LogLevel

​LookupFeaturedAppRightsOptions

​NullableExtendedFullSDKInterface

​OfflineSDKContext

​OfflineSDKInterface

​PluginConstructor

​PreapprovalParties

​PreparedCommand

​PrepareOptions

​RegisteredPlugins

​RegistryAuth

​SDKContext

​SDKInterface

​SDKOptions

​SDKPluginContext

​TokenConfig

​TokenNamespaceConfig

​TokenProviderConfig

​UpdateEvent

​LedgerTypes

​Variables

​EXTENDED_SDK_OPTION_KEYS

​localNetStaticConfig

​Functions

​fetchAmulet

​findAsset

​getPublicKeyFromPrivate

​getValidatorParty

​signTransactionHash

​History

Wallet SDK

Table of Contents

Reference

Classes

AmuletNamespace

AssetNamespace

CustomLogAdapter

ExtendedInitializedSDK

InitializedSDK

LedgerProvider

OfflineInitializedSDK

PreapprovalNamespace

PreparedTransaction

ScanProxyClient

SDK

SDKPlugin

SignedTransaction

TokenNamespace

Interfaces

FeaturedAppService

LogAdapter

Type Aliases

AllowedLogAdapters

AmuletConfig

AmuletNamespaceConfig

AssetBody

AssetConfig

AssetContext

BasicSDKInterface

BasicSDKOptions

CompletionEvent

DefaultLogAdapters

Event

EventsConfig

ExecuteOptions

ExtendedFullSDKInterface

ExtendedSDKInterface

ExtendedSDKOptions

FeaturedAppRight

GetExtendedKeys

GrantFeaturedAppRightsOptions

LedgerCommonSchemas

LogContext

LogLevel

LookupFeaturedAppRightsOptions

NullableExtendedFullSDKInterface

OfflineSDKContext

OfflineSDKInterface

PluginConstructor

PreapprovalParties

PreparedCommand

PrepareOptions

RegisteredPlugins

RegistryAuth

SDKContext

SDKInterface

SDKOptions

SDKPluginContext

TokenConfig

TokenNamespaceConfig

TokenProviderConfig

UpdateEvent

LedgerTypes

Variables

EXTENDED_SDK_OPTION_KEYS

localNetStaticConfig

Functions

fetchAmulet

findAsset

getPublicKeyFromPrivate

getValidatorParty

signTransactionHash

History