@earthwallet/sdk

Index

Classes

Type aliases

Variables

Object literals

SLIP44

Type aliases

EarthKeyringPair$Meta

EarthKeyringPair$Meta: Record<string, unknown>

EncryptedJsonEncoding

EncryptedJsonEncoding: "none" | "scrypt" | "xsalsa20-poly1305"

EncryptedJsonVersion

EncryptedJsonVersion: "0" | "1" | "2" | "3"

If you import a dependency which does not include its own type definitions, TypeScript will try to find a definition for it by following the typeRoots compiler option in tsconfig.json. For this project, we've configured it to fall back to this folder if nothing is found in node_modules/@types.

Often, you can install the DefinitelyTyped (https://github.com/DefinitelyTyped/DefinitelyTyped) type definition for the dependency in question. However, if no one has yet contributed definitions for the package, you may want to declare your own. (If you're using the noImplicitAny compiler options, you'll be required to declare it.)

This is an example type definition which allows import from module-name, e.g.:

import something from 'module-name';
something();

InjectOptions

InjectOptions: InjectedExtensionInfo

InjectedExtension

InjectedExtension: InjectedExtensionInfo & Injected

JsonableSecp256k1Identity

JsonableSecp256k1Identity: [PublicKeyHex, SecretKeyHex]

JsonnableEd25519KeyIdentity

JsonnableEd25519KeyIdentity: [string, string]

KeypairType

KeypairType: "ed25519" | "sr25519" | "ecdsa" | "ethereum"

ProviderList

ProviderList: Record<string, ProviderMeta>

PublicKeyHex

PublicKeyHex: string

SecretKeyHex

SecretKeyHex: string

This

This: typeof globalThis

Unsubcall

Unsubcall: () => void

Type declaration

- (): void
- Returns void

Variables

Const ACCOUNT_DOMAIN_SEPERATOR

ACCOUNT_DOMAIN_SEPERATOR: Buffer = Buffer.from('\x0Aaccount-id')

Const SUB_ACCOUNT_ZERO

SUB_ACCOUNT_ZERO: Buffer = Buffer.alloc(32)

Const extension

extension: chrome | browser = typeof chrome !== 'undefined'? chrome: typeof browser !== 'undefined'? browser: null

Let isWeb3Injected

isWeb3Injected: boolean = web3IsInjected()

Let web3EnablePromise

web3EnablePromise: Promise<InjectedExtension[]> | null = null

Const win

win: Window & InjectedWindow = window as Window & InjectedWindow

Functions

Const createWallet

createWallet(mnemonic: string, symbol: string, account?: number): Promise<EarthKeyringPair>

Creates a wallet from mnemonic and symbol with optional account index.

Example (es module)

const walletObj = await createWallet(
'open jelly jeans corn ketchup supreme brief element armed lens vault weather original scissors rug priority vicious lesson raven spot gossip powder person volcano',
'ICP'
);
// => {
publicKey:
'0x7806e3f1de6b8690b8eb57fded933c66f059993ba1d675f49ba3f94fac1f8425',
address: 'FHhJyt9RgGin3yfYgdzaAu9MXBodkAuULpao6rGcEyHTscN',
type: 'sr25519',
}

Example (commonjs)

const walletObj = await createWallet(
'open jelly jeans corn ketchup supreme brief element armed lens vault weather original scissors rug priority vicious lesson raven spot gossip powder person volcano',
'ICP'
);
// => {
publicKey:
'0x7806e3f1de6b8690b8eb57fded933c66f059993ba1d675f49ba3f94fac1f8425',
address: 'FHhJyt9RgGin3yfYgdzaAu9MXBodkAuULpao6rGcEyHTscN',
type: 'sr25519',
}

anothernote: Some other value.

Parameters

mnemonic: string

Comment describing the value parameter.
symbol: string

Comment describing the value parameter.
Optional account: number

Comment describing the value parameter.

Returns Promise<EarthKeyringPair>

Comment describing the return type.

documentReadyPromise

documentReadyPromise<T>(creator: () => Promise<T>): Promise<T>

- Defined in src/dapp/util.ts:4
Type parameters
- T
Parameters
- creator: () => Promise<T>
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>

Const getBalance

getBalance(address: any): Promise<{ value: number; currency: object }>
getBalance(address: string, symbol: string): Promise<EarthBalance>

- Defined in src/util/icp/index.ts:14
Parameters
- address: any
Returns Promise<{ value: number; currency: object }>
- Defined in src/util/index.ts:25
Parameters
- address: string
- symbol: string
Returns Promise<EarthBalance>

