Naughty Program Manipulator

    @sec-block/secjs-wallet

    1.1.7 • Public • Published

    JavaScript Style Guide

    [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

    new SecWallet(priv, pub)

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

    Param Type
    priv String
    pub String

    secWallet.privKey

    get private key and return this._privKey

    Kind: instance property of SecWallet

    secWallet.pubKey

    get publickey through util function and return this._pubKey

    Kind: instance property of SecWallet

    secWallet.assert(val, msg)

    verify error

    Kind: instance method of SecWallet

    Param
    val
    msg

    secWallet.generate(icapGenerate)

    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.

    secWallet.generateVantiyaAddress(pattern)

    -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

    secWallet.getPrivateKey()

    -return the private key

    Kind: instance method of SecWallet

    secWallet.getPrivateKeyString()

    -return the private key to string mode

    Kind: instance method of SecWallet

    secWallet.getPublicKey()

    -return the public key

    Kind: instance method of SecWallet

    secWallet.getPublicKeyString()

    -return the public key to string mode

    Kind: instance method of SecWallet

    secWallet.getAddress()

    -return the address

    Kind: instance method of SecWallet

    secWallet.getAddressString()

    return the address to the string mode

    Kind: instance method of SecWallet

    secWallet.getAddressChecksumString()

    -return the address with checksum

    Kind: instance method of SecWallet

    secWallet.fromPrivateKey(priv)

    -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

    secWallet.fromExtendedPrivateKey(priv)

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

    Kind: instance method of SecWallet

    Param Type
    priv String

    secWallet.fromPublicKey(pub, nonStrict)

    -create an instance based on a public key

    Kind: instance method of SecWallet

    Param Type
    pub String
    nonStrict Buffer

    secWallet.fromExtendedPublicKey(pub)

    -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)

    -create an instance based on seed

    Kind: instance method of SecHDKey

    Param Type
    seedBuffer String

    secHDKey.fromExtendedKey(base58Key)

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

    Kind: instance method of SecHDKey

    Param Type
    base58Key String

    secHDKey.privateExtendedKey()

    -return a BIP32 extended private key (xprv)

    Kind: instance method of SecHDKey

    secHDKey.publicExtendedKey()

    -return a BIP32 extended public key(xpub)

    Kind: instance method of SecHDKey

    secHDKey.derivePath(path)

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

    Kind: instance method of SecHDKey

    Param
    path

    secHDKey.deriveChild(index)

    -derive a node based on a child index

    Kind: instance method of SecHDKey

    Param
    index

    secHDKey.getWallet()

    -return a wallet instance as seen above

    Kind: instance method of SecHDKey

    Install

    npm i @sec-block/secjs-wallet

    DownloadsWeekly Downloads

    14

    Version

    1.1.7

    License

    MIT

    Unpacked Size

    51.1 kB

    Total Files

    10

    Last publish

    Collaborators

    • abysmli
    • bi7012xiao
    • feiminhao
    • g277321
    • tornadoming
    • xinnnnn
    • zuweihan1992