The caver.kct.kip37 helps you easily handle a smart contract that implements KIP-37 as a JavaScript object on the Klaytn blockchain platform (Klaytn).
The caver.kct.kip37 inherits caver.contract to implement the KIP-37 token contract. The caver.kct.kip37 holds the same properties of caver.contract whereas additional methods are implemented for extra features. This section only introduces the newly added methods of the caver.kct.kip37.
The code that implements KIP-37 for caver-js is available on the Klaytn Contracts Github Repo. KIP-37 for caver-js supports Ownable interface. Using this, you can designate a contract owner when deploying a contract
NOTEcaver.kct.kip37 is supported since caver-js v1.5.7.
caver.kct.kip37.deploy
caver.kct.kip37.deploy(tokenInfo, deployer)
Deploys the KIP-37 token contract to the Klaytn blockchain. A contract deployed using caver.kct.kip37.deploy is a multi token that follows the KIP-37 standard.
After successful deployment, the promise will be resolved with a new KIP37 instance.
Parameters
The tokenInfo object must contain the following:
Return Value
PromiEvent: A promise combined event emitter, which is resolved with a new KIP37 instance. Additionally, the following events can occur:
Token Enrollment
To enroll a token on a block explorer, the contract creator must fill out a submission request form. Make note of the specified information required on the form.
// Create a KIP37 instance without a parameter>constkip37=caver.kct.kip37.create()// Create a KIP37 instance with a token address>constkip37=caver.kct.kip37.create('0x{address in hex}')
new KIP37
newcaver.kct.kip37([tokenAddress])
Creates a new KIP37 instance with its bound methods and events.
Parameters
Return Value
Example
// Create a KIP37 instance without a parameter>constkip37=newcaver.kct.kip37()// Create a KIP37 instance with a token address>constkip37=newcaver.kct.kip37('0x{address in hex}')
kip37.clone
kip37.clone([tokenAddress])
Clones the current KIP37 instance.
Parameters
Return Value
Example
>constkip37=newcaver.kct.kip37(address)// Clone without a parameter>constcloned=kip37.clone()// Clone with the address of the new token contract>constcloned=kip37.clone('0x{address in hex}')
kip37.detectInterface
kip37.detectInterface()
Returns the information of the interface implemented by the token contract.
Parameters
None
Return Value
Promise returns an object containing the result with boolean values whether each KIP-37 interface is implemented.
Returns distinct Uniform Resource Identifier (URI) of the given token.
If the string "{id}" exists in any URI, this function will replace this with the actual token ID in hexadecimal form. Please refer to KIP-34 Metadata.
Parameters
NOTE The id 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.
Returns the total token supply of the specific token.
Parameters
NOTE The id 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 BigNumber: The total number of tokens.
Returns the amount of tokens of token type id owned by account.
Parameters
NOTE The id 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 BigNumber: The amount of token that account has.
Example
>kip37.balanceOf('0x{address in hex}',0).then(console.log)20
kip37.balanceOfBatch
kip37.balanceOfBatch(accounts, ids)
Returns the balance of multiple account/token pairs. balanceOfBatch is a batch operation of balanceOf, and the length of arrays with accounts and ids must be the same.
Parameters
Return Value
Promise returns Array: The balance of multiple account/token pairs.
Example
>kip37.balanceOfBatch(['0x{address in hex}','0x{address in hex}'], [0,1]).then(console.log)[ 20,30 ]
kip37.isMinter
kip37.isMinter(address)
Returns true if the given account is a minter who can issue new KIP37 tokens.
Parameters
Return Value
Promise returns boolean: true if the account is a minter.
Example
>kip37.isMinter('0x{address in hex}').then(console.log)true>kip37.isMinter('0x{address in hex}').then(console.log)false
kip37.isPauser
kip37.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
>kip37.isPauser('0x{address in hex}').then(console.log)true>kip37.isPauser('0x{address in hex}').then(console.log)false
kip37.paused
kip37.paused()
Returns whether or not the token contract's transaction (or specific token) is paused.
If id parameter is not defined, return whether the token contract's transaction is paused. If id parameter is defined, return whether the specific token is paused.
Parameters
NOTE The id 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 boolean: true if the contract (or specific token) is paused.
Example
// without token id parameter>kip37.paused().then(console.log)true>kip37.paused().then(console.log)false// with token id parameter>kip37.paused(0).then(console.log)true>kip37.paused(1).then(console.log)false
kip37.isApprovedForAll
kip37.isApprovedForAll(owner, operator)
Queries the approval status of an operator for a given owner. Returns true if an operator is approved by a given owner.
Parameters
Return Value
Promise returns boolean: True if the operator is approved, false if not
Example
>kip37.isApprovedForAll('0x{address in hex}','0x{address in hex}').then(console.log)true>kip37.isApprovedForAll('0x{address in hex}','0x{address in hex}').then(console.log)false
Creates a new token type and assigns initialSupply to the minter.
Note that this method will submit a transaction to the Klaytn network, which will charge the transaction fee to the transaction sender.
Parameters
NOTE The id, initialSupply parameters accept 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:
NOTEfeeDelegation, feePayer and feeRatio are supported since caver-js v1.6.1.
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 KIP37 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.
Example
// Send via a sendParam object with the from field given >kip37.create(2,'1000000000000000000', { from:'0x{address in hex}' }).then(console.log){ blockHash:'0xf1cefd8efbde83595742dc88308143dde50e7bee39a3a0cfea92ed5df3529d61', blocknumber:2823, contractAddress:null, from:'0xfb8789cd544881f820fbff1728ba7c240a539f48',... status:true, to:'0x394091d163ebdebcae876cb96cf0e0984c28a1e9',... events: { TransferSingle: { address:'0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9', blockNumber:2823, transactionHash:'0xee8cdaa0089681d90a52c1539e75c6e26b3eb67affd4fbf70033ba010a3f0d26', transactionIndex:0, blockHash:'0xf1cefd8efbde83595742dc88308143dde50e7bee39a3a0cfea92ed5df3529d61', logIndex:0, id:'log_ca64e74b', returnValues: {'0': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48','1': '0x0000000000000000000000000000000000000000','2': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48','3': '2','4': '1000000000000000000', operator:'0xfb8789cD544881F820Fbff1728Ba7c240a539F48', from:'0x0000000000000000000000000000000000000000', to:'0xfb8789cD544881F820Fbff1728Ba7c240a539F48', id:'2', value:'1000000000000000000', }, event:'TransferSingle', signature:'0xc3d58168c5ae7397731d063d5bbf3d657854427343f4c083240f7aacaa2d0f62', raw: { data:'0x...40000', topics: [ '0xc3d58...','0x00...f48','0x00...000','0x00...f48' ], }, }, },}// Using FD transaction to execute the smart contract>kip37.create(2,'1000000000000000000', { from:'0x{address in hex}' feeDelegation: true, feePayer:'0x{address in hex}'}).then(console.log)// Using kip37.options.from// If the value of kip37.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 kip37 instance.>kip37.options.from ='0x{address in hex}'>kip37.create(2,'1000000000000000000').then(console.log)
Approves the given operator, or disallow the given operator, to transfer all tokens of the owner.
Note that this method will submit a transaction to the Klaytn network, which will charge the transaction fee to the transaction sender.
Parameters
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 KIP37 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.
Example
// Send via a sendParam object with the from field given >kip37.setApprovalForAll('0x{address in hex}',true, { from:'0x{address in hex}' }).then(console.log){ blockHash:'0x0ee7be40f8b9f4d93d68235acef9fba08fde392a93a1a1743243cb9686943a47', blockNumber:3289, contractAddress:null, from:'0xfb8789cd544881f820fbff1728ba7c240a539f48',... status:true, to:'0x394091d163ebdebcae876cb96cf0e0984c28a1e9',... events: { ApprovalForAll: { address:'0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9', blockNumber:3289, transactionHash:'0x5e94aa4af5f7604f1b32129fa8463c43cae4ff118f80645bfabcc6181667b8ab', transactionIndex:0, blockHash:'0x0ee7be40f8b9f4d93d68235acef9fba08fde392a93a1a1743243cb9686943a47', logIndex:0, id:'log_b1f9938f', returnValues: {'0': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48','1': '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6','2': true, account:'0xfb8789cD544881F820Fbff1728Ba7c240a539F48', operator:'0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6', approved:true, }, event:'ApprovalForAll', signature:'0x17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c31', raw: { data:'0x00...001', topics: [ '0x17307...','0x00...f48','0x00...1a6' ], }, }, },}// Using FD transaction to execute the smart contract>kip37.setApprovalForAll('0x{address in hex}',true, { from:'0x{address in hex}' feeDelegation: true, feePayer:'0x{address in hex}'}).then(console.log)// Using kip37.options.from// If the value of kip37.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 kip37 instance.>kip37.options.from ='0x{address in hex}'>kip37.setApprovalForAll('0x{address in hex}',true).then(console.log)
kip37.safeTransferFrom
kip37.safeTransferFrom(from, recipient, id, amount, data [, sendParam])
Safely transfers the given amount tokens of specific token type id from from to the recipient.
The address that was authorized to send the owner's token (the operator) or the token owner him/herself is expected to execute this token transfer transaction. Thus, an authorized address or the token owner should be the sender of this transaction whose address must be given at sendParam.from or kip37.options.from. Unless both sendParam.from and kip37.options.from are provided, an error would occur.
If the recipient was a contract address, it should implement IKIP37Receiver.onKIP37Received. Otherwise, the transfer is reverted.
Note that this method will submit a transaction to the Klaytn network, which will charge the transaction fee to the transaction sender.
Parameters
NOTE The id and amount parameters accept 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 KIP37 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)> kip37.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 2, 10000, { from: '0x{address in hex}' }).then(console.log)
{ blockHash:'0x7dbe4c5bd916ad1aafef87fe6c8b32083080df4ec07f26b6c7a487bb3cc1cf64', blocknumber:3983, contractAddress:null, from:'0xfb8789cd544881f820fbff1728ba7c240a539f48',... status:true, to:'0x394091d163ebdebcae876cb96cf0e0984c28a1e9',... events: { TransferSingle: { address:'0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9', blockNumber:3983, transactionHash:'0x0efc60b88fc55ef37eafbd18057404334dfd595ce4c2c0ff75f0922b928735e7', transactionIndex:0, blockHash:'0x7dbe4c5bd916ad1aafef87fe6c8b32083080df4ec07f26b6c7a487bb3cc1cf64', logIndex:0, id:'log_cddf554f', returnValues: {'0': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48','1': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48','2': '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6','3': '2','4': '1000', operator:'0xfb8789cD544881F820Fbff1728Ba7c240a539F48', from:'0xfb8789cD544881F820Fbff1728Ba7c240a539F48', to:'0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6', id:'2', value:'1000', }, event:'TransferSingle', signature:'0xc3d58168c5ae7397731d063d5bbf3d657854427343f4c083240f7aacaa2d0f62', raw: { data:'0x00...3e8', topics: [ '0xc3d58...','0x00...f48','0x00...f48','0x00...1a6' ], }, }, },}// Using FD transaction to execute the smart contract>kip37.safeTransferFrom('0x{address in hex}','0x{address in hex}',2,10000,true, { from:'0x{address in hex}' feeDelegation: true, feePayer:'0x{address in hex}'}).then(console.log)// Send via a sendParam object with the from field given (with data)> kip37.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 2, 10000, 'data' { from: '0x{address in hex}' }).then(console.log)
// Using kip37.options.from// If the value of kip37.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 kip37 instance.>kip37.options.from ='0x{address in hex}'>kip37.safeTransferFrom('0x{address in hex}','0x{address in hex}',2,10000).then(console.log)
kip37.safeBatchTransferFrom
kip37.safeBatchTransferFrom(from, recipient, ids, amounts, data [, sendParam])
Safely batch transfers of multiple token ids and values from from to the recipient.
The address that was approved to send the owner's token (the operator) or the token owner him/herself is expected to execute this token transfer transaction. Thus, an approved address or the token owner should be the sender of this transaction whose address must be given at sendParam.from or kip37.options.from. Unless both sendParam.from and kip37.options.from are provided, an error would occur.
If the recipient was a contract address, it should implement IKIP37Receiver.onKIP37Received. Otherwise, the transfer is reverted.
Note that this method will submit a transaction to the Klaytn network, which will charge the transaction fee to the transaction sender.
Parameters
NOTE The ids and amounts array parameters accept number type as an element in array, 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 KIP37 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)> kip37.safeBatchTransferFrom('0x{address in hex}', '0x{address in hex}', [1, 2], [10, 1000], { from: '0x{address in hex}' }).then(console.log)
{ blockHash:'0x9e469494463a02ec4f9e2530e014089d6be3146a5485161a530a8e6373d472a6', blocknumber:4621, contractAddress:null, from:'0xfb8789cd544881f820fbff1728ba7c240a539f48',... status:true, to:'0x394091d163ebdebcae876cb96cf0e0984c28a1e9',... events: { TransferBatch: { address:'0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9', blockNumber:4621, transactionHash:'0x557213eef8ae096bc35f5b3bee0e7cf87ecd87129b4a16d4e35a7356c341dad8', transactionIndex:0, blockHash:'0x9e469494463a02ec4f9e2530e014089d6be3146a5485161a530a8e6373d472a6', logIndex:0, id:'log_b050bacc', returnValues: {'0': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48','1': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48','2': '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6','3': ['1','2'],'4': ['10','1000'], operator:'0xfb8789cD544881F820Fbff1728Ba7c240a539F48', from:'0xfb8789cD544881F820Fbff1728Ba7c240a539F48', to:'0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6', ids: ['1','2'], values: ['10','1000'], }, event:'TransferBatch', signature:'0x4a39dc06d4c0dbc64b70af90fd698a233a518aa5d07e595d983b8c0526c8f7fb', raw: { data:'0x00...3e8', topics: [ '0x4a39d...','0x00...f48','0x00...f48','0x00...1a6' ], }, }, },}// Using FD transaction to execute the smart contract>kip37.safeBatchTransferFrom('0x{address in hex}','0x{address in hex}', [1,2], [10,1000], { from:'0x{address in hex}' feeDelegation: true, feePayer:'0x{address in hex}'}).then(console.log)// Send via a sendParam object with the from field given (with data)> kip37.safeBatchTransferFrom('0x{address in hex}', '0x{address in hex}', [1, 2], [10, 1000], 'data', { from: '0x{address in hex}' }).then(console.log)
// Using kip37.options.from// If the value of kip37.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 kip37 instance.>kip37.options.from ='0x{address in hex}'>kip37.safeBatchTransferFrom('0x{address in hex}','0x{address in hex}', [1,2], [10,1000]).then(console.log)
kip37.mint
kip37.mint(to, id, value [, sendParam])
Mints the token of the specific token type id and assigns the tokens according to the variables to and value. The mint function allows you to mint specific token to multiple accounts at once by passing arrays to to and value as parameters.
Note that this method will submit a transaction to the Klaytn network, which will charge the transaction fee to the transaction sender.
Parameters
NOTE The id and value parameters accept 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.
NOTE If sendParam.from or kip37.options.from were given, it should be a minter with MinterRole.
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 KIP37 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.
Example
// Send via a sendParam object with the from field given (Mint the specific tokens to a account)>kip37.mint('0x{address in hex}',2,1000, { from:'0x{address in hex}' }).then(console.log){ blockHash:'0xca4489a003dc781645475b7db11106da61b7438d86910920f953d8b2dab4a701', blocknumber:12868, contractAddress:null, from:'0xfb8789cd544881f820fbff1728ba7c240a539f48',... status:true, to:'0x394091d163ebdebcae876cb96cf0e0984c28a1e9',... events: { TransferSingle: { address:'0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9', blockNumber:12868, transactionHash:'0xed25e305904e6efb613a6fe8b7370488554f6508b6701e9a0167c95d341c73dc', transactionIndex:0, blockHash:'0xca4489a003dc781645475b7db11106da61b7438d86910920f953d8b2dab4a701', logIndex:0, id:'log_04dffde1', returnValues: {'0': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48','1': '0x0000000000000000000000000000000000000000','2': '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6','3': '2','4': '1000', operator:'0xfb8789cD544881F820Fbff1728Ba7c240a539F48', from:'0x0000000000000000000000000000000000000000', to:'0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6', id:'2', value:'1000', }, event:'TransferSingle', signature:'0xc3d58168c5ae7397731d063d5bbf3d657854427343f4c083240f7aacaa2d0f62', raw: { data:'0x00...3e8', topics: [ '0xc3d58...','0x00...f48','0x00...000','0x00...1a6' ], }, }, },}// Send via a sendParam object with the from field given (Mint the specific tokens to the multiple accounts)>kip37.mint(['0x{address in hex}','0x{address in hex}'],2, [1,2], { from:'0x{address in hex}' }).then(console.log){ blockHash:'0x2bf06d039e2e08c611117167df6261d1feebb12afb34fcabdda59fef2298c70f', blocknumber:13378, contractAddress:null, from:'0xfb8789cd544881f820fbff1728ba7c240a539f48',... status:true, to:'0x394091d163ebdebcae876cb96cf0e0984c28a1e9',... events: { TransferSingle: [ { address:'0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9', blockNumber:13378, transactionHash:'0x9b367625572145d27f78c00cd18cf294883f7baced9d495e1004275ba35e0ea9', transactionIndex:0, blockHash:'0x2bf06d039e2e08c611117167df6261d1feebb12afb34fcabdda59fef2298c70f', logIndex:0, id:'log_6975145c', returnValues: {'0':'0xfb8789cD544881F820Fbff1728Ba7c240a539F48','1':'0x0000000000000000000000000000000000000000','2':'0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6','3':'2','4':'1', operator:'0xfb8789cD544881F820Fbff1728Ba7c240a539F48', from:'0x0000000000000000000000000000000000000000', to:'0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6', id:'2', value:'1', }, event:'TransferSingle', signature:'0xc3d58168c5ae7397731d063d5bbf3d657854427343f4c083240f7aacaa2d0f62', raw: { data:'0x00...001', topics: [ '0xc3d58...','0x00...f48','0x00...000','0x00...1a6' ], }, }, { address:'0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9', blockNumber:13378, transactionHash:'0x9b367625572145d27f78c00cd18cf294883f7baced9d495e1004275ba35e0ea9', transactionIndex:0, blockHash:'0x2bf06d039e2e08c611117167df6261d1feebb12afb34fcabdda59fef2298c70f', logIndex:1, id:'log_7fcd4837', returnValues: {'0':'0xfb8789cD544881F820Fbff1728Ba7c240a539F48','1':'0x0000000000000000000000000000000000000000','2':'0xEc38E4B42c79299bFef43c3e5918Cdef482703c4','3':'2','4':'2', operator:'0xfb8789cD544881F820Fbff1728Ba7c240a539F48', from:'0x0000000000000000000000000000000000000000', to:'0xEc38E4B42c79299bFef43c3e5918Cdef482703c4', id:'2', value:'2', }, event:'TransferSingle', signature:'0xc3d58168c5ae7397731d063d5bbf3d657854427343f4c083240f7aacaa2d0f62', raw: { data:'0x000...002', topics: [ '0xc3d58...','0x00...f48','0x00...000','0x00...3c4' ], }, }, ], },}// Using FD transaction to execute the smart contract>kip37.mint('0x{address in hex}',2,1000, { from:'0x{address in hex}' feeDelegation: true, feePayer:'0x{address in hex}'}).then(console.log)// Using kip37.options.from// If the value of kip37.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 kip37 instance.>kip37.options.from ='0x{address in hex}'>kip37.mint('0x{address in hex}',2,1000).then(console.log)
kip37.mintBatch
kip37.mintBatch(to, ids, values [, sendParam])
Mints the multiple KIP-37 tokens of the specific token types ids in a batch and assigns the tokens according to the variables to and values.
Note that this method will submit a transaction to the Klaytn network, which will charge the transaction fee to the transaction sender.
Parameters
NOTE The ids and values array parameters accept number type as an element in array, 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.
NOTE If sendParam.from or kip37.options.from were given, it should be a minter with MinterRole.
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 KIP37 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.
Example
// Send via a sendParam object with the from field given>kip37.mintBatch('0x{address in hex}', [1,2], [100,200], { from:'0x{address in hex}' }).then(console.log){ blockHash:'0xfcfaf73e6b275c173fb699344ddcd6fb39e8f65dbe8dbcfa4123e949c7c6d959', blocknumber:13981, contractAddress:null, from:'0xfb8789cd544881f820fbff1728ba7c240a539f48',... status:true, to:'0x394091d163ebdebcae876cb96cf0e0984c28a1e9',... events: { TransferBatch: { address:'0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9', blockNumber:13981, transactionHash:'0x3e2ddc38210eb3257379a6a59c2e6e341937a4c9e7ef848f1cd0462dfd0b3af6', transactionIndex:0, blockHash:'0xfcfaf73e6b275c173fb699344ddcd6fb39e8f65dbe8dbcfa4123e949c7c6d959', logIndex:0, id:'log_d07901ef', returnValues: {'0': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48','1': '0x0000000000000000000000000000000000000000','2': '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6','3': ['1','2'],'4': ['100','200'], operator:'0xfb8789cD544881F820Fbff1728Ba7c240a539F48', from:'0x0000000000000000000000000000000000000000', to:'0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6', ids: ['1','2'], values: ['100','200'], }, event:'TransferBatch', signature:'0x4a39dc06d4c0dbc64b70af90fd698a233a518aa5d07e595d983b8c0526c8f7fb', raw: { data:'0x00...0c8', topics: [ '0x4a39d...','0x00...f48','0x00...000','0x00...1a6' ], }, }, },}// Using FD transaction to execute the smart contract>kip37.mintBatch('0x{address in hex}', [1,2], [100,200], { from:'0x{address in hex}' feeDelegation: true, feePayer:'0x{address in hex}'}).then(console.log)// Using kip37.options.from// If the value of kip37.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 kip37 instance.>kip37.options.from ='0x{address in hex}'>kip37.mintBatch('0x{address in hex}', [1,2], [100,200]).then(console.log)
kip37.addMinter
kip37.addMinter(account [, sendParam])
Adds an account as a minter, who are permitted to mint tokens.
Note that this method will submit a transaction to the Klaytn network, which will charge the transaction fee to the transaction sender.
Parameters
NOTE If sendParam.from or kip37.options.from were given, it should be a minter.
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 KIP37 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.
Example
// Send via a sendParam object with the from field given >kip37.addMinter('0x{address in hex}', { from:'0x{address in hex}' }).then(console.log){ blockHash:'0x32db6b56d959a388120507a943930351ba681b3c34d1a3c609e6bc03eabdbbe3',