@sec-block/secjs-wallet


![JavaScript Style Guide]

SecWallet

Generate a lightweight wallet, At th moment it supports key creation and conversion between various formats
It is complemented by the following packages:
secjs-tx
secjs-icap

Kind: global class

* SecWallet
* new SecWallet(priv, pub)
* .privKey
* .pubKey
* .assert(val, msg)
* .generate(icapGenerate)
* .generateVantiyaAddress(pattern)
* .getPrivateKey()
* .getPrivateKeyString()
* .getPublicKey()
* .getPublicKeyString()
* .getAddress()
* .getAddressString()
* .getAddressChecksumString()
* .fromPrivateKey(priv)
* .fromExtendedPrivateKey(priv)
* .fromPublicKey(pub, nonStrict)
* .fromExtendedPublicKey(pub)

$3

the constructor of the class, private key and publick key will be as property

| Param | Type |
| --- | --- |
| priv | String |
| pub | String |

$3

get private key and return this._privKey

Kind: instance property of SecWallet

$3

get publickey through util function and return this._pubKey

Kind: instance property of SecWallet

$3

verify error

Kind: instance method of SecWallet

| Param |
| --- |
| val |
| msg |

$3

Kind: instance method of SecWallet

| Param | Type | Description |
| --- | --- | --- |
| icapGenerate | Buffer | -create an instance based on a new random key, setting icap to true will generate an address suitable for the ICAP Direct mode. |

$3

-create an instance where the address is valid against the supplied pattern
(this will be very slow)

Kind: instance method of SecWallet

| Param | Type |
| --- | --- |
| pattern | String |

$3

-return the private key

Kind: instance method of SecWallet

$3

-return the private key to string mode

Kind: instance method of SecWallet

$3

-return the public key

Kind: instance method of SecWallet

$3

-return the public key to string mode

Kind: instance method of SecWallet

$3

-return the address

Kind: instance method of SecWallet

$3

return the address to the string mode

Kind: instance method of SecWallet

$3

-return the address with checksum

Kind: instance method of SecWallet

$3

-create an instance based on a raw private key
you can generate the raw pribate key by secjs-util

Kind: instance method of SecWallet

| Param | Type |
| --- | --- |
| priv | String |

$3

-create an instance based on a BIP32 extended private key(xprv)

Kind: instance method of SecWallet

| Param | Type |
| --- | --- |
| priv | String |

$3

-create an instance based on a public key

Kind: instance method of SecWallet

| Param | Type |
| --- | --- |
| pub | String |
| nonStrict | Buffer |

$3

-create an instance based on a BIP32 extended public key(xpub)

Kind: instance method of SecWallet

| Param | Type |
| --- | --- |
| pub | String |

SecHDKey

Generate BIP32 wallets
For the seed we suggest to use BIP39 to create one from a BIP39 mnemonic

Kind: global class

* SecHDKey
* .fromMasterSeed(seedBuffer)
* .fromExtendedKey(base58Key)
* .privateExtendedKey()
* .publicExtendedKey()
* .derivePath(path)
* .deriveChild(index)
* .getWallet()

$3

-create an instance based on seed

Kind: instance method of SecHDKey

| Param | Type |
| --- | --- |
| seedBuffer | String |

$3

-create an instance based on a BIP32 extended private or public key

Kind: instance method of SecHDKey

| Param | Type |
| --- | --- |
| base58Key | String |

$3

-return a BIP32 extended private key (xprv)

Kind: instance method of SecHDKey

$3

-return a BIP32 extended public key(xpub)

Kind: instance method of SecHDKey

$3

-derive a node based on a path (e.g. m/44'/0'/0/1)

Kind: instance method of SecHDKey

| Param |
| --- |
| path |

$3

-derive a node based on a child index

Kind: instance method of SecHDKey

| Param |
| --- |
| index |

$3

-return a wallet instance as seen above

Kind: instance method of SecHDKey