npm.io
1.0.2 • Published 4 years agoCLI

@raydeck/metamask-ts

Licence
MIT
Version
1.0.2
Deps
2
Size
31 kB
Vulns
0
Weekly
0
Stars
2

metamask-ts

Library to make it easy to work with metamask in typescript

@raydeck/metamask-ts - v1.0.2

@raydeck/metamask-ts - v1.0.2

Table of contents

Interfaces

Type aliases
Variables
Functions

Type aliases

MetamaskEvents

Ƭ MetamaskEvents: "accountsChanged" | "chainChanged" | "connect" | "disconnect" | "message"

Defined in

src/index.ts:117

Variables

isEthereum

• isEthereum: true

Defined in

src/index.ts:163

Functions

eth_accounts

▸ Const eth_accounts(): Promise<string[]>

Returns

Promise<string[]>

Defined in

src/index.ts:168


eth_chainId

▸ Const eth_chainId(): Promise<string>

Returns

Promise<string>

Defined in

src/index.ts:93


eth_decrypt

▸ Const eth_decrypt(message, accountId?): Promise<string>

Parameters
Name Type
message string
accountId? string
Returns

Promise<string>

Defined in

src/index.ts:28


eth_getEncryptionPublicKey

▸ Const eth_getEncryptionPublicKey(accountId): Promise<string>

Parameters
Name Type
accountId string
Returns

Promise<string>

Defined in

src/index.ts:39


eth_requestAccounts

▸ Const eth_requestAccounts(): Promise<string[]>

Returns

Promise<string[]>

Defined in

src/index.ts:34


isConnected

▸ Const isConnected(): boolean

Returns

boolean

Defined in

src/index.ts:165


listen

▸ Const listen<T>(event, handler): () => void

Type parameters
Name
T
Parameters
Name Type
event MetamaskEvents
handler (args: T) => void
Returns

fn

▸ (): void

Returns

void

Defined in

src/index.ts:123


onAccountsChanged

▸ Const onAccountsChanged(handler): () => void

Parameters
Name Type
handler (accounts: string[]) => void
Returns

fn

▸ (): void

Returns

void

Defined in

src/index.ts:135


onChainChanged

▸ Const onChainChanged(handler): () => void

Parameters
Name Type
handler (chain: string) => void
Returns

fn

▸ (): void

Returns

void

Defined in

src/index.ts:138


onConnect

▸ Const onConnect(handler): () => void

Parameters
Name Type
handler (connectInfo: ConnectInfo) => void
Returns

fn

▸ (): void

Returns

void

Defined in

src/index.ts:144


onDisconnect

▸ Const onDisconnect(handler): () => void

Parameters
Name Type
handler (error: ProviderRpcError) => void
Returns

fn

▸ (): void

Returns

void

Defined in

src/index.ts:147


onMessage

▸ Const onMessage(handler): () => void

Parameters
Name Type
handler (message: ProviderMessage) => void
Returns

fn

▸ (): void

Returns

void

Defined in

src/index.ts:154


wallet_addEthereumChain

▸ Const wallet_addEthereumChain(chainParameter): Promise<null>

Parameters
Name Type
chainParameter AddEthereumChainParameter
Returns

Promise<null>

Defined in

src/index.ts:70


wallet_getPermissions

▸ Const wallet_getPermissions(): Promise<Web3WalletPermission[]>

Returns

Promise<Web3WalletPermission[]>

Defined in

src/index.ts:45


wallet_registerOnboardingCompleted

▸ Const wallet_registerOnboardingCompleted(): Promise<boolean>

Returns

Promise<boolean>

Defined in

src/index.ts:87


wallet_requestPermissions

▸ Const wallet_requestPermissions(permissions): Promise<Web3WalletPermission[]>

Parameters
Name Type
permissions RequestedPermissions
Returns

Promise<Web3WalletPermission[]>

Defined in

src/index.ts:50


wallet_scanQRCode

▸ Const wallet_scanQRCode(regex?): Promise<string>

Parameters
Name Type
regex? string
Returns

Promise<string>

Defined in

src/index.ts:111


wallet_switchEthereumChain

▸ Const wallet_switchEthereumChain(chainId): Promise<null>

Parameters
Name Type
chainId string
Returns

Promise<null>

Defined in

src/index.ts:81


wallet_watchAsset

▸ Const wallet_watchAsset(params): Promise<boolean>

Parameters
Name Type
params WatchAssetParams
Returns

Promise<boolean>

Defined in

src/index.ts:105

@raydeck/metamask-ts - v1.0.2 / AddEthereumChainParameter

Interface: AddEthereumChainParameter

Table of contents

Properties

Properties

blockExplorerUrls

• Optional blockExplorerUrls: string[]

Defined in

src/index.ts:67


chainId

• chainId: string

Defined in

src/index.ts:59


chainName

• chainName: string

Defined in

src/index.ts:60


iconUrls

• Optional iconUrls: string[]

Defined in

src/index.ts:68


nativeCurrency

• nativeCurrency: Object

Type declaration
Name Type
decimals 18
name string
symbol string
Defined in

src/index.ts:61


rpcUrls

• rpcUrls: string[]

Defined in

src/index.ts:66

@raydeck/metamask-ts - v1.0.2 / ConnectInfo

Interface: ConnectInfo

Table of contents

Properties

Properties

chainId

• chainId: string

Defined in

src/index.ts:142

@raydeck/metamask-ts - v1.0.2 / ProviderMessage

Interface: ProviderMessage

Table of contents

Properties

Properties

data

• data: unknown

Defined in

src/index.ts:152


type

• type: string

Defined in

src/index.ts:151

@raydeck/metamask-ts - v1.0.2 / ProviderRpcError

Interface: ProviderRpcError

Hierarchy

  • Error

    ↳ ProviderRpcError

Table of contents

Properties

Properties

code

• code: number

Defined in

src/index.ts:159


data

• Optional data: unknown

Defined in

src/index.ts:160


message

• message: string

Overrides

Error.message

Defined in

src/index.ts:158


name

• name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:973


stack

• Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:975

@raydeck/metamask-ts - v1.0.2 / RequestedPermissions

Interface: RequestedPermissions

Indexable

[methodName: string]: {}

@raydeck/metamask-ts - v1.0.2 / SwitchEthereumChainParameter

Interface: SwitchEthereumChainParameter

Table of contents

Properties

Properties

chainId

• chainId: string

Defined in

src/index.ts:79

@raydeck/metamask-ts - v1.0.2 / WatchAssetParams

Interface: WatchAssetParams

Table of contents

Properties

Properties

options

• options: Object

Type declaration
Name Type
address string
decimals number
image string
symbol string
Defined in

src/index.ts:98


type

• type: "ERC20"

Defined in

src/index.ts:97

@raydeck/metamask-ts - v1.0.2 / Web3WalletPermission

Interface: Web3WalletPermission

Table of contents

Properties

Properties

date

• Optional date: number

Defined in

src/index.ts:21


parentCapability

• parentCapability: string

Defined in

src/index.ts:18