> ## Documentation Index
> Fetch the complete documentation index at: https://cantonfoundation-generated-references-canton-protobuf-histo.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Wallet SDK

> TypeScript client library reference for wallet integrations.

<div class="x2mdx-ref-page x2mdx-ref-page--collection" />

<div class="x2mdx-ref-hero">
  <p class="x2mdx-ref-eyebrow">TypeScript package</p>

  <h1 class="x2mdx-ref-title">Wallet SDK</h1>

  <p class="x2mdx-ref-summary">TypeScript client library reference for wallet integrations.</p>

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">TypeScript</span>

    <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-5-1">Added 1.5.1</a>

    <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-1">Updated 1.5.1</a>

    <a class="x2mdx-ref-badge x2mdx-ref-badge--removed" href="#history-removed-1-5-1">Exports removed in 1.5.1</a>
  </div>

  <div class="x2mdx-ref-meta-grid">
    <div class="x2mdx-ref-meta-item">
      <span class="x2mdx-ref-meta-label">Package</span>
      <span class="x2mdx-ref-meta-value">@canton-network/wallet-sdk</span>
    </div>

    <div class="x2mdx-ref-meta-item">
      <span class="x2mdx-ref-meta-label">Current release</span>
      <span class="x2mdx-ref-meta-value">1.5.1</span>
    </div>

    <div class="x2mdx-ref-meta-item">
      <span class="x2mdx-ref-meta-label">Compared releases</span>
      <span class="x2mdx-ref-meta-value">4</span>
    </div>
  </div>
</div>

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

## Table of Contents

