Skip to content
This repository has been archived by the owner on Jul 23, 2024. It is now read-only.

Commit

Permalink
Merge pull request #581 from narendracode/fix/incorrect-page-link
Browse files Browse the repository at this point in the history
Fix Page links
  • Loading branch information
jimni1222 authored Feb 4, 2022
2 parents a015365 + 7e8a4d8 commit e86b9d6
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 37 deletions.
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ You can add the keyring object created in the above example to the caver.wallet,
```

### Submitting a Transaction
You can use caver-js to submit various types of transactions to a node. Please refer to the [caver.transaction](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.transaction/#class) to see how to create a transaction of each type.
You can use caver-js to submit various types of transactions to a node. Please refer to the [caver.transaction](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.transaction/#class) to see how to create a transaction of each type.

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.
```
Expand Down Expand Up @@ -206,24 +206,24 @@ caver-js provides the caver.utils.convertToPeb function for unit conversion. Ple

## Documentation

Documentation can be found at [Klaytn Docs-caver-js](https://docs.klaytn.com/bapp/sdk/caver-js).
Documentation can be found at [Klaytn Docs-caver-js](https://docs.klaytn.com/dapp/sdk/caver-js).

## API Specification

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

* [caver.account](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.account)
* [caver.wallet](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.wallet)
* [caver.wallet.keyring](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.wallet/keyring)
* [caver.transaction](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.transaction)
* [caver.rpc.klay](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.rpc/klay)
* [caver.rpc.net](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.rpc/net)
* [caver.contract](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.contract)
* [caver.abi](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.abi)
* [caver.kct.kip7](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.kct/kip7)
* [caver.kct.kip17](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.kct/kip17)
* [caver.utils](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.utils)
* [caver.ipfs](https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.ipfs)
* [caver.account](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.account)
* [caver.wallet](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.wallet)
* [caver.wallet.keyring](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.wallet/keyring)
* [caver.transaction](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.transaction)
* [caver.rpc.klay](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.rpc/klay)
* [caver.rpc.net](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.rpc/net)
* [caver.contract](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.contract)
* [caver.abi](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.abi)
* [caver.kct.kip7](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.kct/kip7)
* [caver.kct.kip17](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.kct/kip17)
* [caver.utils](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.utils)
* [caver.ipfs](https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.ipfs)

## Web3.js Similarity

Expand Down Expand Up @@ -299,8 +299,8 @@ The meaning of error code can be found below:

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

* [Count BApp](https://docs.klaytn.com/bapp/tutorials/count-bapp)
* [Klaystagram](https://docs.klaytn.com/bapp/tutorials/klaystagram)
* [Count BApp](https://docs.klaytn.com/dapp/tutorials/count-bapp)
* [Klaystagram](https://docs.klaytn.com/dapp/tutorials/klaystagram)

## Trouble shooting and known issues

Expand Down Expand Up @@ -362,10 +362,10 @@ More information on using react-app-rewired with create-react-app can be found [
[caver-java](https://github.com/klaytn/caver-java) for Java


[Keyring]: https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.wallet/keyring
[caver.wallet.keyring]: https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.wallet/keyring
[wallet]: https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.wallet
[caver.wallet]: https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.wallet
[SingleKeyring]: https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.wallet/keyring#singlekeyring
[MultipleKeyring]: https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.wallet/keyring#multiplekeyring
[RoleBasedKeyring]: https://docs.klaytn.com/bapp/sdk/caver-js/api-references/caver.wallet/keyring#rolebasedkeyring
[Keyring]: https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.wallet/keyring
[caver.wallet.keyring]: https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.wallet/keyring
[wallet]: https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.wallet
[caver.wallet]: https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.wallet
[SingleKeyring]: https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.wallet/keyring#singlekeyring
[MultipleKeyring]: https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.wallet/keyring#multiplekeyring
[RoleBasedKeyring]: https://docs.klaytn.com/dapp/sdk/caver-js/api-references/caver.wallet/keyring#rolebasedkeyring
2 changes: 1 addition & 1 deletion TERMS-OF-USE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ These Terms shall be applied to users installing and utilizing the Software incl

## 3. Services provided by the Software

The Software provides users with services which enable them to interact with Klaytn blockchain and users may refer to details of such services at Klaytn docs (https://docs.klaytn.com/bapp/sdk/caver-js).
The Software provides users with services which enable them to interact with Klaytn blockchain and users may refer to details of such services at Klaytn docs (https://docs.klaytn.com/dapp/sdk/caver-js).

## 4. Software use and installation

Expand Down
26 changes: 13 additions & 13 deletions packages/caver-rpc/src/klay.js
Original file line number Diff line number Diff line change
Expand Up @@ -620,10 +620,10 @@ class Klay {
}),
/**
* Generates signed data specific to the Klaytn.
* Refer to {@link https://docs.klaytn.com/bapp/json-rpc/api-references/klay/account#klay_sign|Klaytn Platform API - klay_sign} to know how the signature is generated
* Refer to {@link https://docs.klaytn.com/dapp/json-rpc/api-references/klay/account#klay_sign|Klaytn Platform API - klay_sign} to know how the signature is generated
*
* This API provides the function to sign a message using an {@link https://docs.klaytn.com/bapp/json-rpc/api-references/personal#personal_importrawkey|imported account} in your Klaytn node.
* The imported account in your node must be {@link https://docs.klaytn.com/bapp/json-rpc/api-references/personal#personal_unlockaccount|unlocked} to sign the message.
* This API provides the function to sign a message using an {@link https://docs.klaytn.com/dapp/json-rpc/api-references/personal#personal_importrawkey|imported account} in your Klaytn node.
* The imported account in your node must be {@link https://docs.klaytn.com/dapp/json-rpc/api-references/personal#personal_unlockaccount|unlocked} to sign the message.
* To sign a transaction with imported account in your Klaytn node, use {@link signTransaction|caver.rpc.klay.signTransaction}.
*
* @memberof Klay
Expand Down Expand Up @@ -1242,7 +1242,7 @@ class Klay {
* const result = await caver.rpc.klay.getStorageAt('0x407d73d8a49eeb85d32cf465507dd71d507100c1')
*
* @param {string} address The address to get the storage from.
* @param {number} position The index position of the storage. For more information on calculating the position, refer to {@link https://docs.klaytn.com/bapp/json-rpc/api-references/klay/block#klay_getstorageat|klay_getStorageAt}.
* @param {number} position The index position of the storage. For more information on calculating the position, refer to {@link https://docs.klaytn.com/dapp/json-rpc/api-references/klay/block#klay_getstorageat|klay_getStorageAt}.
* @param {string|number} [blockNumber] A block number, or the string `latest` or `earliest`. If omitted, `latest` will be used.
* @param {function} [callback] Optional callback, returns an error object as the first parameter and the result as the second.
* @return {Promise<string>} The value at this storage position.
Expand Down Expand Up @@ -1625,8 +1625,8 @@ class Klay {
/**
* Signs a transaction as a transaction `sender` with an "imported account's private key" in your Klaytn Node and propagates the transaction to the Klaytn.
*
* This API provides the function to sign a transaction using an {@link https://docs.klaytn.com/bapp/json-rpc/api-references/personal#personal_importrawkey|imported account} in your Klaytn node.
* The imported account in your node must be {@link https://docs.klaytn.com/bapp/json-rpc/api-references/personal#personal_unlockaccount|unlocked} to sign a transaction.
* This API provides the function to sign a transaction using an {@link https://docs.klaytn.com/dapp/json-rpc/api-references/personal#personal_importrawkey|imported account} in your Klaytn node.
* The imported account in your node must be {@link https://docs.klaytn.com/dapp/json-rpc/api-references/personal#personal_unlockaccount|unlocked} to sign a transaction.
*
* @memberof Klay
* @method sendTransaction
Expand Down Expand Up @@ -1656,8 +1656,8 @@ class Klay {
*
* Before using sendTransaction as a fee payer, the transaction sender must have signed with valid signature(s) and the `nonce` must have been defined.
*
* This API provides the function to sign a transaction using an {@link https://docs.klaytn.com/bapp/json-rpc/api-references/personal#personal_importrawkey|imported account} in your Klaytn node.
* The imported account in your node must be {@link https://docs.klaytn.com/bapp/json-rpc/api-references/personal#personal_unlockaccount|unlocked} to sign a transaction.
* This API provides the function to sign a transaction using an {@link https://docs.klaytn.com/dapp/json-rpc/api-references/personal#personal_importrawkey|imported account} in your Klaytn node.
* The imported account in your node must be {@link https://docs.klaytn.com/dapp/json-rpc/api-references/personal#personal_unlockaccount|unlocked} to sign a transaction.
*
* @memberof Klay
* @method sendTransactionAsFeePayer
Expand Down Expand Up @@ -1724,8 +1724,8 @@ class Klay {
/**
* Signs a transaction as a transaction sender with an "imported account's private key" in your Klaytn Node.
*
* This API provides the function to sign a transaction using an {@link https://docs.klaytn.com/bapp/json-rpc/api-references/personal#personal_importrawkey|imported account} in your Klaytn node.
* The imported account in your node must be {@link https://docs.klaytn.com/bapp/json-rpc/api-references/personal#personal_unlockaccount|unlocked} to sign a transaction.
* This API provides the function to sign a transaction using an {@link https://docs.klaytn.com/dapp/json-rpc/api-references/personal#personal_importrawkey|imported account} in your Klaytn node.
* The imported account in your node must be {@link https://docs.klaytn.com/dapp/json-rpc/api-references/personal#personal_unlockaccount|unlocked} to sign a transaction.
*
* @memberof Klay
* @method signTransaction
Expand Down Expand Up @@ -1753,8 +1753,8 @@ class Klay {
/**
* Signs a transaction as a transaction fee payer with an "imported account's private key" in your Klaytn Node.
*
* This API provides the function to sign a transaction using an {@link https://docs.klaytn.com/bapp/json-rpc/api-references/personal#personal_importrawkey|imported account} in your Klaytn node.
* The imported account in your node must be {@link https://docs.klaytn.com/bapp/json-rpc/api-references/personal#personal_unlockaccount|unlocked} to sign a transaction.
* This API provides the function to sign a transaction using an {@link https://docs.klaytn.com/dapp/json-rpc/api-references/personal#personal_importrawkey|imported account} in your Klaytn node.
* The imported account in your node must be {@link https://docs.klaytn.com/dapp/json-rpc/api-references/personal#personal_unlockaccount|unlocked} to sign a transaction.
*
* @memberof Klay
* @method signTransactionAsFeePayer
Expand Down Expand Up @@ -2042,7 +2042,7 @@ class Klay {
* To check if the state has changed, call {@link Klay#getFilterChanges|caver.rpc.klay.getFilterChanges}.
* To obtain all logs matching the filter created by `newFilter`, call {@link Klay#getFilterLogs|caver.rpc.klay.getFilterLogs}.
*
* For detailed information about the topics in the filter object, please see {@link https://docs.klaytn.com/bapp/json-rpc/api-references/klay/filter#klay_newfilter|Klaytn Platform API - klay_newFilter}.
* For detailed information about the topics in the filter object, please see {@link https://docs.klaytn.com/dapp/json-rpc/api-references/klay/filter#klay_newfilter|Klaytn Platform API - klay_newFilter}.
*
* @memberof Klay
* @method newFilter
Expand Down

0 comments on commit e86b9d6

Please sign in to comment.