@raydeck/metamask-ts v1.0.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
- AddEthereumChainParameter
- ConnectInfo
- ProviderMessage
- ProviderRpcError
- RequestedPermissions
- SwitchEthereumChainParameter
- WatchAssetParams
- Web3WalletPermission
Type aliases
Variables
Functions
- eth_accounts
- eth_chainId
- eth_decrypt
- eth_getEncryptionPublicKey
- eth_requestAccounts
- isConnected
- listen
- onAccountsChanged
- onChainChanged
- onConnect
- onDisconnect
- onMessage
- wallet_addEthereumChain
- wallet_getPermissions
- wallet_registerOnboardingCompleted
- wallet_requestPermissions
- wallet_scanQRCode
- wallet_switchEthereumChain
- wallet_watchAsset
Type aliases
MetamaskEvents
Ƭ MetamaskEvents: "accountsChanged"
| "chainChanged"
| "connect"
| "disconnect"
| "message"
Defined in
Variables
isEthereum
• isEthereum: true
Defined in
Functions
eth_accounts
▸ Const
eth_accounts(): Promise
<string
[]>
Returns
Promise
<string
[]>
Defined in
eth_chainId
▸ Const
eth_chainId(): Promise
<string
>
Returns
Promise
<string
>
Defined in
eth_decrypt
▸ Const
eth_decrypt(message
, accountId?
): Promise
<string
>
Parameters
Name | Type |
---|---|
message | string |
accountId? | string |
Returns
Promise
<string
>
Defined in
eth_getEncryptionPublicKey
▸ Const
eth_getEncryptionPublicKey(accountId
): Promise
<string
>
Parameters
Name | Type |
---|---|
accountId | string |
Returns
Promise
<string
>
Defined in
eth_requestAccounts
▸ Const
eth_requestAccounts(): Promise
<string
[]>
Returns
Promise
<string
[]>
Defined in
isConnected
▸ Const
isConnected(): boolean
Returns
boolean
Defined in
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
onAccountsChanged
▸ Const
onAccountsChanged(handler
): () => void
Parameters
Name | Type |
---|---|
handler | (accounts : string []) => void |
Returns
fn
▸ (): void
Returns
void
Defined in
onChainChanged
▸ Const
onChainChanged(handler
): () => void
Parameters
Name | Type |
---|---|
handler | (chain : string ) => void |
Returns
fn
▸ (): void
Returns
void
Defined in
onConnect
▸ Const
onConnect(handler
): () => void
Parameters
Name | Type |
---|---|
handler | (connectInfo : ConnectInfo ) => void |
Returns
fn
▸ (): void
Returns
void
Defined in
onDisconnect
▸ Const
onDisconnect(handler
): () => void
Parameters
Name | Type |
---|---|
handler | (error : ProviderRpcError ) => void |
Returns
fn
▸ (): void
Returns
void
Defined in
onMessage
▸ Const
onMessage(handler
): () => void
Parameters
Name | Type |
---|---|
handler | (message : ProviderMessage ) => void |
Returns
fn
▸ (): void
Returns
void
Defined in
wallet_addEthereumChain
▸ Const
wallet_addEthereumChain(chainParameter
): Promise
<null
>
Parameters
Name | Type |
---|---|
chainParameter | AddEthereumChainParameter |
Returns
Promise
<null
>
Defined in
wallet_getPermissions
▸ Const
wallet_getPermissions(): Promise
<Web3WalletPermission
[]>
Returns
Promise
<Web3WalletPermission
[]>
Defined in
wallet_registerOnboardingCompleted
▸ Const
wallet_registerOnboardingCompleted(): Promise
<boolean
>
Returns
Promise
<boolean
>
Defined in
wallet_requestPermissions
▸ Const
wallet_requestPermissions(permissions
): Promise
<Web3WalletPermission
[]>
Parameters
Name | Type |
---|---|
permissions | RequestedPermissions |
Returns
Promise
<Web3WalletPermission
[]>
Defined in
wallet_scanQRCode
▸ Const
wallet_scanQRCode(regex?
): Promise
<string
>
Parameters
Name | Type |
---|---|
regex? | string |
Returns
Promise
<string
>
Defined in
wallet_switchEthereumChain
▸ Const
wallet_switchEthereumChain(chainId
): Promise
<null
>
Parameters
Name | Type |
---|---|
chainId | string |
Returns
Promise
<null
>
Defined in
wallet_watchAsset
▸ Const
wallet_watchAsset(params
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
params | WatchAssetParams |
Returns
Promise
<boolean
>
Defined in
@raydeck/metamask-ts - v1.0.2 / AddEthereumChainParameter
Interface: AddEthereumChainParameter
Table of contents
Properties
Properties
blockExplorerUrls
• Optional
blockExplorerUrls: string
[]
Defined in
chainId
• chainId: string
Defined in
chainName
• chainName: string
Defined in
iconUrls
• Optional
iconUrls: string
[]
Defined in
nativeCurrency
• nativeCurrency: Object
Type declaration
Name | Type |
---|---|
decimals | 18 |
name | string |
symbol | string |
Defined in
rpcUrls
• rpcUrls: string
[]
Defined in
@raydeck/metamask-ts - v1.0.2 / ConnectInfo
Interface: ConnectInfo
Table of contents
Properties
Properties
chainId
• chainId: string
Defined in
@raydeck/metamask-ts - v1.0.2 / ProviderMessage
Interface: ProviderMessage
Table of contents
Properties
Properties
data
• data: unknown
Defined in
type
• type: string
Defined in
@raydeck/metamask-ts - v1.0.2 / ProviderRpcError
Interface: ProviderRpcError
Hierarchy
Error
↳
ProviderRpcError
Table of contents
Properties
Properties
code
• code: number
Defined in
data
• Optional
data: unknown
Defined in
message
• message: string
Overrides
Error.message
Defined in
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
@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
type
• type: "ERC20"
Defined in
@raydeck/metamask-ts - v1.0.2 / Web3WalletPermission
Interface: Web3WalletPermission
Table of contents
Properties
Properties
date
• Optional
date: number
Defined in
parentCapability
• parentCapability: string