@skqksh/caver-js

v1.9.4

caver-js is a JavaScript API library that allows developers to interact with a Klaytn node For more information about how to use this package see README

Latest version published 2 years ago

License: LGPL-3.0

NPM

GitHub

Package Health Score

45 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.9.4	\|	09/2022	Popular	0 C 0 H 0 M 0 L	0 H 1 M 0 L
1.8.3	\|	06/2022		0 C 0 H 0 M 0 L	0 H 1 M 0 L

License

LGPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (34)

GitHub Stars: 114
Forks: 75
Contributors: 40

Direct Usage Popularity

The npm package @skqksh/caver-js receives a total of 34 downloads a week. As such, we scored @skqksh/caver-js popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @skqksh/caver-js, we found that it has been starred 114 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 40
Funding: No

With more than 10 contributors for the @skqksh/caver-js repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @skqksh/caver-js is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

archived

Commit Frequency

Open Issues: 0
Open PR: 12
Last Release: 2 years ago
Last Commit: 4 months ago

Further analysis of the maintenance status of @skqksh/caver-js based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @skqksh/caver-js is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 2 years
Dependencies: 29 Direct
Versions: 7
Install Size: 9.87 MB
Dist-tags: 1
# of Files: 1.26K
Maintainers: 1
TS Typings: No

@skqksh/caver-js has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

caver-js

caver-js is a JavaScript API library that allows developers to interact with a Klaytn node using a HTTP or Websocket connection.

NOTE Kaikas Web Extension Wallet is recommended to be used with features prior to common architecture. New features provided in caver-js v1.5.0 (introduced common architecrue) or later are currently not compatible with Kaikas. Kaikas web extension wallet works fine with functions prior to common architecture, so please use functions prior to common architecture. Even in the latest version of caver-js, functions prior to common architecture are provided for backward compatibility. See Trouble shooting and known issues for more details.

Requirements

The following packages are required to use the caver-js library.

Testing in caver-js is implemented using the mocha testing framework. If you want to run unit tests in caver-js, you need to install mocha first.

mocha

Note caver-js can run on Node.js versions 12 and 14, and the recommended versions are:

lts/erbium (12.21.0)
lts/fermium (14.16.0)

If you are already using a different version of the node(for example, node v15), use the Node Version Manager(NVM) to install and use the version supported by caver-js.

Installation

Node

To try it out, install caver-js with npm like following command:

$ npm install caver-js

Note package.json file should exist on the same install path. If it does not exist, package.json should be generated via npm init.

To install a specific version of caver-js, try the following command:

$ npm install caver-js@X.X.X

In the Browser

Build using the caver-js repository:

$ npm run build

Then include dist/caver.min.js in your html file. This will expose Caver on the window object.

Or via CDN:

The caver-js provided by cdnjs can be found at this link.

Getting Started

If you want to run your own EN (Endpoint Node), see EN Operation Guide to set up. You can connect EN like below:

$ node
&gt; const Caver = require('caver-js')
&gt; const caver = new Caver('https://localhost:8551/')

Note The above example should be executed from the location where caver-js is installed, and the example is explained using Node.js REPL.

Check the Connection

You can now use caver-js. You can send a basic request to the node as shown below and check the results.

&gt; caver.rpc.klay.getClientVersion().then(console.log)
Klaytn/vX.X.X/linux-amd64/goX.X.X

Using caver-js keyring/wallet

You can easily use your Klaytn account when signing a transaction or message by using the Keyring / wallet.

The keyring is a new feature that contains an address and one or more private keys based on the key types (SingleKeyring, MultipleKeyring or RoleBasedKeyring). Refer to caver.wallet.keyring for details. caver.wallet, the in-memory wallet, is provided to easily manage multiple keyrings.

Note Functions associated with wallet and keyring have no effect on the Klaytn blockchain platform. It just manipulates keyrings in the in-memory wallet.

Let's create a random keyring as shown in the example below:

&gt; const keyring = caver.wallet.keyring.generate()

