Class KeyringSnapControllerClient

A KeyringClient that allows the communication with a snap through the SnapController.

Hierarchy

KeyringClient
- KeyringSnapControllerClient

Index

Constructors

Methods

approveRequest createAccount deleteAccount exportAccount filterAccountChains getAccount getAccountBalances getController getRequest listAccounts listRequests rejectRequest submitRequest updateAccount withSnapId

Constructors

constructor

new KeyringSnapControllerClient(args: { controller: SnapController; handler?: HandlerType; origin?: string; snapId?: SnapId }): KeyringSnapControllerClient
Create a new instance of KeyringSnapControllerClient.

The handlerType argument has a hard-coded default string value instead of a HandlerType value to prevent the @metamask/snaps-utils module from being required at runtime.
Parameters
- args: { controller: SnapController; handler?: HandlerType; origin?: string; snapId?: SnapId }
  
  Constructor arguments.
  - controller: SnapController
    
    The SnapController instance to use.
  - Optional handler?: HandlerType
    
    The handler type (default: 'onKeyringRequest').
  - Optional origin?: string
    
    The sender's origin (default: 'metamask').
  - Optional snapId?: SnapId
    
    The ID of the snap to use (default: 'undefined').
Returns KeyringSnapControllerClient
Overrides KeyringClient.constructor
- Defined in src/KeyringSnapControllerClient.ts:77

Methods

approveRequest

approveRequest(id: string, data?: Record<string, Json>): Promise<void>
Parameters
- id: string
- Optional data: Record<string, Json>
Returns Promise<void>
Inherited from KeyringClient.approveRequest
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:26

createAccount

createAccount(options?: Record<string, Json>): Promise<{ address: string; id: string; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }>
Parameters
- Optional options: Record<string, Json>
Returns Promise<{ address: string; id: string; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }>
Inherited from KeyringClient.createAccount
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:18

deleteAccount

