Wallet SDK - Canton Network Docs

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

Name	Kind	Summary	Introduced	Changed	Deprecated	Removed
`AmuletNamespace`	Class	-	`1.3.1`	-	-	-
`AssetNamespace`	Class	-	`1.3.1`	`1.4.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	-	-
`InitializedSDK`	Class	-	`1.3.1`	`1.4.0`: type parameters added: `CurrentlyExtended`	-	-
`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`	`1.4.0`: details updated	-	-
`SDKPlugin`	Class	-	`1.3.1`	`1.4.0`: members added: `_ctx`	-	-
`SignedTransaction`	Class	-	`1.3.1`	-	-	-
`TokenNamespace`	Class	-	`1.3.1`	-	-	-
`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	-	-
`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	-	-
`AssetContext`	Type Alias	-	`1.3.1`	-	-	-
`BasicSDKInterface`	Type Alias	-	`1.3.1`	`1.4.0`: signature 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`	-	-	-
`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	-	-
`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	-	-
`LedgerTypes`	Type Alias	-	`1.3.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`	-	-	-
`PreapprovalParties`	Type Alias	-	`1.3.1`	-	-	-
`PreparedCommand`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated	-	-
`PrepareOptions`	Type Alias	-	`1.3.1`	`1.4.0`: signature updated	-	-
`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`	`1.4.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`	-	-	-
`EXTENDED_SDK_OPTION_KEYS`	Variable	-	`1.3.1`	-	-	-
`localNetStaticConfig`	Variable	-	`1.3.1`	-	-	-
`fetchAmulet`	Function	-	`1.3.1`	-	-	-
`findAsset`	Function	-	`1.3.1`	`1.4.0`: call signatures updated	-	-
`getPublicKeyFromPrivate`	Function	-	`1.3.1`	-	-	-
`getValidatorParty`	Function	-	`1.4.0`	-	-	-
`signTransactionHash`	Function	-	`1.3.1`	-	-	-

Version Change Summary

Version	Added	Changed	Removed
`1.3.1`	`50`	-	-
`1.4.0`	`9`	`20`	-

Reference

Classes

AmuletNamespace

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

Members

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

AssetNamespace

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

Version Changes

Version	Changes
`1.4.0`	details updated

Members

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

CustomLogAdapter

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

Kind: Class
Introduced: 1.3.1
Changed in: 1.4.0
Source: dist/wallet/init/initializedSDK.d.ts:30

Version Changes

Version	Changes
`1.4.0`	details updated

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
Changed in: 1.4.0
Source: dist/wallet/init/initializedSDK.d.ts:13

Version Changes

Version	Changes
`1.4.0`	type parameters added: `CurrentlyExtended`

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

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

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
Changed in: 1.4.0
Source: dist/wallet/sdk.d.ts:21

Version Changes

Version	Changes
`1.4.0`	details updated

Members

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

SDKPlugin

Kind: Class
Introduced: 1.3.1
Changed in: 1.4.0
Source: dist/wallet/init/plugin.d.ts:3

Version Changes

Version	Changes
`1.4.0`	members added: `_ctx`

Members