Const getPublicKeySecp256k1

getPublicKeySecp256k1(privateKey: any, compress: any): string

- Defined in src/lib/wallet.ts:35
Parameters
- privateKey: any
- compress: any
Returns string

Const getSlipFromSymbol

getSlipFromSymbol(symbol: string): { hex: string; index: string; name: string; symbol: string } | { index: number }

Get slip44 object for a symbol

Example (es module)

import { getSlipFromSymbol } from '@earthwallet/keyring'
getSlipFromSymbol("ICP");
// => {
index: '223',
hex: '0x800000df',
symbol: 'ICP',
name: 'Internet Computer (DFINITY)',
link: 'https://dfinity.org/',
}

Parameters

symbol: string

Returns { hex: string; index: string; name: string; symbol: string } | { index: number }

slipObject

Const getSubAccountArray

getSubAccountArray(s: any): any[]

- Defined in src/util/icp/index.ts:124
Parameters
- s: any
Returns any[]

Const getTransactions

getTransactions(address: any): Promise<{}>
getTransactions(address: any, symbol: any): Promise<{}>

- Defined in src/util/icp/index.ts:53
Parameters
- address: any
Returns Promise<{}>
- Defined in src/util/index.ts:91
Parameters
- address: any
- symbol: any
Returns Promise<{}>

getWindowExtensions

getWindowExtensions(originName: string): Promise<[InjectedExtensionInfo, Injected | void][]>

- Defined in src/dapp/index.ts:59
Parameters
- originName: string
Returns Promise<[InjectedExtensionInfo, Injected | void][]>

Const indexToHash

indexToHash(index: any): Promise<void>

- Defined in src/util/icp/index.ts:184
Parameters
- index: any
Returns Promise<void>

Const init

init(__namedParameters: { IDL: any }): any[]

- Defined in src/util/ledger.ts:59
Parameters
- __namedParameters: { IDL: any }
  - IDL: any
Returns any[]

initCompat

initCompat(): Promise<boolean>

- Defined in src/dapp/compat/index.ts:7
Returns Promise<boolean>

initSingleSource

initSingleSource(): Promise<boolean>

- Defined in src/dapp/compat/singleSource.ts:79
Returns Promise<boolean>

injectExtension

injectExtension(enable: (origin: string) => Promise<Injected>, __namedParameters: { name: string; version: string }): void

- Defined in src/inject/index.ts:9
Parameters
- enable: (origin: string) => Promise<Injected>
  - - (origin: string): Promise<Injected>
    - Parameters
      - origin: string
      Returns Promise<Injected>
- __namedParameters: { name: string; version: string }
  - name: string
  - version: string
Returns void

injectSingleSource

injectSingleSource(win: SingleWindow): void

- Defined in src/dapp/compat/singleSource.ts:43
Parameters
- win: SingleWindow
Returns void

mapAccounts

mapAccounts(source: string, list: InjectedAccount[], symbol?: string): InjectedAccountWithMeta[]

- Defined in src/dapp/index.ts:38
Parameters
- source: string
- list: InjectedAccount[]
- Optional symbol: string
Returns InjectedAccountWithMeta[]

Const newMnemonic

newMnemonic(): Promise<string | false>

Generate a new random Mnemonic

Example (es module)

import { newMnemonic } from '@earthwallet/keyring'
await newMnemonic();
// => open jelly jeans corn ketchup supreme brief element armed lens vault weather original scissors rug priority vicious lesson raven spot gossip powder person volcano

Returns Promise<string | false>

mnemonic.

Const principal_id_to_address

principal_id_to_address(pid: any): any

- Defined in src/util/icp/index.ts:180
Parameters
- pid: any
Returns any

Const send

send(identity: any, to_aid: any, from_sub: any, amount: any, symbol: any): Promise<any>

- Defined in src/util/index.ts:17
Parameters
- identity: any
- to_aid: any
- from_sub: any
- amount: any
- symbol: any
Returns Promise<any>

Const sendICP

sendICP(identity: any, to_aid: any, from_sub: any, amount: any): Promise<unknown>

- Defined in src/util/icp/index.ts:135
Parameters
- identity: any
- to_aid: any
- from_sub: any
- amount: any
Returns Promise<unknown>

Const sendTransaction

sendTransaction(src_private_key: any, dest_addr: any, amount: any): Promise<any>

- Defined in src/util/icp/index.ts:100
Parameters
- src_private_key: any
  
  hex of derived child private key of character length 64 and buffer size 32 bytes
