NULS-JS 
Isomorphic JavaScript SDK for NULS blockchain.
Warning
This project is still in early development stages. It is strongly not recommended to use this in a production environment.
Install
$ npm i nuls-jsUsage
import NULS from 'nuls-js';
const account = NULS.account.create(); // Initiate a new account
console.log(account.address); // Nse1TYHc6Rxs84iimrnygSF2kqrUAQM6Guide
https://CCC-NULS.github.io/nuls-js/
Documentation
https://CCC-NULS.github.io/nuls-js/typedoc/index.html
Features
Account Management
TODO
- Read an address balance
- Read node details
- Read address transactions
- Token transactions
- Node joining/leaving
- Node reward output/input
- Red/yellow card transactions
- Send a transaction
- Find all consensus nodes
- Find all nodes
- Find richList/mostActive addresses
- Recent transactions
License
See the LICENSE file for details.
Index
Enumerations
Classes
- APIServer
Class - Account
- Address
Serializer - Alias
Transaction - Base
Transaction - Block
- Block
Api - Block
Extend Serializer - Block
Header - Block
Header Serializer - Block
Serializer - Coin
- Coin
Data - Coin
Data Serializer - Coin
Input - Coin
Output - Coin
Owner Utils - Coin
Serializer - Contract
- Contract
Api - Contract
Call Transaction - Contract
Create Transaction - Contract
Delete Transaction - Contract
Transfer Transaction - Data
Transaction - Deposit
Transaction - Hash
Serializer - Nuls
Data Serializer - Nuls
Digest Data - Nuls
Digest Data Serializer - Nuls
Sign Data Serializer - P2PKHScript
Sig Serializer - Red
Card Transaction - Register
Transaction - Reward
Transaction - Socket
Emitter - Transaction
- Transaction
Api - Transaction
Serializer - Transfer
Transaction - Tx
Data Alias Serializer - Tx
Data Contract Call Serializer - Tx
Data Contract Create Serializer - Tx
Data Contract Delete Serializer - Tx
Data Contract Transfer Serializer - Tx
Data Data Serializer - Tx
Data Deposit Serializer - Tx
Data Red Card Serializer - Tx
Data Register Serializer - Tx
Data Reward Serializer - Tx
Data Serializer - Tx
Data Transfer Serializer - Tx
Data Unregister Serializer - Tx
Data Withdraw Serializer - Tx
Data Yellow Card Serializer - Unregister
Transaction - Utxo
- Utxo
Api - Var
Byte Serializer - Var
Int Serializer - Var
String Serializer - Withdraw
Transaction - Yellow
Card Transaction
Interfaces
- Api
Block - Api
Transaction - Block
Header Object - Block
Object - Coin
Data Object - Coin
Input Object - Coin
Output Object - Contract
Config - Contract
Info - Contract
Method Call Config - Data
Transaction Object - Default
Transaction Config - IAPIConfig
- IAddress
Output - IAddress
Params - IBlock
Data - IBlock
Extend Data - IBlock
Extend Output - IBlock
Header Data - IBlock
Header Output - IBlock
Output - ICoin
Data - ICoin
Data Data - ICoin
Data Output - ICoin
Output - ICoin
Owner Data - IContract
Call Gas Request - IContract
Call Validate Request - IContract
Call Validate Response - IContract
Method - IContract
Method Arg - IContract
View Request - IDigestible
- IHash
Output - INuls
Data Output - INuls
Digest Data Data - INuls
Digest Data Output - INuls
Sign Data Data - INuls
Sign Data Output - IP2PKHScript
Sig Data - IP2PKHScript
Sig Output - IQROptions
- IRead
Data - ITransaction
Data - ITransaction
Output - ITx
Data Alias Data - ITx
Data Alias Output - ITx
Data Contract Call Data - ITx
Data Contract Call Output - ITx
Data Contract Create Data - ITx
Data Contract Create Output - ITx
Data Contract Delete Data - ITx
Data Contract Delete Output - ITx
Data Contract Transfer Data - ITx
Data Contract Transfer Output - ITx
Data Deposit Data - ITx
Data Deposit Output - ITx
Data Output - ITx
Data Red Card Data - ITx
Data Red Card Output - ITx
Data Register Data - ITx
Data Register Output - ITx
Data Reward Output - ITx
Data Unregister Data - ITx
Data Unregister Output - ITx
Data Withdraw Data - ITx
Data Withdraw Output - ITx
Data Yellow Card Data - ITx
Data Yellow Card Output - IVar
Byte Output - IVar
Int Output - IVar
String Output - Reward
Transaction Object - Transaction
Config - Transaction
Constructor - Transaction
Object - UTXO
Type aliases
- Address
- Address
Hash - Agent
Hash - Block
Hash - Block
Hex - Coin
Data Data - Coin
Object - Contract
Call Arg - Contract
Call Args - Contract
Methods Arg Custom Type - Contract
Methods Arg Type - Contract
Methods Ret Type - Hash
- IContract
Call Gas Response - IContract
Get Methods Response - IContract
View Response - IDigest
Data - INuls
Data Data - INuls
Sign Data - IP2PHKSignature
- ITx
Data Data - ITx
Data Data Data - ITx
Data Data Output - ITx
Data Reward Data - ITx
Data Transfer Data - ITx
Data Transfer Output - IVar
Byte Data - Signature
Hash - Transaction
Class - Transaction
Hash - Transaction
Hex - Transaction
Receipt - Transaction
Static Class
Variables
Functions
- address
From Hash - create
Block Signature - create
Transaction Signature - get
Fee - get
Max Fee - get
Min Fee - get
Private Key Buffer - get
Signature From Hash - get
Signature Hash - getXOR
- hash
From Address - hash
From Public Key - is
Hex - is
Valid Address - is
Valid Hash - is
Valid Private Key - na
ToNuls - nuls
ToNa - public
Key From Private Key - read
Uint64LE - ripemd160
- sha256
- sha256
Twice - write
Uint64LE
Type aliases
Address
AddressHash
AgentHash
BlockHash
BlockHex
CoinDataData
CoinObject
ContractCallArg
ContractCallArgs
ContractMethodsArgCustomType
ContractMethodsArgType
ContractMethodsRetType
Hash
IContractCallGasResponse
IContractGetMethodsResponse
IContractViewResponse
IDigestData
INulsDataData
NulsData
Checks if the serialized data is null and reads / writes a placeholder
INulsSignData
IP2PHKSignature
ITxDataData
| Len | Fields | Data Type | Remark |
|---|---|---|---|
| ?? | txData | ?? | Transaction data |
ITxDataDataData
TxDataData
TX_TYPE_DATA
| 尺寸 | 字段 | 数据类型 | 说明 |
|---|---|---|---|
| ?? | logicData | byte[] | business data |
ITxDataDataOutput
ITxDataRewardData
TxDataReward (Coinbase)
http://dev.nuls.io/protocol/transaction.html#TX-TYPE-COINBASE
TX_TYPE_COINBASE
| 尺寸 | 字段 | 数据类型 | 说明 |
|---|---|---|---|
| ?? | txData | byte[] | 0xFFFFFFFF |
ITxDataTransferData
TX_TYPE_TRANSFER
| 尺寸 | 字段 | 数据类型 | 说明 |
|---|---|---|---|
| ?? | txData | byte[] | 0xFFFFFFFF |
ITxDataTransferOutput
IVarByteData
Variable-length buffer, consistent with the VarString implementation.
| Len | Fields | Data Type | Remark |
|---|---|---|---|
| ? | length | VarInt | 字符串的长度，以字节为单位 |
| length | data | byte[length] | 字符串本身 |
SignatureHash
TransactionClass
TransactionHash
TransactionHex
TransactionReceipt
TransactionStaticClass
Variables
Const ADDRESS_LENGTH
Const BLACK_HOLE_ADDRESS
Const CONSENSUS_LOCK_TIME
Const CONSTRUCTOR_METHOD_NAME
Const CONTRACT_MAX_GAS_LIMIT
Const CONTRACT_MIN_GAS_PRICE
Const HASH_LENGTH
Const MAX_FEE_PRICE_1024_BYTES
Const MIN_FEE_PRICE_1024_BYTES
Const NULS_BASE
Const NULS_DECIMALS
Const P2SH_ADDRESS_TYPE
Const PLACE_HOLDER
Const PRIVATE_KEY_LENGTH
Const QRCode
Functions
addressFromHash
-
Parameters
-
hash: AddressHash
Returns string
-
createBlockSignature
-
Parameters
-
blockHeader: IDigestible
-
privateKey: Buffer
Returns SignatureHash
-
createTransactionSignature
-
Parameters
-
tx: IDigestible
-
privateKey: Buffer
Returns SignatureHash
-
getFee
-
According to the transaction size calculate the handling fee
Parameters
-
size: number
size of the transaction
-
feePrice: number
price of the fee per block (1KB)
Returns number
-
getMaxFee
-
Retrieves the maximun fee for the given transaction size
Parameters
-
size: number
size of the transaction
Returns number
-
getMinFee
-
Retrieves the minimum fee for the given transaction size
Parameters
-
size: number
size of the transaction
Returns number
-
getPrivateKeyBuffer
-
Parameters
-
privateKey: string
Returns Buffer
-
getSignatureFromHash
-
Parameters
-
signatureHash: SignatureHash
Returns IP2PHKSignature | null
-
getSignatureHash
-
Parameters
-
signatureData: IP2PHKSignature | null
Returns SignatureHash
-
getXOR
-
Parameters
-
bytes: Buffer
Returns number
-
hashFromAddress
-
Parameters
-
address: Address
Returns AddressHash
-
hashFromPublicKey
-
Parameters
-
publicKey: Buffer
-
Default value __namedParameters: object = {}
Returns Buffer
-
isHex
-
Parameters
-
input: string
Returns boolean
-
isValidAddress
-
Parameters
-
address: string
Returns boolean
-
isValidHash
-
Parameters
-
hash: string
Returns boolean
-
isValidPrivateKey
-
Parameters
-
privateKey: string
Returns boolean
-
naToNuls
-
Parameters
-
na: number
Returns number
-
nulsToNa
-
Parameters
-
nuls: number
Returns number
-
publicKeyFromPrivateKey
-
Parameters
-
privateKey: Buffer
Returns Buffer
-
readUint64LE
-
Parameters
-
buffer: Buffer
-
offset: number
Returns number
-
ripemd160
-
Parameters
-
buffer: Buffer
Returns Buffer
-
sha256
-
Parameters
-
buffer: Buffer
Returns Buffer
-
sha256Twice
-
Parameters
-
buffer: Buffer
Returns Buffer
-
writeUint64LE
-
Parameters
-
data: number
-
buf: Buffer
-
offset: number
Returns number
-
CoinData
https://github.com/nuls-io/nuls/blob/master/core-module/kernel/src/main/java/io/nuls/kernel/model/CoinData.java