Member	Type	Description
`constructor`	`void`	-
`_ctx`	`SDKContext`	-
`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:15

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

LogAdapter

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

Signature

interface LogAdapter

Members

Member	Type	Description
`log`	`void`	-

Type Aliases

AllowedLogAdapters

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

Signature

type AllowedLogAdapters = DefaultLogAdapters | CustomLogAdapter

AmuletConfig

Kind: Type Alias
Introduced: 1.3.1
Changed in: 1.4.0
Source: dist/wallet/init/types/config.d.ts:3

Version Changes

Version	Changes
`1.4.0`	signature updated

Signature

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

AmuletNamespaceConfig

Kind: Type Alias
Introduced: 1.3.1
Changed in: 1.4.0
Source: dist/wallet/namespace/amulet/namespace.d.ts:11

Version Changes

Version	Changes
`1.4.0`	signature updated

Signature

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

AssetBody

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

Version Changes

Version	Changes
`1.4.0`	signature updated

Signature

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

AssetConfig

Kind: Type Alias
Introduced: 1.3.1
Changed in: 1.4.0
Source: dist/wallet/init/types/config.d.ts:14

Version Changes

Version	Changes
`1.4.0`	signature updated

Signature

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

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
Changed in: 1.4.0
Source: dist/wallet/init/types/sdk.d.ts:47

Version Changes

Version	Changes
`1.4.0`	signature updated

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

Kind: Type Alias
Introduced: 1.3.1
Changed in: 1.4.0
Source: dist/wallet/init/types/sdk.d.ts:24

Version Changes

Version	Changes
`1.4.0`	signature updated

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

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

Signature

type CompletionEvent = LedgerCommonSchemas["CompletionStreamResponse"]

DefaultLogAdapters

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

Signature

type DefaultLogAdapters = "console" | "pino"

Event

Kind: Type Alias
Introduced: 1.3.1
Changed in: 1.4.0
Source: dist/wallet/namespace/events/types.d.ts:31

Version Changes

Version	Changes
`1.4.0`	signature updated

Signature

type Event = UpdateEvent | CompletionEvent

EventsConfig

Kind: Type Alias
Introduced: 1.3.1
Changed in: 1.4.0
Source: dist/wallet/init/types/config.d.ts:18

Version Changes

Version	Changes
`1.4.0`	signature updated

Signature

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

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:56

Signature

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

ExtendedSDKInterface

Kind: Type Alias
Introduced: 1.3.1
Changed in: 1.4.0
Source: dist/wallet/init/types/sdk.d.ts:65

Version Changes

Version	Changes
`1.4.0`	signature updated

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>>; registerPlugins: (plugins: P) => SDKInterface<ExtendedItems> & RegisteredPlugins<P> }

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:37

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:44

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
Changed in: 1.4.0
Source: dist/wallet/namespace/amulet/types.d.ts:31

Version Changes

Version	Changes
`1.4.0`	signature updated

Signature

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

LedgerTypes

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

Signature

type LedgerTypes = LedgerCommonSchemas

LogContext

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

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

Signature

type LogLevel = typeof LOG_LEVELS_TUPLE[number]

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:62

Signature

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

OfflineSDKContext

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

Signature

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

OfflineSDKInterface

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

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
Changed in: 1.4.0
Source: dist/wallet/namespace/transactions/types.d.ts:3

Version Changes

Version	Changes
`1.4.0`	signature updated

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

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

Version Changes

Version	Changes
`1.4.0`	signature updated

Signature

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

RegisteredPlugins

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

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/init/types/context.d.ts:4

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:71

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:43

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
Changed in: 1.4.0
Source: dist/wallet/init/types/config.d.ts:9

Version Changes

Version	Changes
`1.4.0`	signature updated

Signature

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

TokenNamespaceConfig

Kind: Type Alias
Introduced: 1.3.1
Changed in: 1.4.0
Source: dist/wallet/namespace/token/namespace.d.ts:9

Version Changes

Version	Changes
`1.4.0`	signature updated

Signature

type TokenNamespaceConfig = { commonCtx: SDKContext; registryUrls: ParsedURL[]; 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" }

UpdateEvent

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

Signature

type UpdateEvent = LedgerCommonSchemas["JsGetUpdatesResponse"]

Variables

EXTENDED_SDK_OPTION_KEYS

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

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:65

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
Changed in: 1.4.0
Source: dist/wallet/namespace/asset/index.d.ts:23

Version Changes

Version	Changes
`1.4.0`	call signatures updated

Signature

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

Call Signatures

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

Parameter	Type	Required	Description
`assets`	`AssetBody[]`	yes	-
`id`	`string`	yes	-
`error`	`SDKErrorHandler`	yes	-
`registryUrl`	`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

getValidatorParty

Kind: Function
Introduced: 1.4.0
Source: dist/wallet/sdk.d.ts:31

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

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

​Table of Contents

​Version Change Summary

​Reference

​Classes

​AmuletNamespace

​AssetNamespace

​CustomLogAdapter

​ExtendedInitializedSDK

​InitializedSDK

​LedgerProvider

​OfflineInitializedSDK

​PreapprovalNamespace

​PreparedTransaction

​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

​LedgerTypes

​LogContext

​LogLevel

​LookupFeaturedAppRightsOptions

​NullableExtendedFullSDKInterface

​OfflineSDKContext

​OfflineSDKInterface

​PreapprovalParties

​PreparedCommand

​PrepareOptions

​RegisteredPlugins

​SDKContext

​SDKInterface

​SDKOptions

​TokenConfig

​TokenNamespaceConfig

​TokenProviderConfig

​UpdateEvent

​Variables

​EXTENDED_SDK_OPTION_KEYS

​localNetStaticConfig

​Functions

​fetchAmulet

​findAsset

​getPublicKeyFromPrivate

​getValidatorParty

​signTransactionHash

Table of Contents

Version Change Summary

Reference

Classes

AmuletNamespace

AssetNamespace

CustomLogAdapter

ExtendedInitializedSDK

InitializedSDK

LedgerProvider

OfflineInitializedSDK

PreapprovalNamespace

PreparedTransaction

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

LedgerTypes

LogContext

LogLevel

LookupFeaturedAppRightsOptions

NullableExtendedFullSDKInterface

OfflineSDKContext

OfflineSDKInterface

PreapprovalParties

PreparedCommand

PrepareOptions

RegisteredPlugins

SDKContext

SDKInterface

SDKOptions

TokenConfig

TokenNamespaceConfig

TokenProviderConfig

UpdateEvent

Variables

EXTENDED_SDK_OPTION_KEYS

localNetStaticConfig

Functions

fetchAmulet

findAsset

getPublicKeyFromPrivate

getValidatorParty

signTransactionHash