- dest_addr: any
  
  e.g 07b1b5f1f023eaa457a6d63fe00cea8cae5c943461350de455cb2d1f3dec8992
- amount: any
  
  Specifies the number of ICP tokens to transfer. Can be specified as a number with up to eight (8) decimal places.
Returns Promise<any>

throwError

throwError(method: string): never

- Defined in src/dapp/index.ts:31
Parameters
- method: string
Returns never

Const to32bits

to32bits(num: any): number[]

- Defined in src/util/icp/index.ts:129
Parameters
- num: any
Returns number[]

transformAccounts

transformAccounts(accounts: SingleSourceAccount[]): InjectedAccount[]

- Defined in src/dapp/compat/singleSource.ts:33
Parameters
- accounts: SingleSourceAccount[]
Returns InjectedAccount[]

Const utf8ToBytes

utf8ToBytes(str: string): Uint8Array

- Defined in src/util/icp/index.ts:163
Parameters
- str: string
Returns Uint8Array

Const validateMnemonic

validateMnemonic(mnemonic: string, wordlist?: string[]): boolean

Validate Mnemonic

Example (es module)

import { validateMnemonic } from '@earthwallet/keyring'
validateMnemonic('open jelly jeans corn ketchup supreme brief element armed lens vault weather original scissors rug priority vicious lesson raven spot gossip powder person volcano');
// => true

Parameters

mnemonic: string
Optional wordlist: string[]

Returns boolean

boolean.

web3Accounts

web3Accounts(__namedParameters?: { symbol: string }): Promise<InjectedAccountWithMeta[]>

- Defined in src/dapp/index.ts:131
Parameters
- Default value __namedParameters: { symbol: string } = {}
  - symbol: string
Returns Promise<InjectedAccountWithMeta[]>

web3AccountsSubscribe

web3AccountsSubscribe(cb: (accounts: InjectedAccountWithMeta[]) => void | Promise<void>, __namedParameters?: { symbol: string }): Promise<Unsubcall>

- Defined in src/dapp/index.ts:173
Parameters
- cb: (accounts: InjectedAccountWithMeta[]) => void | Promise<void>
  - - (accounts: InjectedAccountWithMeta[]): void | Promise<void>
    - Parameters
      - accounts: InjectedAccountWithMeta[]
      Returns void | Promise<void>
- Default value __namedParameters: { symbol: string } = {}
  - symbol: string
Returns Promise<Unsubcall>

web3Enable

web3Enable(originName: string): Promise<InjectedExtension[]>

- Defined in src/dapp/index.ts:78
Parameters
- originName: string
Returns Promise<InjectedExtension[]>

web3FromAddress

web3FromAddress(address: string): Promise<InjectedExtension>

- Defined in src/dapp/index.ts:234
Parameters
- address: string
Returns Promise<InjectedExtension>

web3FromSource

web3FromSource(source: string): Promise<InjectedExtension>

- Defined in src/dapp/index.ts:216
Parameters
- source: string
Returns Promise<InjectedExtension>

web3IsInjected

web3IsInjected(): boolean

- Defined in src/dapp/index.ts:26
Returns boolean

web3ListRpcProviders

web3ListRpcProviders(source: string): Promise<ProviderList | null>

- Defined in src/dapp/index.ts:256
Parameters
- source: string
Returns Promise<ProviderList | null>

web3UseRpcProvider

web3UseRpcProvider(source: string, key: string): Promise<InjectedProviderWithMeta>

- Defined in src/dapp/index.ts:271
Parameters
- source: string
- key: string
Returns Promise<InjectedProviderWithMeta>

Object literals

Const SLIP44

SLIP44: object

0

0: object

hex

hex: string = "0x80000000"

index

index: string = "0"

link

link: string = "https://bitcoin.org/"

link

link: string = "https://wavesplatform.com/"

name

symbol

symbol: string = "WAVES"

575

575: object

hex

hex: string = "0x8000023f"

index

index: string = "575"

name

symbol

link

link: string = "https://peercoin.net/"

name

symbol

symbol: string = "PPC"

60

60: object

hex

hex: string = "0x8000003c"

index

index: string = "60"

link

link: string = "https://ethereum.org/ether"

name

symbol

link

link: string = "https://aquachain.github.io/"

name

symbol

hex: string = "0x80000297"

index

index: string = "663"

link

link: string = "https://egem.io"

name

symbol

symbol: string = "SFRX"

664

664: object

hex

hex: string = "0x80000298"

index

index: string = "664"

index

index: string = "688"

link

link: string = "https://www.coinex.org/"

name

symbol

symbol: string = "CET"

689

689: object

hex

