& RegisteredPlugins; 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**
```ts theme={null}
type BasicSDKOptions = Readonly<{ logAdapter?: AllowedLogAdapters; websocketUrl?: URL | string } & { auth: TokenProviderConfig; ledgerClientUrl: URL | string } | { ledgerProvider: Provider }>
```
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**
```ts theme={null}
type CompletionEvent = LedgerCommonSchemas["CompletionStreamResponse"]
```
#### DefaultLogAdapters
* Kind: `Type Alias`
* Introduced: `1.4.0`
* Source: `dist/wallet/logger/types.d.ts:43`
**Signature**
```ts theme={null}
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**
```ts theme={null}
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**
```ts theme={null}
type EventsConfig = { auth: TokenProviderConfig; websocketURL: URLInput }
```
#### ExecuteOptions
* Kind: `Type Alias`
* Introduced: `1.3.1`
* Source: `dist/wallet/namespace/ledger/types.d.ts:11`
**Signature**
```ts theme={null}
type ExecuteOptions = { partyId: PartyId; submissionId?: string }
```
#### ExtendedFullSDKInterface
* Kind: `Type Alias`
* Introduced: `1.3.1`
* Source: `dist/wallet/init/types/sdk.d.ts:56`
**Signature**
```ts theme={null}
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**
```ts theme={null}
type ExtendedSDKInterface = { [K in keyof Pick]: ExtendedFullSDKInterface[K] } & { extend: (config: Pick) => Promise>; registerPlugins: (plugins: P) => SDKInterface & RegisteredPlugins }
```
**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**
```ts theme={null}
type ExtendedSDKOptions = EnforceKeys>
```
#### FeaturedAppRight
* Kind: `Type Alias`
* Introduced: `1.3.1`
* Source: `dist/wallet/namespace/amulet/types.d.ts:19`
**Signature**
```ts theme={null}
type FeaturedAppRight = { contract_id: string; created_at: string; created_event_blob: string; payload: Record; template_id: string }
```
#### GetExtendedKeys
* Kind: `Type Alias`
* Introduced: `1.3.1`
* Source: `dist/wallet/init/types/sdk.d.ts:44`
**Signature**
```ts theme={null}
type GetExtendedKeys = { [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**
```ts theme={null}
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**
```ts theme={null}
type LedgerTypes = LedgerCommonSchemas
```
#### LogContext
* Kind: `Type Alias`
* Introduced: `1.4.0`
* Source: `dist/wallet/logger/types.d.ts:18`
**Signature**
```ts theme={null}
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**
```ts theme={null}
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**
```ts theme={null}
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**
```ts theme={null}
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**
```ts theme={null}
type OfflineSDKContext = { error: SDKErrorHandler; logger: SDKLogger }
```
#### OfflineSDKInterface
* Kind: `Type Alias`
* Introduced: `1.3.1`
* Source: `dist/wallet/init/types/sdk.d.ts:72`
**Signature**
```ts theme={null}
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**
```ts theme={null}
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**
```ts theme={null}
type PreparedCommand = [K extends keyof RawCommandMap[] ? WrappedCommand : K extends keyof RawCommandMap ? WrappedCommand : 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**
```ts theme={null}
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**
```ts theme={null}
type RegisteredPlugins SDKPlugin> = Record SDKPlugin>> = { [K in keyof P]: InstanceType }
```
**Type Parameters**
| Name | Constraint | Default | Description |
| ---- | ------------------------------------------------ | ------------------------------------------------ | ----------- |
| `P` | `Record SDKPlugin>` | `Record SDKPlugin>` | - |
#### SDKContext
* Kind: `Type Alias`
* Introduced: `1.3.1`
* Source: `dist/wallet/init/types/context.d.ts:4`
**Signature**
```ts theme={null}
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**
```ts theme={null}
type SDKInterface = BasicSDKInterface & ExtendedSDKInterface
```
**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**
```ts theme={null}
type SDKOptions = BasicSDKOptions & Pick
```
**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**
```ts theme={null}
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**
```ts theme={null}
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**
```ts theme={null}
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**
```ts theme={null}
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**
```ts theme={null}
const EXTENDED_SDK_OPTION_KEYS: readonly ["amulet", "token", "asset", "events"]
```
#### localNetStaticConfig
* Kind: `Variable`
* Introduced: `1.3.1`
* Source: `dist/config.d.ts:1`
**Signature**
```ts theme={null}
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**
```ts theme={null}
fetchAmulet(amuletCtx: AmuletNamespaceConfig): Promise
```
**Call Signatures**
```ts theme={null}
fetchAmulet(amuletCtx: AmuletNamespaceConfig): Promise
```
| Parameter | Type | Required | Description |
| ----------- | ----------------------- | -------- | ----------- |
| `amuletCtx` | `AmuletNamespaceConfig` | yes | - |
Returns: `Promise`
#### 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**
```ts theme={null}
findAsset(assets: AssetBody[], id: string, error: SDKErrorHandler, registryUrl?: URL): AssetBody
```
**Call Signatures**
```ts theme={null}
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**
```ts theme={null}
getPublicKeyFromPrivate(privateKeyBase64: string): string
```
**Call Signatures**
```ts theme={null}
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**
```ts theme={null}
getValidatorParty(validatorUrl: URL, auth: AuthTokenProvider | TokenProviderConfig, sdkLogger?: SDKLogger): Promise
```
**Call Signatures**
```ts theme={null}
getValidatorParty(validatorUrl: URL, auth: AuthTokenProvider | TokenProviderConfig, sdkLogger?: SDKLogger): Promise
```
| Parameter | Type | Required | Description |
| -------------- | ------------------------------------------ | -------- | ----------- |
| `validatorUrl` | `URL` | yes | - |
| `auth` | `AuthTokenProvider \| TokenProviderConfig` | yes | - |
| `sdkLogger` | `SDKLogger` | no | - |
Returns: `Promise`
#### signTransactionHash
* Kind: `Function`
* Introduced: `1.3.1`
* Source: `node_modules/@canton-network/core-signing-lib/dist/index.d.ts:28`
**Signature**
```ts theme={null}
signTransactionHash(txHash: string, privateKey: string): string
```
**Call Signatures**
```ts theme={null}
signTransactionHash(txHash: string, privateKey: string): string
```
| Parameter | Type | Required | Description |
| ------------ | -------- | -------- | ----------- |
| `txHash` | `string` | yes | - |
| `privateKey` | `string` | yes | - |
Returns: `string`