> ## Documentation Index
> Fetch the complete documentation index at: https://cantonfoundation-external-snippet-helper-copy.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# @canton-network/wallet-sdk

> TypeScript client library reference for wallet integrations.

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

## Table of Contents

| Name                                                                               | Kind       | Summary                                          | Introduced | Changed | Deprecated | Removed |
| ---------------------------------------------------------------------------------- | ---------- | ------------------------------------------------ | ---------- | ------- | ---------- | ------- |
| [`AmuletNamespace`](#class-amuletnamespace)                                        | Class      | -                                                | `1.3.1`    | -       | -          | -       |
| [`AssetNamespace`](#class-assetnamespace)                                          | Class      | -                                                | `1.3.1`    | -       | -          | -       |
| [`ExtendedInitializedSDK`](#class-extendedinitializedsdk)                          | Class      | -                                                | `1.3.1`    | -       | -          | -       |
| [`InitializedSDK`](#class-initializedsdk)                                          | Class      | -                                                | `1.3.1`    | -       | -          | -       |
| [`LedgerProvider`](#class-ledgerprovider)                                          | Class      | -                                                | `1.3.1`    | -       | -          | -       |
| [`OfflineInitializedSDK`](#class-offlineinitializedsdk)                            | Class      | -                                                | `1.3.1`    | -       | -          | -       |
| [`PreapprovalNamespace`](#class-preapprovalnamespace)                              | Class      | -                                                | `1.3.1`    | -       | -          | -       |
| [`PreparedTransaction`](#class-preparedtransaction)                                | Class      | -                                                | `1.3.1`    | -       | -          | -       |
| [`SDK`](#class-sdk)                                                                | Class      | -                                                | `1.3.1`    | -       | -          | -       |
| [`SDKPlugin`](#class-sdkplugin)                                                    | Class      | -                                                | `1.3.1`    | -       | -          | -       |
| [`SignedTransaction`](#class-signedtransaction)                                    | Class      | -                                                | `1.3.1`    | -       | -          | -       |
| [`TokenNamespace`](#class-tokennamespace)                                          | Class      | -                                                | `1.3.1`    | -       | -          | -       |
| [`FeaturedAppService`](#interface-featuredappservice)                              | Interface  | -                                                | `1.3.1`    | -       | -          | -       |
| [`AmuletConfig`](#type-alias-amuletconfig)                                         | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`AmuletNamespaceConfig`](#type-alias-amuletnamespaceconfig)                       | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`AssetBody`](#type-alias-assetbody)                                               | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`AssetConfig`](#type-alias-assetconfig)                                           | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`AssetContext`](#type-alias-assetcontext)                                         | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`BasicSDKInterface`](#type-alias-basicsdkinterface)                               | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`BasicSDKOptions`](#type-alias-basicsdkoptions)                                   | Type Alias | Options for configuring the Wallet SDK instance. | `1.3.1`    | -       | -          | -       |
| [`Event`](#type-alias-event)                                                       | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`EventsConfig`](#type-alias-eventsconfig)                                         | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`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`    | -       | -          | -       |
| [`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`    | -       | -          | -       |
| [`LedgerTypes`](#type-alias-ledgertypes)                                           | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`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`    | -       | -          | -       |
| [`PreapprovalParties`](#type-alias-preapprovalparties)                             | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`PreparedCommand`](#type-alias-preparedcommand)                                   | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`PrepareOptions`](#type-alias-prepareoptions)                                     | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`RegisteredPlugins`](#type-alias-registeredplugins)                               | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`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`    | -       | -          | -       |
| [`TokenConfig`](#type-alias-tokenconfig)                                           | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`TokenNamespaceConfig`](#type-alias-tokennamespaceconfig)                         | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`TokenProviderConfig`](#type-alias-tokenproviderconfig)                           | Type Alias | -                                                | `1.3.1`    | -       | -          | -       |
| [`EXTENDED_SDK_OPTION_KEYS`](#variable-extended-sdk-option-keys)                   | Variable   | -                                                | `1.3.1`    | -       | -          | -       |
| [`localNetStaticConfig`](#variable-localnetstaticconfig)                           | Variable   | -                                                | `1.3.1`    | -       | -          | -       |
| [`fetchAmulet`](#function-fetchamulet)                                             | Function   | -                                                | `1.3.1`    | -       | -          | -       |
| [`findAsset`](#function-findasset)                                                 | Function   | -                                                | `1.3.1`    | -       | -          | -       |
| [`getPublicKeyFromPrivate`](#function-getpublickeyfromprivate)                     | Function   | -                                                | `1.3.1`    | -       | -          | -       |
| [`signTransactionHash`](#function-signtransactionhash)                             | Function   | -                                                | `1.3.1`    | -       | -          | -       |

## Version Change Summary

| Version | Added | Changed | Removed |
| ------- | ----- | ------- | ------- |
| `1.3.1` | `50`  | -       | -       |

## Reference

### Classes

<span id="class-amuletnamespace" />

#### AmuletNamespace

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

**Members**

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

<span id="class-assetnamespace" />

#### AssetNamespace

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

**Members**

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

<span id="class-extendedinitializedsdk" />

#### ExtendedInitializedSDK

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

**Type Parameters**

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

**Members**

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

<span id="class-initializedsdk" />

#### InitializedSDK

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

**Members**

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

<span id="class-ledgerprovider" />

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

<span id="class-offlineinitializedsdk" />

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

<span id="class-preapprovalnamespace" />

#### PreapprovalNamespace

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

**Members**

| Member        | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Description                                                                                                                                                                                                                         |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `constructor` | `void`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | -                                                                                                                                                                                                                                   |
| `command`     | `{ cancel: (args: { parties: PreapprovalParties }) =&gt; Promise&lt;[{ ExerciseCommand: { choice: string; choiceArgument: unknown; contractId: string; templateId: string } &amp; { choice: string; choiceArgument: unknown; contractId: string; templateId: string } }, { contractId?: string; createdEventBlob: string; synchronizerId?: string; templateId?: string } &amp; { contractId?: string; createdEventBlob: string; synchronizerId?: string; templateId?: string }[]] \| readonly [null, readonly []]&gt;; create: (args: { parties: PreapprovalParties }) =&gt; Promise&lt;{ CreateCommand: { createArguments: unknown; templateId: string } &amp; { createArguments: unknown; templateId: string } }&gt; }` | 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

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

**Members**

| Member            | Type                                                                                                                                                                                                                                                                                                                                                                                                                            | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `constructor`     | `void`                                                                                                                                                                                                                                                                                                                                                                                                                          | -           |
| `preparedPromise` | `Promise&lt;{ 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 }&gt;` | -           |
| `decode`          | `void`                                                                                                                                                                                                                                                                                                                                                                                                                          | -           |
| `sign`            | `void`                                                                                                                                                                                                                                                                                                                                                                                                                          | -           |
| `toJSON`          | `void`                                                                                                                                                                                                                                                                                                                                                                                                                          | -           |

<span id="class-sdk" />

#### SDK

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

**Members**

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

<span id="class-sdkplugin" />

#### SDKPlugin

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

**Members**

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

<span id="class-signedtransaction" />

#### SignedTransaction

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

**Members**

| Member          | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Description |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `constructor`   | `void`                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -           |
| `signedPromise` | `Promise&lt;{ 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 }&gt;` | -           |
| `execute`       | `void`                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -           |
| `response`      | `void`                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -           |
| `signature`     | `void`                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -           |

<span id="class-tokennamespace" />

#### TokenNamespace

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

**Members**

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

### Interfaces

<span id="interface-featuredappservice" />

#### FeaturedAppService

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

**Signature**

```ts theme={null}
interface FeaturedAppService
```

**Members**

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

### Type Aliases

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

#### AmuletConfig

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

**Signature**

```ts theme={null}
type AmuletConfig = { auth: TokenProviderConfig; registryUrl: URL; scanApiUrl: string | URL; validatorUrl: string | URL }
```

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

#### AmuletNamespaceConfig

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

**Signature**

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

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

#### AssetBody

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

**Signature**

```ts theme={null}
type AssetBody = { admin: PartyId; displayName: string; id: string; registryUrl: string; symbol: string }
```

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

#### AssetConfig

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

**Signature**

```ts theme={null}
type AssetConfig = { auth: TokenProviderConfig; registries: URL[] }
```

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

#### AssetContext

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

**Signature**

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

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

#### BasicSDKInterface

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

**Signature**

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

**Type Parameters**

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

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

#### BasicSDKOptions

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

**Signature**

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

Options for configuring the Wallet SDK instance.

**Type Parameters**

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

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

#### Event

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

**Signature**

```ts theme={null}
type Event = LedgerCommonSchemas["JsGetUpdatesResponse"]
```

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

#### EventsConfig

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

**Signature**

```ts theme={null}
type EventsConfig = { auth: TokenProviderConfig; websocketURL: string }
```

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

#### 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 }
```

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

#### ExtendedFullSDKInterface

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

**Signature**

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

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

#### ExtendedSDKInterface

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

**Signature**

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

**Type Parameters**

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

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

#### ExtendedSDKOptions

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

**Signature**

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

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

#### 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<string, never>; template_id: string }
```

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

#### GetExtendedKeys

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

**Signature**

```ts theme={null}
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

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

**Signature**

```ts theme={null}
type GrantFeaturedAppRightsOptions = { delayMs?: number; maxRetries?: number; synchronizerId?: string }
```

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

#### LedgerTypes

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

**Signature**

```ts theme={null}
type LedgerTypes = LedgerCommonSchemas
```

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

#### 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 }
```

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

#### NullableExtendedFullSDKInterface

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

**Signature**

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

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

#### OfflineSDKContext

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

**Signature**

```ts theme={null}
type OfflineSDKContext = { error: SDKErrorHandler; logger: SDKLogger }
```

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

#### OfflineSDKInterface

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

**Signature**

```ts theme={null}
type OfflineSDKInterface = Readonly<{ keys: KeysNamespace; utils: SDKUtilsNamespace }>
```

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

#### 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 }
```

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

#### PreparedCommand

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

**Signature**

```ts theme={null}
type PreparedCommand<K extends keyof RawCommandMap | keyof RawCommandMap[] = ["ExerciseCommand", "CreateCommand"]> = [K extends keyof RawCommandMap[] ? WrappedCommand<K[number]> : K extends keyof RawCommandMap ? WrappedCommand<K> : never, LedgerTypes["DisclosedContract"][]]
```

**Type Parameters**

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

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

#### PrepareOptions

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

**Signature**

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

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

#### RegisteredPlugins

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

**Signature**

```ts theme={null}
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&lt;string, (ctx: SDKContext) =&gt; SDKPlugin&gt;` | `Record&lt;string, (ctx: SDKContext) =&gt; SDKPlugin&gt;` | -           |

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

#### SDKContext

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

**Signature**

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

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

#### SDKInterface

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

**Signature**

```ts theme={null}
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

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

**Signature**

```ts theme={null}
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-tokenconfig" />

#### TokenConfig

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

**Signature**

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

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

#### TokenNamespaceConfig

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

**Signature**

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

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

#### 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" }
```

### Variables

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

#### EXTENDED\_SDK\_OPTION\_KEYS

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

**Signature**

```ts theme={null}
const EXTENDED_SDK_OPTION_KEYS: readonly ["amulet", "token", "asset", "events"]
```

<span id="variable-localnetstaticconfig" />

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

<span id="function-fetchamulet" />

#### fetchAmulet

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

**Signature**

```ts theme={null}
fetchAmulet(amuletCtx: AmuletNamespaceConfig): Promise<AssetBody>
```

**Call Signatures**

```ts theme={null}
fetchAmulet(amuletCtx: AmuletNamespaceConfig): Promise<AssetBody>
```

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

Returns: `Promise<AssetBody>`

<span id="function-findasset" />

#### findAsset

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

**Signature**

```ts theme={null}
findAsset(assets: AssetBody[], id: string, error: SDKErrorHandler, registryUrl?: string | URL): AssetBody
```

**Call Signatures**

```ts theme={null}
findAsset(assets: AssetBody[], id: string, error: SDKErrorHandler, registryUrl?: string | URL): AssetBody
```

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

Returns: `AssetBody`

<span id="function-getpublickeyfromprivate" />

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

<span id="function-signtransactionhash" />

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