| Name | Kind | Summary | Introduced | Changed | Deprecated | Removed |
| - | - | - | - | - | - | - |
| [`AmuletNamespace`](#class-amuletnamespace) | Class | - | `1.3.1` | `1.5.0`: members added: `isDevNet` | - | - |
| [`AssetNamespace`](#class-assetnamespace) | Class | - | `1.3.1` | `1.4.0`: details updated\<br/>`1.5.0`: details updated | - | - |
| [`CustomLogAdapter`](#class-customlogadapter) | Class | CustomLogAdapter allows users to provide their own logging implementation.<br /><br />This adapter can be passed to SDKLogger to enable custom log handling logic,<br />such as integrating with third-party logging services or frameworks. | `1.4.0` | - | - | - |
| [`ExtendedInitializedSDK`](#class-extendedinitializedsdk) | Class | - | `1.3.1` | `1.4.0`: details updated\<br/>`1.5.0`: details updated | - | - |
| [`InitializedSDK`](#class-initializedsdk) | Class | - | `1.3.1` | `1.4.0`: type parameters added: `CurrentlyExtended`\<br/>`1.5.0`: details updated | - | - |
| [`LedgerProvider`](#class-ledgerprovider) | Class | - | `1.3.1` | - | - | - |
| [`OfflineInitializedSDK`](#class-offlineinitializedsdk) | Class | - | `1.3.1` | - | - | - |
| [`PreapprovalNamespace`](#class-preapprovalnamespace) | Class | - | `1.3.1` | `1.5.0`: members updated: `command` | - | - |
| [`PreparedTransaction`](#class-preparedtransaction) | Class | - | `1.3.1` | `1.5.0`: members updated: `preparedPromise`\<br/>`1.5.1`: details updated | - | - |
| [`ScanProxyClient`](#class-scanproxyclient) | Class | - | `1.5.0` | - | - | - |
| [`SDK`](#class-sdk) | Class | - | `1.3.1` | `1.4.0`: details updated | - | - |
| [`SDKPlugin`](#class-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-signedtransaction) | Class | - | `1.3.1` | `1.5.0`: members updated: `signedPromise`\<br/>`1.5.1`: details updated | - | - |
| [`TokenNamespace`](#class-tokennamespace) | Class | - | `1.3.1` | `1.5.0`: members added: `assets`, `find` | - | - |
| [`FeaturedAppService`](#interface-featuredappservice) | Interface | - | `1.3.1` | - | - | - |
| [`LogAdapter`](#interface-logadapter) | Interface | - | `1.4.0` | - | - | - |
| [`AllowedLogAdapters`](#type-alias-allowedlogadapters) | Type Alias | - | `1.4.0` | - | - | - |
| [`AmuletConfig`](#type-alias-amuletconfig) | Type Alias | - | `1.3.1` | `1.4.0`: signature updated\<br/>`1.5.0`: signature updated | - | - |
| [`AmuletNamespaceConfig`](#type-alias-amuletnamespaceconfig) | Type Alias | - | `1.3.1` | `1.4.0`: signature updated | - | - |
| [`AssetBody`](#type-alias-assetbody) | Type Alias | - | `1.3.1` | `1.4.0`: signature updated | - | - |
| [`AssetConfig`](#type-alias-assetconfig) | Type Alias | - | `1.3.1` | `1.4.0`: signature updated\<br/>`1.5.0`: signature updated | - | - |
| [`AssetContext`](#type-alias-assetcontext) | Type Alias | - | `1.3.1` | `1.5.0`: signature updated | - | - |
| [`BasicSDKInterface`](#type-alias-basicsdkinterface) | Type Alias | - | `1.3.1` | `1.4.0`: signature updated\<br/>`1.5.0`: details updated | - | - |
| [`BasicSDKOptions`](#type-alias-basicsdkoptions) | Type Alias | Options for configuring the Wallet SDK instance. | `1.3.1` | `1.4.0`: signature updated | - | - |
| [`CompletionEvent`](#type-alias-completionevent) | Type Alias | - | `1.4.0` | `1.5.1`: details updated | - | - |
| [`DefaultLogAdapters`](#type-alias-defaultlogadapters) | Type Alias | - | `1.4.0` | - | - | - |
| [`Event`](#type-alias-event) | Type Alias | - | `1.3.1` | `1.4.0`: signature updated | - | - |
| [`EventsConfig`](#type-alias-eventsconfig) | Type Alias | - | `1.3.1` | `1.4.0`: signature updated | - | - |
| [`ExecuteOptions`](#type-alias-executeoptions) | Type Alias | - | `1.3.1` | - | - | - |
| [`ExtendedFullSDKInterface`](#type-alias-extendedfullsdkinterface) | Type Alias | - | `1.3.1` | - | - | - |
| [`ExtendedSDKInterface`](#type-alias-extendedsdkinterface) | Type Alias | - | `1.3.1` | `1.4.0`: signature updated\<br/>`1.5.0`: signature updated | - | - |
| [`ExtendedSDKOptions`](#type-alias-extendedsdkoptions) | Type Alias | - | `1.3.1` | - | - | - |
| [`FeaturedAppRight`](#type-alias-featuredappright) | Type Alias | - | `1.3.1` | - | - | - |
| [`GetExtendedKeys`](#type-alias-getextendedkeys) | Type Alias | - | `1.3.1` | - | - | - |
| [`GrantFeaturedAppRightsOptions`](#type-alias-grantfeaturedapprightsoptions) | Type Alias | - | `1.3.1` | `1.4.0`: signature updated | - | - |
| [`LedgerCommonSchemas`](#type-alias-ledgercommonschemas) | Type Alias | - | `1.5.1` | - | - | - |
| [`LogContext`](#type-alias-logcontext) | Type Alias | Contextual metadata for log entries. | `1.4.0` | - | - | - |
| [`LogLevel`](#type-alias-loglevel) | Type Alias | - | `1.4.0` | - | - | - |
| [`LookupFeaturedAppRightsOptions`](#type-alias-lookupfeaturedapprightsoptions) | Type Alias | - | `1.3.1` | - | - | - |
| [`NullableExtendedFullSDKInterface`](#type-alias-nullableextendedfullsdkinterface) | Type Alias | - | `1.3.1` | - | - | - |
| [`OfflineSDKContext`](#type-alias-offlinesdkcontext) | Type Alias | - | `1.3.1` | - | - | - |
| [`OfflineSDKInterface`](#type-alias-offlinesdkinterface) | Type Alias | - | `1.3.1` | - | - | - |
| [`PluginConstructor`](#type-alias-pluginconstructor) | Type Alias | - | `1.5.0` | - | - | - |
| [`PreapprovalParties`](#type-alias-preapprovalparties) | Type Alias | - | `1.3.1` | - | - | - |
| [`PreparedCommand`](#type-alias-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-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-registeredplugins) | Type Alias | - | `1.3.1` | `1.5.0`: signature updated; type parameters updated: `P` | - | - |
| [`RegistryAuth`](#type-alias-registryauth) | Type Alias | - | `1.5.0` | - | - | - |
| [`SDKContext`](#type-alias-sdkcontext) | Type Alias | - | `1.3.1` | - | - | - |
| [`SDKInterface`](#type-alias-sdkinterface) | Type Alias | - | `1.3.1` | - | - | - |
| [`SDKOptions`](#type-alias-sdkoptions) | Type Alias | - | `1.3.1` | - | - | - |
| [`SDKPluginContext`](#type-alias-sdkplugincontext) | Type Alias | - | `1.5.0` | - | - | - |
| [`TokenConfig`](#type-alias-tokenconfig) | Type Alias | - | `1.3.1` | `1.4.0`: signature updated\<br/>`1.5.0`: signature updated | - | - |
| [`TokenNamespaceConfig`](#type-alias-tokennamespaceconfig) | Type Alias | - | `1.3.1` | `1.4.0`: signature updated | - | - |
| [`TokenProviderConfig`](#type-alias-tokenproviderconfig) | Type Alias | - | `1.3.1` | - | - | - |
| [`UpdateEvent`](#type-alias-updateevent) | Type Alias | - | `1.4.0` | `1.5.1`: details updated | - | - |
| [`LedgerTypes`](#type-alias-ledgertypes) | Type Alias | - | `1.3.1` | - | - | `1.5.1` |
| [`EXTENDED_SDK_OPTION_KEYS`](#variable-extended-sdk-option-keys) | Variable | - | `1.3.1` | - | - | - |
| [`localNetStaticConfig`](#variable-localnetstaticconfig) | Variable | - | `1.3.1` | `1.5.0`: signature updated | - | - |
| [`fetchAmulet`](#function-fetchamulet) | Function | - | `1.3.1` | - | - | - |
| [`findAsset`](#function-findasset) | Function | - | `1.3.1` | `1.4.0`: call signatures updated\<br/>`1.5.0`: call signatures updated | - | - |
| [`getPublicKeyFromPrivate`](#function-getpublickeyfromprivate) | Function | - | `1.3.1` | - | - | - |
| [`getValidatorParty`](#function-getvalidatorparty) | Function | - | `1.4.0` | - | - | - |
| [`signTransactionHash`](#function-signtransactionhash) | Function | - | `1.3.1` | - | - | - |

## Reference

### Classes

<span id="class-amuletnamespace" />

#### AmuletNamespace

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

* 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` | - |

<span id="class-assetnamespace" />

#### AssetNamespace

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

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

**Members**

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

<span id="class-customlogadapter" />

#### CustomLogAdapter

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-4-0">Added 1.4.0</a>
</div>

* 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` | - |

<span id="class-extendedinitializedsdk" />

#### ExtendedInitializedSDK

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

* 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` | - |

<span id="class-initializedsdk" />

#### InitializedSDK

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

* 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` | - |

<span id="class-ledgerprovider" />

#### LedgerProvider

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>
</div>

* 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` | - |

<span id="class-offlineinitializedsdk" />

#### OfflineInitializedSDK

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>
</div>

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

**Members**

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

<span id="class-preapprovalnamespace" />

#### PreapprovalNamespace

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

* 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.<br />Transfer preapprovals allow receivers to automatically accept incoming transfers. |
| `fetchQuick` | `void` | - |
| `fetchStatus` | `void` | - |
| `renew` | `void` | - |

<span id="class-preparedtransaction" />

#### PreparedTransaction

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-1">Updated 1.5.1</a>
</div>

* 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` | - |

<span id="class-scanproxyclient" />

#### ScanProxyClient

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-5-0">Added 1.5.0</a>
</div>

* 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` | - |

<span id="class-sdk" />

#### SDK

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-4-0">Updated 1.4.0</a>
</div>

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

**Members**

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

<span id="class-sdkplugin" />

#### SDKPlugin

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

* 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` | - |

<span id="class-signedtransaction" />

#### SignedTransaction

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-1">Updated 1.5.1</a>
</div>

* 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` | - |

<span id="class-tokennamespace" />

#### TokenNamespace

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Class</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

* 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

<span id="interface-featuredappservice" />

#### FeaturedAppService

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Interface</span>
</div>

* Kind: `Interface`
* Source: `dist/wallet/namespace/amulet/types.d.ts:6`

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
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.<br />Has an in built retry and delay between attempts |

<span id="interface-logadapter" />

#### LogAdapter

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Interface</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-4-0">Added 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
interface LogAdapter
```

**Members**

| Member | Type | Description |
| - | - | - |
| `log` | `void` | - |

### Type Aliases

<span id="type-alias-allowedlogadapters" />

#### AllowedLogAdapters

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-4-0">Added 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type AllowedLogAdapters = DefaultLogAdapters | CustomLogAdapter
```

<span id="type-alias-amuletconfig" />

#### AmuletConfig

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type AmuletConfig = RegistryAuthConfig & { auth: TokenProviderConfig; registryUrl: URLInput; scanApiUrl: URLInput; validatorUrl?: URLInput }
```

<span id="type-alias-amuletnamespaceconfig" />

#### AmuletNamespaceConfig

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-4-0">Updated 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type AmuletNamespaceConfig = { amuletService: AmuletService; commonCtx: SDKContext; registry: ParsedURL | AssetBody; tokenStandardService: TokenStandardService; validatorParty?: PartyId }
```

<span id="type-alias-assetbody" />

#### AssetBody

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-4-0">Updated 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type AssetBody = { admin: PartyId; displayName: string; id: string; registryUrl: URL; symbol: string }
```

<span id="type-alias-assetconfig" />

#### AssetConfig

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type AssetConfig = RegistryAuthConfig & { auth: TokenProviderConfig; registries: URLInput[] }
```

<span id="type-alias-assetcontext" />

#### AssetContext

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type AssetContext = { commonCtx: SDKContext; error: SDKErrorHandler; list: AssetBody[]; registries: URL[]; tokenStandardService: TokenStandardService }
```

<span id="type-alias-basicsdkinterface" />

#### BasicSDKInterface

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

* Kind: `Type Alias`
* Source: `dist/wallet/init/types/sdk.d.ts:46`

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
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` | - |

<span id="type-alias-basicsdkoptions" />

#### BasicSDKOptions

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-4-0">Updated 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
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` | - | - |

<span id="type-alias-completionevent" />

#### CompletionEvent

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-4-0">Added 1.4.0</a>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-1">Updated 1.5.1</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type CompletionEvent = LedgerCommonSchemas["CompletionStreamResponse"]
```

<span id="type-alias-defaultlogadapters" />

#### DefaultLogAdapters

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-4-0">Added 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type DefaultLogAdapters = "console" | "pino"
```

<span id="type-alias-event" />

#### Event

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-4-0">Updated 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type Event = UpdateEvent | CompletionEvent
```

<span id="type-alias-eventsconfig" />

#### EventsConfig

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-4-0">Updated 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type EventsConfig = { auth: TokenProviderConfig; websocketURL: URLInput }
```

<span id="type-alias-executeoptions" />

#### ExecuteOptions

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type ExecuteOptions = { partyId: PartyId; submissionId?: string }
```

<span id="type-alias-extendedfullsdkinterface" />

#### ExtendedFullSDKInterface

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type ExtendedFullSDKInterface = Readonly<{ amulet: AmuletNamespace; asset: AssetNamespace; events: EventsNamespace; token: TokenNamespace }>
```

<span id="type-alias-extendedsdkinterface" />

#### ExtendedSDKInterface

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type ExtendedSDKInterface<ExtendedItems extends keyof ExtendedSDKOptions = void> = { [K in keyof Pick<ExtendedSDKOptions, ExtendedItems>]: ExtendedFullSDKInterface[K] }
```

**Type Parameters**

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

<span id="type-alias-extendedsdkoptions" />

#### ExtendedSDKOptions

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

* Kind: `Type Alias`
* Source: `dist/wallet/init/types/sdk.d.ts:36`

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type ExtendedSDKOptions = EnforceKeys<typeof EXTENDED_SDK_OPTION_KEYS[number], Readonly<{ amulet: AmuletConfig; asset: AssetConfig; events: EventsConfig; token: TokenConfig }>>
```

<span id="type-alias-featuredappright" />

#### FeaturedAppRight

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

* Kind: `Type Alias`
* Source: `dist/wallet/namespace/amulet/types.d.ts:19`

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type FeaturedAppRight = { contract_id: string; created_at: string; created_event_blob: string; payload: Record<string, never>; template_id: string }
```

<span id="type-alias-getextendedkeys" />

#### GetExtendedKeys

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

* Kind: `Type Alias`
* Source: `dist/wallet/init/types/sdk.d.ts:43`

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
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` | - | - | - |

<span id="type-alias-grantfeaturedapprightsoptions" />

#### GrantFeaturedAppRightsOptions

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-4-0">Updated 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type GrantFeaturedAppRightsOptions = { delayMs?: number; maxRetries?: number; synchronizerId?: string; validatorParty?: PartyId }
```

<span id="type-alias-ledgercommonschemas" />

#### LedgerCommonSchemas

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-5-1">Added 1.5.1</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type LedgerCommonSchemas = Union<LedgerSchemasByVersion["3.5"], LedgerSchemasByVersion["3.6"]>
```

<span id="type-alias-logcontext" />

#### LogContext

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-4-0">Added 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type LogContext = Partial<{ namespace: string; partyId: PartyId; response: unknown; timestamp: string; traceId: string }>
```

Contextual metadata for log entries.

<span id="type-alias-loglevel" />

#### LogLevel

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-4-0">Added 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type LogLevel = typeof LOG_LEVELS_TUPLE[number]
```

<span id="type-alias-lookupfeaturedapprightsoptions" />

#### LookupFeaturedAppRightsOptions

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type LookupFeaturedAppRightsOptions = { delayMs?: number; maxRetries?: number; partyId: string }
```

<span id="type-alias-nullableextendedfullsdkinterface" />

#### NullableExtendedFullSDKInterface

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type NullableExtendedFullSDKInterface = { [K in keyof ExtendedFullSDKInterface]: ExtendedFullSDKInterface[K] | null }
```

<span id="type-alias-offlinesdkcontext" />

#### OfflineSDKContext

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type OfflineSDKContext = { error: SDKErrorHandler; logger: SDKLogger }
```

<span id="type-alias-offlinesdkinterface" />

#### OfflineSDKInterface

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type OfflineSDKInterface = Readonly<{ keys: KeysNamespace; utils: SDKUtilsNamespace }>
```

<span id="type-alias-pluginconstructor" />

#### PluginConstructor

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-5-0">Added 1.5.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type PluginConstructor = (ctx: SDKPluginContext) => SDKPlugin
```

<span id="type-alias-preapprovalparties" />

#### PreapprovalParties

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type PreapprovalParties = { provider?: PartyId; receiver: PartyId }
```

<span id="type-alias-preparedcommand" />

#### PreparedCommand

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-1">Updated 1.5.1</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"]` | - |

<span id="type-alias-prepareoptions" />

#### PrepareOptions

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-1">Updated 1.5.1</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type PrepareOptions = { commandId?: string; commands: WrappedCommand | WrappedCommand[] | unknown; disclosedContracts?: LedgerCommonSchemas["DisclosedContract"][]; partyId: PartyId; synchronizerId?: string }
```

<span id="type-alias-registeredplugins" />

#### RegisteredPlugins

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
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[]` | - |

<span id="type-alias-registryauth" />

#### RegistryAuth

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-5-0">Added 1.5.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type RegistryAuth = TokenProviderConfig | "none"
```

<span id="type-alias-sdkcontext" />

#### SDKContext

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type SDKContext = { defaultSynchronizerId: string; error: SDKErrorHandler; ledgerProvider: AbstractLedgerProvider; logger: SDKLogger; userId: string }
```

<span id="type-alias-sdkinterface" />

#### SDKInterface

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type SDKInterface<ExtendedItems extends keyof ExtendedFullSDKInterface = never> = BasicSDKInterface<ExtendedItems> & ExtendedSDKInterface<ExtendedItems>
```

**Type Parameters**

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

<span id="type-alias-sdkoptions" />

#### SDKOptions

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

* Kind: `Type Alias`
* Source: `dist/wallet/init/types/sdk.d.ts:42`

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type SDKOptions<ExtendedItems extends keyof ExtendedSDKOptions = never> = BasicSDKOptions<LedgerTypes> & Pick<ExtendedSDKOptions, ExtendedItems>
```

**Type Parameters**

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

<span id="type-alias-sdkplugincontext" />

#### SDKPluginContext

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-5-0">Added 1.5.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type SDKPluginContext<ExtendedItems extends keyof ExtendedFullSDKInterface = never> = SDKContext & { namespace: Omit<SDKInterface<ExtendedItems>, "extend" | "registerPlugins"> }
```

**Type Parameters**

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

<span id="type-alias-tokenconfig" />

#### TokenConfig

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type TokenConfig = RegistryAuthConfig & { auth: TokenProviderConfig; registries: URLInput[]; validatorUrl?: URLInput }
```

<span id="type-alias-tokennamespaceconfig" />

#### TokenNamespaceConfig

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-4-0">Updated 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type TokenNamespaceConfig = { commonCtx: SDKContext; registryUrls: ParsedURL[]; tokenStandardService: TokenStandardService; validatorParty?: PartyId }
```

<span id="type-alias-tokenproviderconfig" />

#### TokenProviderConfig

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type TokenProviderConfig = { method: "static"; token: string } | { credentials: ClientCredentials; issuer: string; method: "self_signed" } | { configUrl: string; credentials: ClientCredentials; method: "client_credentials" }
```

<span id="type-alias-updateevent" />

#### UpdateEvent

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-4-0">Added 1.4.0</a>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-1">Updated 1.5.1</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type UpdateEvent = LedgerCommonSchemas["JsGetUpdatesResponse"]
```

<span id="type-alias-ledgertypes" />

#### LedgerTypes

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Type Alias</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--removed" href="#history-removed-1-5-1">Removed in 1.5.1</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
type LedgerTypes = LedgerCommonSchemas
```

### Variables

<span id="variable-extended-sdk-option-keys" />

#### EXTENDED\_SDK\_OPTION\_KEYS

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Variable</span>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
const EXTENDED_SDK_OPTION_KEYS: readonly ["amulet", "token", "asset", "events"]
```

<span id="variable-localnetstaticconfig" />

#### localNetStaticConfig

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Variable</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
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

<span id="function-fetchamulet" />

#### fetchAmulet

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Function</span>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
fetchAmulet(amuletCtx: AmuletNamespaceConfig): Promise<AssetBody>
```

**Call Signatures**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
fetchAmulet(amuletCtx: AmuletNamespaceConfig): Promise<AssetBody>
```

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

Returns: `Promise<AssetBody>`

<span id="function-findasset" />

#### findAsset

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Function</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--changed" href="#history-updated-1-5-0">Updated 1.5.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
findAsset(assets: AssetBody[], id: string, error: SDKErrorHandler, registryUrl?: ParsedURL): AssetBody
```

**Call Signatures**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
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`

<span id="function-getpublickeyfromprivate" />

#### getPublicKeyFromPrivate

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Function</span>
</div>

* Kind: `Function`
* Source: `node_modules/@canton-network/core-signing-lib/dist/index.d.ts:30`

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
getPublicKeyFromPrivate(privateKeyBase64: string): string
```

**Call Signatures**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
getPublicKeyFromPrivate(privateKeyBase64: string): string
```

| Parameter | Type | Required | Description |
| - | - | - | - |
| `privateKeyBase64` | `string` | yes | - |

Returns: `string`

<span id="function-getvalidatorparty" />

#### getValidatorParty

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Function</span>

  <a class="x2mdx-ref-badge x2mdx-ref-badge--added" href="#history-added-1-4-0">Added 1.4.0</a>
</div>

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

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
getValidatorParty(validatorUrl: URL, auth: AuthTokenProvider | TokenProviderConfig, sdkLogger?: SDKLogger): Promise<string>
```

**Call Signatures**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
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>`

<span id="function-signtransactionhash" />

#### signTransactionHash

<div class="x2mdx-ref-badges">
  <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">Function</span>
</div>

* Kind: `Function`
* Source: `node_modules/@canton-network/core-signing-lib/dist/index.d.ts:28`

**Signature**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
signTransactionHash(txHash: string, privateKey: string): string
```

**Call Signatures**

```ts theme={"theme":{"light":"github-light","dark":"github-dark"}}
signTransactionHash(txHash: string, privateKey: string): string
```

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

Returns: `string`

## History

<div class="x2mdx-ref-history" aria-label="Reference history">
  <div class="x2mdx-ref-history-event x2mdx-ref-history-event--removed" id="history-removed-1-5-1">
    <div class="x2mdx-ref-history-event-head">
      <span class="x2mdx-ref-history-event-label">Exports removed in</span>
      <code class="x2mdx-ref-history-event-version">1.5.1</code>
    </div>

    <p class="x2mdx-ref-history-event-detail">LedgerTypes: Last available in 1.5.0. Retained for historical reference.</p>
  </div>

  <div class="x2mdx-ref-history-event x2mdx-ref-history-event--changed" id="history-updated-1-5-1">
    <div class="x2mdx-ref-history-event-head">
      <span class="x2mdx-ref-history-event-label">Updated</span>
      <code class="x2mdx-ref-history-event-version">1.5.1</code>
    </div>

    <p class="x2mdx-ref-history-event-detail">PreparedTransaction: details updated</p>

    <p class="x2mdx-ref-history-event-detail">SignedTransaction: details updated</p>

    <p class="x2mdx-ref-history-event-detail">CompletionEvent: details updated</p>

    <p class="x2mdx-ref-history-event-detail">PreparedCommand: details updated</p>

    <p class="x2mdx-ref-history-event-detail">PrepareOptions: details updated</p>

    <p class="x2mdx-ref-history-event-detail">UpdateEvent: details updated</p>
  </div>

  <div class="x2mdx-ref-history-event x2mdx-ref-history-event--introduced" id="history-added-1-5-1">
    <div class="x2mdx-ref-history-event-head">
      <span class="x2mdx-ref-history-event-label">Added</span>
      <code class="x2mdx-ref-history-event-version">1.5.1</code>
    </div>

    <p class="x2mdx-ref-history-event-detail">1 exported symbol added.</p>
  </div>

  <div class="x2mdx-ref-history-event x2mdx-ref-history-event--changed" id="history-updated-1-5-0">
    <div class="x2mdx-ref-history-event-head">
      <span class="x2mdx-ref-history-event-label">Updated</span>
      <code class="x2mdx-ref-history-event-version">1.5.0</code>
    </div>

    <p class="x2mdx-ref-history-event-detail">AmuletNamespace: members added: isDevNet</p>

    <p class="x2mdx-ref-history-event-detail">AssetNamespace: details updated</p>

    <p class="x2mdx-ref-history-event-detail">ExtendedInitializedSDK: details updated</p>

    <p class="x2mdx-ref-history-event-detail">InitializedSDK: details updated</p>

    <p class="x2mdx-ref-history-event-detail">PreapprovalNamespace: members updated: command</p>

    <p class="x2mdx-ref-history-event-detail">PreparedTransaction: members updated: preparedPromise</p>

    <p class="x2mdx-ref-history-event-detail">SDKPlugin: type parameters added: ExtendedNamespaceItems; members updated: \_ctx, ctx</p>

    <p class="x2mdx-ref-history-event-detail">SignedTransaction: members updated: signedPromise</p>

    <p class="x2mdx-ref-history-event-detail">TokenNamespace: members added: assets, find</p>

    <p class="x2mdx-ref-history-event-detail">AmuletConfig: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">AssetConfig: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">AssetContext: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">BasicSDKInterface: details updated</p>

    <p class="x2mdx-ref-history-event-detail">ExtendedSDKInterface: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">PreparedCommand: details updated</p>

    <p class="x2mdx-ref-history-event-detail">PrepareOptions: details updated</p>

    <p class="x2mdx-ref-history-event-detail">RegisteredPlugins: signature updated; type parameters updated: P</p>

    <p class="x2mdx-ref-history-event-detail">TokenConfig: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">localNetStaticConfig: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">findAsset: call signatures updated</p>
  </div>

  <div class="x2mdx-ref-history-event x2mdx-ref-history-event--introduced" id="history-added-1-5-0">
    <div class="x2mdx-ref-history-event-head">
      <span class="x2mdx-ref-history-event-label">Added</span>
      <code class="x2mdx-ref-history-event-version">1.5.0</code>
    </div>

    <p class="x2mdx-ref-history-event-detail">4 exported symbols added.</p>
  </div>

  <div class="x2mdx-ref-history-event x2mdx-ref-history-event--changed" id="history-updated-1-4-0">
    <div class="x2mdx-ref-history-event-head">
      <span class="x2mdx-ref-history-event-label">Updated</span>
      <code class="x2mdx-ref-history-event-version">1.4.0</code>
    </div>

    <p class="x2mdx-ref-history-event-detail">AssetNamespace: details updated</p>

    <p class="x2mdx-ref-history-event-detail">ExtendedInitializedSDK: details updated</p>

    <p class="x2mdx-ref-history-event-detail">InitializedSDK: type parameters added: CurrentlyExtended</p>

    <p class="x2mdx-ref-history-event-detail">SDK: details updated</p>

    <p class="x2mdx-ref-history-event-detail">SDKPlugin: members added: \_ctx</p>

    <p class="x2mdx-ref-history-event-detail">AmuletConfig: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">AmuletNamespaceConfig: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">AssetBody: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">AssetConfig: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">BasicSDKInterface: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">BasicSDKOptions: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">Event: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">EventsConfig: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">ExtendedSDKInterface: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">GrantFeaturedAppRightsOptions: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">PreparedCommand: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">PrepareOptions: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">TokenConfig: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">TokenNamespaceConfig: signature updated</p>

    <p class="x2mdx-ref-history-event-detail">findAsset: call signatures updated</p>
  </div>

  <div class="x2mdx-ref-history-event x2mdx-ref-history-event--introduced" id="history-added-1-4-0">
    <div class="x2mdx-ref-history-event-head">
      <span class="x2mdx-ref-history-event-label">Added</span>
      <code class="x2mdx-ref-history-event-version">1.4.0</code>
    </div>

    <p class="x2mdx-ref-history-event-detail">9 exported symbols added.</p>
  </div>
</div>