# Start
# Module Import
import { wallet } from '@vite/vitejs';
const { wallet } = require('@vite/vitejs');
# Common Types
export declare type AddressObj = {
originalAddress: Hex;
publicKey: Hex;
privateKey: Hex;
address: Address;
}
export declare type WalletAddressObj {
publicKey: Hex;
privateKey: Hex;
originalAddress: Hex;
address: Address;
path: String;
}
Passphrase
BIP-39 uses PBKDF2 to generate seed, where mnemonic phrase is feed as password and passphrase as salt. Losing passphrase will result in lost of private key.
See here (opens new window) for details
# Methods
# createMnemonics
Create mnemonic phrase
Parameters
number
Number of bits of the entropy, optional. Default is256
. (256-bit entropy will generate 24-word phrase while 128 bits will create 12-word mnemonics)Array<String>
Wordlist, optional. Default isbip39.wordlists.EN
Return
String
Mnemonic phrase
Example
const bip39 = require('bip39');
import { wallet } from '@vite/vitejs';
const { createMnemonics } = wallet;
const myMnemonics = createMnemonics();
// In case of other language
const myJapanMnemonics = createMnemonics(256, bip39.wordlists.japanese)
# validateMnemonics
Verify mnemonic phrase
Parameters
string
Mnemonic phraseArray<String>
Wordlist, optional. Default isbip39.wordlists.EN
Return
boolean
Iftrue
, the mnemonic phrase is valid
Example
const bip39 = require('bip39');
import { wallet } from '@vite/vitejs';
const result = wallet.validateMnemonics('your menemonics');
// In case of other language
const myJapanMnemonics = wallet.validateMnemonics('your menemonics', bip39.wordlists.japanese);
# deriveAddress
Derive new address based on mnemonic phrase
Parameters
__namedParameters: Object
mnemonics: String
Mnemonic phraseindex?: number
Address index, optional. Default is0
wordlist?: Array<String>
Wordlist, optional. Default isbip39.wordlists.EN
passphrase?: String
Passphrase, optional. Default is''
Return
AddressObj
{ originalAddress, publicKey, privateKey, address }
Example
import { wallet } from '@vite/vitejs';
const { originalAddress, publicKey, privateKey, address } = wallet.deriveAddress({
mnemonics: 'your mnemonics',
index: 0
});
# deriveAddressList
Derive a list of new addresses based on mnemonic phrase
Parameters
__namedParameters: Object
mnemonics: String
Mnemonic phrasestartIndex: number
Start index, includedendIndex: number
End index, includedwordlist?: Array<String>
Wordlist, optional. Default isbip39.wordlists.EN
passphrase?: String
Passphrase, optional. Default is''
Return
AddressObj[]
[{ originalAddress, publicKey, privateKey, address }, ...]
Example
import { wallet } from '@vite/vitejs';
const addressList = wallet.deriveAddressList({
mnemonics: 'your mnemonics',
startIndex: 0,
endIndex: 9
});
# isValidAddress
Verify address
Parameters
string
Address
Return
0 | 1 | 2
Illegal: 0; Account Address: 1; Contract Address: 2
Example
import { wallet } from '@vite/vitejs';
const addrType = wallet.isValidAddress('vite_553462bca137bac29f440e9af4ab2e2c1bb82493e41d2bc8b2'); // addrType === 1
const addrType2 = wallet.isValidAddress('32323'); // addrType2 === 0
# createWallet
Create wallet. Wallet is responsible for managing private keys.
Parameters
number
Number of bits of the entropy, optional. Default is256
. (256-bit entropy will generate 24-word phrase while 128 bits will create 12-word mnemonics)Array<String>
Wordlist, optional. Default isbip39.wordlists.EN
string
Passphrase, optional. Default is''
Return
- Wallet instance
Example
import { wallet } from '@vite/vitejs';
const myWallet = wallet.createWallet();
# getWallet
Restore wallet based on mnemonic phrase
Parameters
string
Mnemonic phrasenumber
Number of bits of the entropy, optional. Default is256
. (256-bit entropy will generate 24-word phrase while 128 bits will create 12-word mnemonics)Array<String>
Wordlist, optional. Default isbip39.wordlists.EN
string
Passphrase, optional. Default is''
Return
- Wallet instance
Example
import { wallet } from '@vite/vitejs';
const myWallet = wallet.getWallet('your mnemonics');
← utils Wallet Class →