deleteAccount(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
Inherited from KeyringClient.deleteAccount
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:21

exportAccount

exportAccount(id: string): Promise<Record<string, Json>>
Parameters
- id: string
Returns Promise<Record<string, Json>>
Inherited from KeyringClient.exportAccount
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:22

filterAccountChains

filterAccountChains(id: string, chains: string[]): Promise<string[]>
Parameters
- id: string
- chains: string[]
Returns Promise<string[]>
Inherited from KeyringClient.filterAccountChains
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:19

getAccount

getAccount(id: string): Promise<{ address: string; id: string; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }>
Parameters
- id: string
Returns Promise<{ address: string; id: string; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }>
Inherited from KeyringClient.getAccount
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:16

getAccountBalances

getAccountBalances(id: string, assets: string[]): Promise<Record<string, { amount: string; unit: string }>>
Parameters
- id: string
- assets: string[]
Returns Promise<Record<string, { amount: string; unit: string }>>
Inherited from KeyringClient.getAccountBalances
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:17

getController

getController(): SnapController
Get the SnapController instance used by this client.

Returns
The SnapController instance used by this client.

Returns SnapController
- Defined in src/KeyringSnapControllerClient.ts:112

getRequest

getRequest(id: string): Promise<{ account: string; id: string; request: { method: string; params?: Json[] | Record<string, Json> }; scope: string }>
Parameters
- id: string
Returns Promise<{ account: string; id: string; request: { method: string; params?: Json[] | Record<string, Json> }; scope: string }>
Inherited from KeyringClient.getRequest
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:24

listAccounts

listAccounts(): Promise<{ address: string; id: string; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }[]>
Returns Promise<{ address: string; id: string; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }[]>
Inherited from KeyringClient.listAccounts
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:15

listRequests

listRequests(): Promise<{ account: string; id: string; request: { method: string; params?: Json[] | Record<string, Json> }; scope: string }[]>
Returns Promise<{ account: string; id: string; request: { method: string; params?: Json[] | Record<string, Json> }; scope: string }[]>
Inherited from KeyringClient.listRequests
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:23

rejectRequest

rejectRequest(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
Inherited from KeyringClient.rejectRequest
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:27

submitRequest

submitRequest(request: { account: string; id: string; request: { method: string; params?: Json[] | Record<string, Json> }; scope: string }): Promise<{ pending: true; redirect?: { message?: string; url?: string } } | { pending: false; result: Json }>
Parameters
- request: { account: string; id: string; request: { method: string; params?: Json[] | Record<string, Json> }; scope: string }
  - account: string
  - id: string
  - request: { method: string; params?: Json[] | Record<string, Json> }
    - method: string
    - Optional params?: Json[] | Record<string, Json>
  - scope: string
Returns Promise<{ pending: true; redirect?: { message?: string; url?: string } } | { pending: false; result: Json }>
Inherited from KeyringClient.submitRequest
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:25

updateAccount

updateAccount(account: { address: string; id: string; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }): Promise<void>
Parameters
- account: { address: string; id: string; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }
  - address: string
  - id: string
  - methods: string[]
  - options: Record<string, Json>
  - type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh"
Returns Promise<void>
Inherited from KeyringClient.updateAccount
- Defined in node_modules/@metamask/keyring-api/dist/KeyringClient.d.ts:20

withSnapId

withSnapId(snapId: SnapId): KeyringSnapControllerClient
Create a new instance of KeyringSnapControllerClient with the specified snapId.

Returns
A new instance of KeyringSnapControllerClient with the specified snap ID.
Parameters
- snapId: SnapId
  
  The ID of the snap to use in the new instance.
Returns KeyringSnapControllerClient
- Defined in src/KeyringSnapControllerClient.ts:100

Class KeyringSnapControllerClient

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

args: { controller: SnapController; handler?: HandlerType; origin?: string; snapId?: SnapId }

controller: SnapController

Optional handler?: HandlerType

Optional origin?: string

Optional snapId?: SnapId

Returns KeyringSnapControllerClient

Methods

approveRequest

Parameters

id: string

Optional data: Record<string, Json>

Returns Promise<void>

createAccount

Parameters

Optional options: Record<string, Json>

Returns Promise<{ address: string; id: string; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }>

deleteAccount

Parameters

id: string

Returns Promise<void>

exportAccount

Parameters

id: string

Returns Promise<Record<string, Json>>

filterAccountChains

Parameters

id: string

chains: string[]

Returns Promise<string[]>

getAccount

Parameters

id: string

Returns Promise<{ address: string; id: string; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }>

getAccountBalances

Parameters

id: string

assets: string[]

Returns Promise<Record<string, { amount: string; unit: string }>>

getController

Returns

Returns SnapController

getRequest

Parameters

id: string

Returns Promise<{ account: string; id: string; request: { method: string; params?: Json[] | Record<string, Json> }; scope: string }>

listAccounts

Returns Promise<{ address: string; id: string; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }[]>

listRequests

Returns Promise<{ account: string; id: string; request: { method: string; params?: Json[] | Record<string, Json> }; scope: string }[]>

rejectRequest

Parameters

id: string

Returns Promise<void>

submitRequest

Parameters

request: { account: string; id: string; request: { method: string; params?: Json[] | Record<string, Json> }; scope: string }

account: string

id: string

request: { method: string; params?: Json[] | Record<string, Json> }

method: string

Optional params?: Json[] | Record<string, Json>

scope: string

Returns Promise<{ pending: true; redirect?: { message?: string; url?: string } } | { pending: false; result: Json }>

updateAccount

Parameters

account: { address: string; id: string; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }

address: string

id: string

methods: string[]

options: Record<string, Json>

type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh"

Returns Promise<void>

`Optional` handler?: HandlerType

`Optional` origin?: string

`Optional` snapId?: SnapId

`Optional` data: Record<string, Json>

`Optional` options: Record<string, Json>

`Optional` params?: Json[] | Record<string, Json>