&gt; keyring
SingleKeyring {
  _address: '0x64d221893cc628605314026f4c4e0879af5b75b1',
  _key: PrivateKey { _privateKey: '0x{private key}' }
}

You can add the keyring object created in the above example to the caver.wallet, or you can add a keyring using an address and private key(s).

// Add a keyring instance to caver.wallet
&gt; caver.wallet.add(keyring)

// Add a keyring to caver.wallet with an address and a private key
&gt; caver.wallet.newKeyring('0x{address in hex}', '0x{private key}')

// Add a keyring to caver.wallet with an address and private keys
&gt; caver.wallet.newKeyring('0x{address in hex}', ['0x{private key1}', '0x{private key2}', ...])

// Add a keyring to caver.wallet with an address and private keys by roles
&gt; caver.wallet.newKeyring('0x{address in hex}', [ ['0x{private key1}', ...], ['0x{private key2}', ...], ['0x{private key3}', ...] ])

Submitting a Transaction

You can use caver-js to submit various types of transactions to a node. Please refer to the caver.transaction to see how to create a transaction of each type.

Note you should create a transaction instance via create function. From caver-js v1.8.2, constructors per transaction type are not supported.

You can sign the transaction using a keyring and send a signed transaction through caver.rpc.klay.sendRawTransaction as shown below, and the receipt is returned as a result.

// Add a keyring to caver.wallet
&gt; const keyring = caver.wallet.newKeyring('0x{address in hex}', '0x{private key}')
&gt; const vt = caver.transaction.valueTransfer.create({
		from: keyring.address,
		to: '0x176ff0344de49c04be577a3512b6991507647f72',
		value: caver.utils.convertToPeb(1, 'KLAY'),
		gas: 25000,
	})
&gt; caver.wallet.sign(keyring.address, vt).then(signed =&gt; {
  caver.rpc.klay.sendRawTransaction(signed).then(console.log)
})
{ 
  blockHash: '0x0a78b5c5b95456b2d6b6a9ba25fd2afd0000d16bcf03a8ae58a6557a59319a67',
  blockNumber: 8021,
  contractAddress: null,
  from: '0x09a08f2289d3eb3499868908f1c84fd9523fe11b',
  ...
  type: 'TxTypeValueTransfer',
  typeInt: 8,
  value: '0xde0b6b3a7640000' 
}

The above example uses Promise when sending a signed transaction to the Klaytn. You can also use event emitter like below.

caver.rpc.klay.sendRawTransaction(signed).on('transactionHash', function(hash){
    ...
  }).on('receipt', function(receipt){
    ...
  })

Units for KLAY

Units of KLAY is shown as below, and peb is the smallest currency unit. peb is the default unit unless the unit conversion is used.

Name	Unit
peb	1
kpeb	1,000
Mpeb	1,000,000
Gpeb	1,000,000,000
ston	1,000,000,000
uKLAY	1,000,000,000,000
mKLAY	1,000,000,000,000,000
KLAY	1,000,000,000,000,000,000
kKLAY	1,000,000,000,000,000,000,000
MKLAY	1,000,000,000,000,000,000,000,000
GKLAY	1,000,000,000,000,000,000,000,000,000
TKLAY	1,000,000,000,000,000,000,000,000,000,000

caver-js provides the caver.utils.convertToPeb function for unit conversion. Please refer to the usage below.

&gt; caver.utils.convertToPeb(1, 'peb')
'1'

&gt; caver.utils.convertToPeb(1, 'Gpeb')
'1000000000'

&gt; caver.utils.convertToPeb(1, 'KLAY')
'1000000000000000000'

Documentation

Documentation can be found at Klaytn Docs-caver-js.

API Specification

The API lists of caver-js are described in folloinwg links:

Web3.js Similarity

Since caver-js has been evolved from web3.js, usage pattern of caver-js is very similar to that of web3.js. This means a software developed using web3.js can be easily converted to caver-js. The following examples are code patterns used in web3.js and caver-js, respectively.

