1.1.3 • Published 4 years ago

jcc_jingtum_base_lib v1.1.3

Weekly downloads
3
License
Apache-2.0
Repository
github
Last release
4 years ago

The Jingtum Base JavaScript Library

npm Build Status Coverage Status npm downloads

Preface

原始代码来自jingtum-base-lib,在此基础上JCCDex团队做以下增强

The team JCCDex made the following enhancements to the code from jingtum

  • 支持浏览器 Support running in browsers
  • 支持所有的井通联盟链 Support all jingtum alliance chains

井畅应用交流群: 557524730

JCCDex Tech support QQ group ID: 557524730

Installtion

npm install jcc_jingtum_base_lib

API Of Wallet

Usage

const Wallet = require('jcc_jingtum_base_lib').Wallet
// import { Wallet } from 'jcc_jingtum_base_lib'

Constructor

let inst = new Wallet(secret, token)

Parameters

secret- string

token- string

  • swt(jingtum chain)- default
  • bwt(bizain chain)

bwt是商链的原生币,也是燃料币,商链是井通链的联盟链,如果添加新的联盟链,需要在 src/wallet_config.js 添加新的联盟链定义即可,如果需要我们增加请联系我们。

BWT is the native token and gas token of BIZAIN. BIZAIN is the alliance chain of jingtum. If you add a new alliance chain, you need to add a new definition of the alliance chain in src/wallet_config.js.

If you need to add it in this package, please contact us.

generate

generate one wallet

Wallet.generate(token)

Parameters

token- string

  • swt(jingtum chain)- default
  • bwt(bizain chain)

Return

{ secret: '', address: '' }

fromSecret

generate one wallet from secret

Wallet.fromSecret(secret, token)

Parameters

secret- string

token- string

  • swt(jingtum chain)- default
  • bwt(bizain chain)

Return

return { secret: '', address: '' } if the given secret is valid, otherwise return null.

isValidAddress

Wallet.isValidAddress(address, token)

Parameters

address- string

token- string

  • swt(jingtum chain)- default
  • bwt(bizain chain)

Return

return true if the given address is valid, otherwise return false.

isValidSecret

Wallet.isValidSecret(secret, token)

Parameters

secret- string

token- string

  • swt(jingtum chain)- default
  • bwt(bizain chain)

Return

return true if the given secret is valid, otherwise return false.

getPublicKey

get the public key from keypair, used for local opearation of signing.

inst.getPublicKey()

Return

return public key if successfully, otherwise return null.

signTx

sign message with wallet private key.

inst.signTx(message)

Parameters

message- string

Return

return encoded signature data if successfully, otherwise return null.

verifyTx

verify signature data with wallet public key.

inst.verifyTx(message, signature)

Parameters

message- string

signature- string

Return

return boolean if successfully, otherwise return null.

API Of Keypair

Usage

const KeyPair = require('jcc_jingtum_base_lib').KeyPair
// import { KeyPair } from 'jcc_jingtum_base_lib'

Constructor

let inst = new KeyPair(token)

Parameters

token- string

  • swt(jingtum chain)- default
  • bwt(bizain chain)

convertAddressToBytes

convert the given address to byte array

inst.convertAddressToBytes(address)

Parameters

address- string

Return

return byte array if successfully, otherwise throw error.

convertBytesToAddress

convert the byte array to wallet address

inst.convertBytesToAddress(buffer)

Parameters

buffer- Buffer

Return

return address if successfully, otherwise throw error.