hex: string = "0x800002b1"

index

index: string = "689"

name

symbol

link

link: string = "https://github.com/TheHolyRoger/TheHolyRogerCoin"

name

symbol

symbol: string = "ROGER"

697

697: object

hex

hex: string = "0x800002b9"

index

index: string = "697"

name

symbol

link

link: string = "http://namecoin.info/"

name

symbol

symbol: string = "NMC"

70

70: object

hex

hex: string = "0x80000046"

index

index: string = "70"

link

link: string = "https://britcoin.com"

name

symbol

link

link: string = "https://compcoin.com"

name

symbol

symbol: string = "CMP"

710

710: object

hex

hex: string = "0x800002c6"

index

index: string = "710"

name

symbol

link

link: string = "https://katalchain.com"

name

symbol

symbol: string = "XTL"

714

714: object

hex

hex: string = "0x800002ca"

index

index: string = "714"

link

link: string = "https://www.binance.org"

name

symbol

link: string = "https://semux.org"

name

symbol

index

index: string = "768"

link

link: string = "https://ballzcoin.org"

name

symbol

symbol: string = "BALLZ"

769

769: object

hex

hex: string = "0x80000301"

index

index: string = "769"

name

symbol

link

link: string = "http://btw.one"

name

symbol

symbol: string = "BTW"

7777

7777: object

hex

hex: string = "0x80001e61"

index

index: string = "7777"

link

link: string = "https://www.bitvote.one"

name

symbol

link

link: string = "https://wagerr.com"

name

symbol

link

link: string = "https://qvolta.com"

name

symbol

symbol: string = "QVT"

809

809: object

hex

hex: string = "0x80000329"

index

index: string = "809"

name

symbol

link

link: string = "https://terracoin.io/"

name

symbol

symbol: string = "TRC"

830

830: object

hex

hex: string = "0x8000033e"

index

index: string = "830"

name

symbol

link

link: string = "https://infinitefuture.top"

name

symbol

symbol: string = "IF"

869

869: object

hex

hex: string = "0x80000365"

index

index: string = "869"

name

symbol

index

index: string = "886"

link

link: string = "http://adfunds.org"

91927009

91927009: object

hex

hex: string = "0x857ab1e1"

index

index: string = "91927009"

link

link: string = "https://kowala.tech"

name

symbol

link

link: string = "https://github.com/CrypticApplications/MTR-Update/"

name

symbol

symbol: string = "MTR"

930

930: object

hex

hex: string = "0x800003a2"

index

index: string = "930"

name

symbol

97

97: object

hex

hex: string = "0x80000061"

index

index: string = "97"

link

link: string = "https://github.com/ubiquoin/ubiq"

name

symbol

link

link: string = "https://www.energi.world/"

name

symbol

link

link: string = "http://bitcoinfaith.org"

name

symbol

symbol: string = "BTF"

989

989: object

hex

hex: string = "0x800003dd"

index

index: string = "989"

name

symbol

symbol: string = "QKC"

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

EarthKeyringPair$Meta

EncryptedJsonEncoding

EncryptedJsonVersion

InjectOptions

InjectedExtension

JsonableSecp256k1Identity

JsonnableEd25519KeyIdentity

KeypairType

ProviderList

PublicKeyHex

SecretKeyHex

This

Unsubcall

Type declaration

Returns void

Variables

Const ACCOUNT_DOMAIN_SEPERATOR

Const SUB_ACCOUNT_ZERO

Const extension

Let isWeb3Injected

Let web3EnablePromise

Const win

Functions

Const createWallet

Example (es module)

Example (commonjs)

Parameters

mnemonic: string

symbol: string

Optional account: number

Returns Promise<EarthKeyringPair>

documentReadyPromise

Type parameters

T

Parameters

creator: () => Promise<T>

Returns Promise<T>

Returns Promise<T>

Const getBalance

Parameters

address: any

Returns Promise<{ value: number; currency: object }>

Parameters

address: string

symbol: string

Returns Promise<EarthBalance>

Const getPublicKeySecp256k1

Parameters

privateKey: any

compress: any

Returns string

Const getSlipFromSymbol

Example (es module)

Parameters

symbol: string

Returns { hex: string; index: string; name: string; symbol: string } | { index: number }

Const getSubAccountArray

Parameters

s: any

Returns any[]

Const getTransactions

Parameters

address: any

Returns Promise<{}>

Parameters

address: any

symbol: any

Returns Promise<{}>

getWindowExtensions

Parameters

originName: string

Returns Promise<[InjectedExtensionInfo, Injected | void][]>