const Web3 = require('web3');	
const web3 = new Web3(new web3.providers.HttpProvider('https://localhost:8545'));	
web3.eth.getBalance('0x407d73d8a49eeb85d32cf465507dd71d507100c1').then(console.log)

const Caver = require('caver-js');	
const caver = new Caver(new Caver.providers.HttpProvider('https://localhost:8545'));	
caver.rpc.klay.getBalance('0x407d73d8a49eeb85d32cf465507dd71d507100c1').then(console.log)

Error Code Improvement

Klaytn improves reporting transaction failure via txError in the receipt. caver-js further improves the report by presenting the error string that corresponds to txError.

The below is an example of a receipt containing txError.

Error: VM error occurs while running smart contract
 {
  "blockHash": "0xe7ec35c9fff1178d52cee1d46d40627d19f828c4b06ad1a5c3807698b99acb20",
  ...
  "txError": "0x2",
  ...
}

The meaning of error code can be found below:

Error Code	Description
0x02	VM error occurs while running smart contract
0x03	max call depth exceeded
0x04	contract address collision
0x05	contract creation code storage out of gas
0x06	evm: max code size exceeded
0x07	out of gas
0x08	evm: write protection
0x09	evm: execution reverted
0x0a	reached the opcode computation cost limit (100000000) for tx
0x0b	account already exists
0x0c	not a program account (e.g., an account having code and storage)
0x0d	Human-readable address is not supported now
0x0e	fee ratio is out of range [1, 99]
0x0f	AccountKeyFail is not updatable
0x10	different account key type
0x11	AccountKeyNil cannot be initialized to an account
0x12	public key is not on curve
0x13	key weight is zero
0x14	key is not serializable
0x15	duplicated key
0x16	weighted sum overflow
0x17	unsatisfiable threshold. Weighted sum of keys is less than the threshold.
0x18	length is zero
0x19	length too long
0x1a	nested composite type
0x1b	a legacy transaction must be with a legacy account key
0x1c	deprecated feature
0x1d	not supported
0x1e	smart contract code format is invalid

Sample Projects

The BApp (Blockchain Application) Development sample projects using caver-js are the following:

Trouble shooting and known issues

Connect with Kaikas Web Extension

Kaikas Web Extension Wallet works normally with functions prior to common architecture. Features provided in later versions (caver-js v1.5.0~) may not work with Kaikas Web Extension Wallet.

If the following error occurs when using with Kaikas, it must be modified to use the functions supported by caver-js v1.4.1. For compatibility with the latest version, the same functions provided by caver-js v1.4.0 are provided.

Kaikas only processes one transaction at a time. Open Kaikas and refresh the pending transaction. If the service doesn’t process your transaction for a while, cancel the pending transaction.

Kaikas는 한 번에 하나의 트랜잭션만 처리합니다. Kaikas를 열어 대기 중인 트랜잭션을 새로고침 해주세요. 만약 대기 상태가 계속된다면 이용 중인 서비스가 트랜잭션을 처리하지 않는 것이니 트랜잭션을 취소바랍니다.

Although the above error is mostly the case, other errors may occur besides the above error, so if you are using Kaikas Web Extension Wallet, please use the functions supported by caver-js v1.4.1. Keep in mind that you cannot mix features before and after common architecture.

For documents for the functions supported by caver-js v1.4.1, refer to caver-js ~v1.4.1 Documentation.

Github Repository

caver-js

Related Projects

caver-java for Java

FAQs

What is @skqksh/caver-js?

caver-js is a JavaScript API library that allows developers to interact with a Klaytn node. Visit Snyk Advisor to see a full health score report for @skqksh/caver-js, including popularity, security, maintenance & community analysis.

Is @skqksh/caver-js popular?

The npm package @skqksh/caver-js receives a total of 34 weekly downloads. As such, @skqksh/caver-js popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @skqksh/caver-js well maintained?

We found indications that @skqksh/caver-js is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @skqksh/caver-js safe to use?

While scanning the latest version of @skqksh/caver-js, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 20 November-2024, at 10:11 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP