The caver.klay.KIP7 helps you easily handle a smart contract that implements KIP-7 as a JavaScript object on the Klaytn blockchain.
The caver.klay.KIP7 inherits caver.klay.Contract to implement the KIP-7 token contract. The caver.klay.KIP7 holds the same properties of caver.klay.Contract whereas additional methods to implement extra features. This section only introduces the newly added bound methods of the caver.klay.KIP7.
The abi and bytecode used in the caver.klay.KIP7 were implemented using the example of openzeppelin.
NOTEcaver.klay.KIP7 is supported since caver-js v1.4.0.
caver.klay.KIP7.deploy
caver.klay.KIP7.deploy(tokenInfo, deployer)
Deploys the KIP-7 token contract to the Klaytn blockchain. A contract deployed using caver.klay.KIP7.deploy is a fungible token that follows the KIP-7 standard.
After successful deployment, the promise will be resolved with a new KIP7 instance.
Parameters
Name
Type
Description
The tokenInfo object must contain the following:
Name
Type
Description
NOTE The initialSupply parameter accepts Number type but if the fed value were out of the range capped by Number.MAX_SAFE_INTEGER, it might cause an unexpected result or error. In this case, it is recommended to use the BigNumber type, especially for a uint256 sized numeric input value.
Return Value
PromiEvent: A promise combined event emitter, which is resolved with a new KIP7 instance. Additionally, the following events can occur:
Example
// using the promise>caver.klay.KIP7.deploy({ name:'Jasmine', symbol:'JAS', decimals:18, initialSupply:'100000000000000000000',},'0x{address in hex}').then(console.log)KIP7 {... _address:'0x598367e443D8a2b644Fec69a2C12aF44BC283f23', _jsonInterface: [... { anonymous:false, inputs: [ { indexed:true, name:'owner', type:'address' }, { indexed:true, name:'spender', type:'address' }, { indexed:false, name:'value', type:'uint256' } ], name:'Approval', type:'event', signature:'0x8c5be...' } ] }// using event emitter and promise>caver.klay.KIP7.deploy({ name:'Jasmine', symbol:'JAS', decimals:18, initialSupply:'100000',},'0x{address in hex}').on('error',function(error) { ... }).on('transactionHash',function(transactionHash) { ... }).on('receipt',function(receipt) {console.log(receipt.contractAddress) // contains the new token contract address}).then(function(newKIP7Instance) {console.log(newKIP7Instance.options.address) // instance with the new token contract address})
new KIP7
newcaver.klay.KIP7([tokenAddress])
Creates a new KIP7 instance with its bound methods and events.
Parameters
Return Value
Example
// Create a KIP7 instance without a parameter>constkip7Instance=newcaver.klay.KIP7()// Create a KIP7 instance with a token address>constkip7Instance=newcaver.klay.KIP7('0x{address in hex}')
kip7Instance.clone
kip7Instance.clone([tokenAddress])
Clones the current KIP7 instance.
Parameters
Return Value
Example
>constkip7Instance=newcaver.klay.KIP7(address)// Clone without a parameter>constcloned=kip7Instance.clone()// Clone with the address of the new token contract>constcloned=kip7Instance.clone('0x{address in hex}')
kip7Instance.supportsInterface
kip7Instance.supportsInterface(interfaceId)
Returns true if this contract implements the interface defined by interfaceId.
Parameters
Return Value
Promise returns Boolean: true if this contract implements the interface defined by interfaceId.
>kip7Instance.balanceOf('0x{address in hex}').then(console.log)100000
kip7Instance.allowance
kip7Instance.allowance(owner, spender)
Returns the amount of token that spender is allowed to withdraw from owner.
Parameters
Return Value
Promise returns BigNumber: The remaining number of tokens that spender is allowed to spend in place of the owner.
Example
>kip7Instance.allowance('0x{address in hex}','0x{address in hex}').then(console.log)0>kip7Instance.allowance('0x{address in hex}','0x{address in hex}').then(console.log)10
kip7Instance.isMinter
kip7Instance.isMinter(address)
Returns true if the given account is a minter who can issue new KIP7 tokens.
Parameters
Return Value
Promise returns Boolean: true if the account is a minter.
Example
>kip7Instance.isMinter('0x{address in hex}').then(console.log)true>kip7Instance.isMinter('0x{address in hex}').then(console.log)false
kip7Instance.isPauser
kip7Instance.isPauser(address)
Returns true if the given account is a pauser who can suspend transferring tokens.
Parameters
Return Value
Promise returns Boolean: true if the account is a pauser.
Example
>kip7Instance.isPauser('0x{address in hex}').then(console.log)true>kip7Instance.isPauser('0x{address in hex}').then(console.log)false
kip7Instance.paused
kip7Instance.paused()
Returns true if the contract is paused, and false otherwise.
Parameters
None
Return Value
Promise returns Boolean: true if the contract is paused.
Set the amount of the tokens of the token owner to be spent by the spender.
Note that this method will submit a transaction from the owner to the Klaytn network, which will charge the transaction fee to the owner.
Parameters
NOTE The amount parameter accepts Number type but if the fed value were out of the range capped by Number.MAX_SAFE_INTEGER, it might cause an unexpected result or error. In this case, it is recommended to use the BigNumber type, especially for a uint256 sized numeric input value.
The sendParam object contains the following:
Return Value
Promise returns Object - The receipt containing the result of the transaction execution. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. Receipts from KIP7 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.
Example
// Send via a sendParam object with the from field given >kip7Instance.approve('0x{address in hex}',10, { from:'0x{address in hex}' }).then(console.log){ blockHash:'0xf010a98f66b6b36943175cd5b249da54e84abed551cfa02846a2900ddab968c7', blockNumber:2098, contractAddress:null, from:'0x2f7dc98bd93a0544b03d6ff428a6f4ae04b32676',... status:true, to:'0x8ca777e464a83b939ae131ca037f0d8728c6929e',... events: { Approval: { address:'0x8CA777e464a83b939AE131CA037F0d8728C6929e', blockNumber:2098, transactionHash:'0xf7469c0420cb5ebb0fbf64a314bd0c9ee7517ea64dd72eefa59bc8005bbc0f99', transactionIndex:0, blockHash:'0xf010a98f66b6b36943175cd5b249da54e84abed551cfa02846a2900ddab968c7', logIndex:0, id:'log_c6ec61aa', returnValues: {'0': '0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676','1': '0xe36ffD7bc4D588c480B5925B9622881F9d85ea30','2': '10', owner:'0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676', spender:'0xe36ffD7bc4D588c480B5925B9622881F9d85ea30', value:'10' }, event:'Approval', signature:'0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925', raw: { data:'0x000000000000000000000000000000000000000000000000000000000000000a', topics: [ '0x8c5be...','0x00...676','0x00...a30' ] }, }, },}// Using kip7Instance.options.from// If the value of kip7Instance.options.from is set, this value is used as the default value // unless you specify `from` in the sendParam object when sending a transaction with a kip7Instance instance.>kip7Instance.options.from ='0x{address in hex}'>kip7Instance.approve('0x{address in hex}',10).then(console.log)
Transfers the given amount of token from the token owner's balance to the recipient. The token owner should execute this token transfer with its own hands. Thus, the token owner should be the sender of this transaction whose address must be given at sendParam.from or kip7Instance.options.from. Without sendParam.from nor kip7Instance.options.from being provided, an error would occur.
Note that sending this transaction will charge the transaction fee to the transaction sender.
Parameters
NOTE The amount parameter accepts Number type but if the fed value were out of the range capped by Number.MAX_SAFE_INTEGER, it might cause an unexpected result or error. In this case, it is recommended to use the BigNumber type, especially for a uint256 sized numeric input value.
Return Value
Promise returns Object - The receipt containing the result of the transaction execution. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. Receipts from KIP7 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.
Example
// Send via a sendParam object with the from field given >kip7Instance.transfer('0x{address in hex}',10, { from:'0x{address in hex}' }).then(console.log){ blockHash:'0x8a078c3a73d678cdd85d471eb21e9ed7d695f8b96fc7315cfa59c1f68be3d2bf', blockNumber:1353, contractAddress:null, from:'0x2f7dc98bd93a0544b03d6ff428a6f4ae04b32676',... status:true, to:'0x05871c21664e18b2906545f8831695650a8f4056',... events: { Transfer: { address:'0x05871c21664E18b2906545f8831695650a8f4056', blockNumber:1353, transactionHash:'0x8bd2b21a06241e4cfc0af1ec40e7b15444f730c7529440648aa4ed6b697f08f4', transactionIndex:0, blockHash:'0x8a078c3a73d678cdd85d471eb21e9ed7d695f8b96fc7315cfa59c1f68be3d2bf', logIndex:0, id:'log_82ef7705', returnValues: {'0': '0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676','1': '0xE411cb0B61FDcC06497794fE3f49F65D5dE41f59','2': '10', from:'0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676', to:'0xE411cb0B61FDcC06497794fE3f49F65D5dE41f59', value:'10' }, event:'Transfer', signature:'0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef', raw: { data:'0x000000000000000000000000000000000000000000000000000000000000000a', topics: [ '0xddf25...','0x00...676','0x00...f59' ] }, }, },}// Using kip7Instance.options.from// If the value of kip7Instance.options.from is set, this value is used as the default value // unless you specify `from` in the sendParam object when sending a transaction with a kip7Instance instance.>kip7Instance.options.from ='0x{address in hex}'>kip7Instance.transfer('0x{address in hex}',10).then(console.log)
Safely transfers the given amount of token from the token owner's balance to the recipient. The token owner should execute this token transfer with its own hands. Thus, the token owner should be the sender of this transaction whose address must be given at sendParam.from or kip7Instance.options.from. Without sendParam.from nor kip7Instance.options.from being provided, an error would occur.
If the recipient was a contract address, it should implement IKIP7Receiver.onKIP7Received. Otherwise, the transfer is reverted.
Note that sending this transaction will charge the transaction fee to the transaction sender.
Parameters
NOTE The amount parameter accepts Number type but if the fed value were out of the range capped by Number.MAX_SAFE_INTEGER, it might cause an unexpected result or error. In this case, it is recommended to use the BigNumber type, especially for a uint256 sized numeric input value.
Return Value
Promise returns Object - The receipt containing the result of the transaction execution. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. Receipts from KIP17 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.
Example
// Send via a sendParam object with the from field given (without data)>kip7Instance.safeTransfer('0x{address in hex}',10, { from:'0x{address in hex}' }).then(console.log){ blockHash:'0x208cd64b95bbd91420fc6b1a7b514a8d3051d09333d79244b6b74ff2f7f3eee4', blockNumber:2384, contractAddress:null, from:'0xc2c84328845a36fe0c4dcef370d24ec80cf85221',... status:true, to:'0xe4aeba6306b0df023aa4b765960fa59dbe925950',... events: { Transfer: { address:'0xe4AeBa6306b0Df023AA4b765960fA59dbE925950', blockNumber:2384, transactionHash:'0x47bb085947c282722c1ceab1f4f0380d911ce464a47a19f1e7bddfe08a13563d', transactionIndex:0, blockHash:'0x208cd64b95bbd91420fc6b1a7b514a8d3051d09333d79244b6b74ff2f7f3eee4', logIndex:0, id:'log_58e5e06d', returnValues: {'0': '0xC2C84328845A36Fe0c4DcEf370d24ec80cF85221','1': '0x67B092d09B5e94fed58609777cc7Ac9193553B73','2': '10', from:'0xC2C84328845A36Fe0c4DcEf370d24ec80cF85221', to:'0x67B092d09B5e94fed58609777cc7Ac9193553B73', value:'10', }, event:'Transfer', signature:'0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef', raw: { data:'0x000000000000000000000000000000000000000000000000000000000000000a', topics: [ '0xddf25...','0x00...221','0x00...b73' ], }, }, },}// Send via a sendParam object with the from field given (with data)>kip7Instance.safeTransfer('0x{address in hex}',11,'0x1234', { from:'0x{address in hex}' }).then(console.log)// Using kip7Instance.options.from// If the value of kip7Instance.options.from is set, this value is used as the default value // unless you specify `from` in the sendParam object when sending a transaction with a kip7Instance instance.>kip7Instance.options.from ='0x{address in hex}'>kip7Instance.safeTransfer('0x{address in hex}',11).then(console.log)
Transfers the given amount of token from the token owner's balance to the recipient. The address who was approved to send the token owner's tokens is expected to execute this token transferring transaction. Thus, the approved one should be the sender of this transaction whose address must be given at sendParam.from or kip7Instance.options.from. Without sendParam.from nor kip7Instance.options.from being provided, an error would occur.
Note that sending this transaction will charge the transaction fee to the transaction sender.
Parameters
NOTE The amount parameter accepts Number type but if the fed value were out of the range capped by Number.MAX_SAFE_INTEGER, it might cause an unexpected result or error. In this case, it is recommended to use the BigNumber type, especially for a uint256 sized numeric input value.
Return Value
Promise returns Object - The receipt containing the result of the transaction execution. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. Receipts from KIP7 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.
Example
// Send via a sendParam object with the from field given> kip7Instance.transferFrom('0x{address in hex}', '0x{address in hex}', 10000, { from: '0x{address in hex}' }).then(console.log)
{ blockHash:'0x3adec238e06a9e8d5fa09fc1e1d7c8748b64d07e89678d27e8a379a12a34974f', blockNumber:2331, contractAddress:null, from:'0x01958c62ab4aec7fc282bec9491da0ef7f830ac2',... status:true, to:'0x3d5eb40665d25aaa4160023c4278fa6a94ba4acb',... events: { Transfer: { address:'0x3D5EB40665D25aAa4160023C4278FA6A94BA4aCb', blockNumber:2331, transactionHash:'0x5b2232b68681f19d9b6fcd6fb03964ef105912fecb772c11c8ec9fc906be4cbf', transactionIndex:0, blockHash:'0x3adec238e06a9e8d5fa09fc1e1d7c8748b64d07e89678d27e8a379a12a34974f', logIndex:0, id:'log_ae57b7a0', returnValues: {'0': '0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676','1': '0x49ff9cb8BB8CA10D7f6E1094b2Ba56c3C2DBA231','2': '10000', from:'0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676', to:'0x49ff9cb8BB8CA10D7f6E1094b2Ba56c3C2DBA231', value:'10000' }, event:'Transfer', signature:'0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef', raw: { data:'0x0000000000000000000000000000000000000000000000000000000000002710', topics: [ '0xddf25...','0x00...676','0x00...231' ] }, }, Approval: { address:'0x3D5EB40665D25aAa4160023C4278FA6A94BA4aCb', blockNumber:2331, transactionHash:'0x5b2232b68681f19d9b6fcd6fb03964ef105912fecb772c11c8ec9fc906be4cbf', transactionIndex:0, blockHash:'0x3adec238e06a9e8d5fa09fc1e1d7c8748b64d07e89678d27e8a379a12a34974f', logIndex:1, id:'log_cee37d26', returnValues: {'0': '0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676','1': '0x01958c62aB4aEC7fC282bEc9491dA0EF7F830AC2','2': '0', owner:'0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676', spender:'0x01958c62aB4aEC7fC282bEc9491dA0EF7F830AC2', value:'0' }, event:'Approval', signature:'0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925', raw: { data:'0x0000000000000000000000000000000000000000000000000000000000000000', topics: [ '0x8c5be...','0x00...676','0x00...ac2' ] }, }, },}// Using kip7Instance.options.from// If the value of kip7Instance.options.from is set, this value is used as the default value // unless you specify `from` in the sendParam object when sending a transaction with a kip7Instance instance.>kip7Instance.options.from ='0x{address in hex}'>kip7Instance.transferFrom('0x{address in hex}','0x{address in hex}',10000).then(console.log)
Safely transfers the given amount of token from the token owner's balance to the recipient. The address who was approved to send the token owner's tokens is expected to execute this token transferring transaction. Thus, the approved one should be the sender of this transaction whose address must be given at sendParam.from or kip7Instance.options.from. Without sendParam.from nor kip7Instance.options.from being provided, an error would occur.
If the recipient was a contract address, it should implement IKIP7Receiver.onKIP7Received. Otherwise, the transfer is reverted.
Note that sending this transaction will charge the transaction fee to the transaction sender.
Parameters
NOTE The amount parameter accepts Number type but if the fed value were out of the range capped by Number.MAX_SAFE_INTEGER, it might cause an unexpected result or error. In this case, it is recommended to use the BigNumber type, especially for a uint256 sized numeric input value.
Return Value
Promise returns Object - The receipt containing the result of the transaction execution. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. Receipts from KIP17 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.
Example
// Send via a sendParam object with the from field given (without data)> kip7Instance.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 10000, { from: '0x{address in hex}' }).then(console.log)
{ blockHash:'0x0d641b9cebb032f10348288623898f8aa319faa0845c5b3b7a59ac397a6a218b', blockNumber:2404, contractAddress:null, from
