caver.klay.KIP17

A caver-js object used to interact with a smart contract for KIP17.

caver.klay.KIP17 helps you easily handle a smart contract that implements KIP-17 as a JavaScript object on the Klaytn blockchain.

The caver.klay.KIP17 inherits caver.klay.Contract to implement the KIP-17 token contract. The caver.klay.KIP17 holds the same properties of caver.klay.Contract whereas there are additional methods to implement extra features. This section only introduces the newly added bound methods of the caver.klay.KIP17.

The code that implements KIP-17 for caver-js is available on the Klaytn Contracts Github Repo.

For more information about KIP-17, see Klaytn Improvement Proposals.

NOTE caver.klay.KIP17 is supported since caver-js v1.4.1.

caver.klay.KIP17.deploy

caver.klay.KIP17.deploy(tokenInfo, deployer)

Deploys the KIP-17 token contract to the Klaytn blockchain. A contract deployed using caver.klay.KIP17.deploy is a non-fungible token that follows the KIP-17 standard.

After successful deployment, the promise will be resolved with a new KIP17 instance.

Parameters

Name	Type	Description
tokenInfo	Object	The information needed to deploy KIP-17 token contract on the Klaytn blockchain. See the below table for the details.
deployer	String	The address of the account to deploy the KIP-17 token contract. This account must have enough KLAY to deploy.

The tokenInfo object must contain the following:

Name	Type	Description
name	String	The name of the token.
symbol	String	The symbol of the token.

Return Value

PromiEvent: A promise combined event emitter, which is resolved with a new KIP17 instance. Additionally, the following events can occur:

Name	Type	Description
transactionHash	String	Fired right after the transaction is sent and a transaction hash is available.
receipt	Object
error	Error	Fired if an error occurs during sending.

Example

// using the promise
> caver.klay.KIP17.deploy({
    name: 'Jasmine',
    symbol: 'JAS',
}, '0x{address in hex}').then(console.log)
KIP17 {
    ...
    _address: '0xfA7D967f414468083aDAd85257a2cBD6019693C2',
    _jsonInterface: [
        ...
        {
            anonymous: false,
            inputs: [
                { indexed: true, name: 'owner', type: 'address' },
                 { indexed: true, name: 'operator', type: 'address' },
                 { indexed: false, name: 'approved', type: 'bool' }
            ],
            name: 'ApprovalForAll',
            type: 'event',
            signature: '0x17307...'
        }
    ] 
}

// using event emitter and promise
> caver.klay.KIP17.deploy({
    name: 'Jasmine',
    symbol: 'JAS',
}, '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(newKIP17Instance) {
    console.log(newKIP17Instance.options.address) // instance with the new token contract address
})

new KIP17

new caver.klay.KIP17([tokenAddress])

Creates a new KIP17 instance with its bound methods and events.

Parameters

Name	Type	Description
tokenAddress	String	(optional) The address of the KIP-17 token contract, which can be assigned later through kip17Instance.options.address = '0x1234..'

Return Value

Type	Description
Object	The KIP17 instance with its bound methods and events.

Example

// Create a KIP17 instance without a parameter
> const kip17Instance = new caver.klay.KIP17()

// Create a KIP17 instance with a token address
> const kip17Instance = new caver.klay.KIP17('0x{address in hex}')

kip17Instance.clone

kip17Instance.clone([tokenAddress])

Clones the current KIP17 instance.

Parameters

Name	Type	Description
tokenAddress	String	(optional) The address of the smart contract that deployed another KIP-17 token. If omitted, it will be set to the contract address in the original instance.

Return Value

Type	Description
Object	The clone of the original KIP17 instance.

Example

> const kip17Instance = new caver.klay.KIP17(address)

// Clone without a parameter
> const cloned = kip17Instance.clone()

// Clone with the address of the new token contract
> const cloned = kip17Instance.clone('0x{address in hex}')

kip17Instance.supportsInterface

kip17Instance.supportsInterface(interfaceId)

Returns true if this contract implements the interface defined by interfaceId.

Parameters

Name	Type	Description
interfaceId	String	The interfaceId to be checked.

Return Value

Promise returns Boolean: true if this contract implements the interface defined by interfaceId.

Example

> kip17Instance.supportsInterface('0x80ac58cd').then(console.log)
true

> kip17Instance.supportsInterface('0xa22cb465').then(console.log)
false

kip17Instance.name

kip17Instance.name()

Returns the name of the token.

Parameters

None

Return Value

Promise returns String: The name of the token.

Example

> kip17Instance.name().then(console.log)
Jasmine

kip17Instance.symbol

kip17Instance.symbol()

Returns the symbol of the token.

Parameters

None

Return Value

Promise returns String: The symbol of the token.

Example

> kip17Instance.symbol().then(console.log)
JAS

kip17Instance.totalSupply

kip17Instance.totalSupply()

Returns the total number of tokens minted by the contract.

Parameters

None

Return Value

Promise returns BigNumber: The total number of tokens.

Example

> kip17Instance.totalSupply().then(console.log)
10

kip17Instance.tokenURI

kip17Instance.tokenURI(tokenId)

Returns the URI for a given token id.

Parameters

Name	Type	Description
tokenId	BigNumber | String | Number	The id of the token.

NOTE The tokenId 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 String: The URI of the given token.

Example

> kip17Instance.tokenURI(0).then(console.log)
https://kip17.example/uri-ex-caver.json

kip17Instance.tokenOfOwnerByIndex

kip17Instance.tokenOfOwnerByIndex(owner, index)

Searches the owner's token list for the given index, and returns the token id of a token positioned at the matched index in the list if there is a match.

Parameters

Name	Type	Description
owner	String	The address of the account who owns tokens.
index	BigNumber | String | Number	The index of a token in owner's token list.

NOTE The index 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 id of the token.

Example

> kip17Instance.tokenOfOwnerByIndex('0x{address in hex}', 5).then(console.log)
5

kip17Instance.tokenByIndex

kip17Instance.tokenByIndex(index)

Searches the list of all tokens in this contract for the given index, and returns the token id of a token positioned at the matched index in the list if there is a match. It reverts if the index is greater or equal to the total number of tokens.

Parameters

Name	Type	Description
index	BigNumber | String | Number	The index of a token to be queried.

NOTE The index 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 id of the token.

Example

> kip17Instance.tokenByIndex(1).then(console.log)
1

kip17Instance.balanceOf

kip17Instance.balanceOf(address)

Returns the balance of the given account address. The balance of an account in KIP-17 is the total number of NFTs (Non-Fungible Tokens) owned by the account.

Parameters

Name	Type	Description
address	String	The address of the account to be checked for its balance.

Return Value

Promise returns BigNumber: The account balance.

Example

> kip17Instance.balanceOf('0x{address in hex}').then(console.log)
9

kip17Instance.ownerOf

kip17Instance.ownerOf(tokenId)

Returns the address of the owner of the specified token id.

Parameters

Name	Type	Description
tokenId	BigNumber | String | Number	The id of the token.

NOTE The tokenId 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 String: The address of the account that owns the given token.

Example

> kip17Instance.ownerOf(8).then(console.log)
0x0e0E95426343d97CC7BB913C7D7DBea065A31814

kip17Instance.getApproved

kip17Instance.getApproved(tokenId)

Returns the address who was permitted to transfer this token, or 'zero' address, if no address was approved. It reverts if the given token id does not exist.

Parameters

Name	Type	Description
tokenId	BigNumber | String | Number	The id of the token.

NOTE The tokenId 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 String: The address of the account that has the right to transfer the given token.

Example

// If an approved address exists
> kip17Instance.getApproved(10).then(console.log)
0x23D8E9cae17b22d3DAC65b4F7D2C737C6A7b865d

// If no approved address exists
> kip17Instance.getApproved(3).then(console.log)
0x0000000000000000000000000000000000000000

kip17Instance.isApprovedForAll

kip17Instance.isApprovedForAll(owner, operator)

Returns true if an operator is approved to transfer all tokens that belong to the owner.

Parameters

Name	Type	Description
owner	String	The address of an account that owns tokens and has allowed the operator to send all its tokens.
operator	String	The address of the account approved to send owner's all tokens in place of the owner.

Return Value

Promise returns Boolean: true if an operator is approved to send all tokens that belong to the owner.

Example

> kip17Instance.isApprovedForAll('0x{address in hex}', '0x{address in hex}').then(console.log)
false

> kip17Instance.isApprovedForAll('0x{address in hex}', '0x{address in hex}').then(console.log)
true

kip17Instance.isMinter

kip17Instance.isMinter(address)

Returns true if the given account is a minter who can issue new tokens in the current contract conforming to KIP-17.

Parameters

Name	Type	Description
address	String	The address of the account to be checked for having the minting right.

Return Value

Promise returns Boolean: true if the account is a minter.

Example

> kip17Instance.isMinter('0x{address in hex}').then(console.log)
true

> kip17Instance.isMinter('0x{address in hex}').then(console.log)
false

kip17Instance.paused

kip17Instance.paused()

Returns true if the contract is paused, and false otherwise.

Parameters

None

Return Value

Promise returns Boolean: true if the contract is paused.

Example

> kip17Instance.paused().then(console.log)
true

> kip17Instance.paused().then(console.log)
false

kip17Instance.isPauser

kip17Instance.isPauser(address)

Returns true if the given account is a pauser who can suspend transferring tokens.

Parameters

Name	Type	Description
address	String	The address of the account to be checked for having the right to suspend transferring tokens.

Return Value

Promise returns Boolean: true if the account is a pauser.

Example

> kip17Instance.isPauser('0x{address in hex}').then(console.log)
true

> kip17Instance.isPauser('0x{address in hex}').then(console.log)
false

kip17Instance.approve

kip17Instance.approve(to, tokenId [, sendParam])

Approves another address to transfer a token of the given token id. The zero address indicates there is no approved address. There can only be one approved address per token. This method is allowed to call only by the token owner or an approved operator.

Note that this method will submit a transaction to the Klaytn network, which will charge the transaction fee to the sender.

Parameters

Name	Type	Description
to	String	The address of the account who spends tokens in place of the owner.
tokenId	BigNumber | String | Number	The id of the token the spender is allowed to use.
sendParam	Object	(optional) An object with defined parameters for sending a transaction.

NOTE The tokenId 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 can contain the following:

Name	Type	Description
from	String	(optional) The address from which the transaction should be sent. If omitted, it will be set by this.options.from. If neither of from in sendParam object nor this.options.from were not provided, an error would occur.
gas	Number | String	(optional) The maximum gas provided for this transaction (gas limit). If omitted, it will be set by caver-js via calling this.methods.approve(spender, tokenId).estimateGas({from}).
gasPrice	Number | String	(optional) The gas price in peb to use for this transaction. If omitted, it will be set by caver-js via calling caver.klay.getGasPrice.
value	Number | String | BN | BigNumber	(optional) The value to be transferred in peb.

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 KIP-17 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.

Example

// Send via a sendParam object with the from field given 
> kip17Instance.approve('0x{address in hex}', 10, { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x3875c3f3120c1773c3adeb97260808c8a385bf8427bc203d10cbc5d262f67dbc',
    blockNumber: 2650,
    contractAddress: null,
    from: '0x1147c04b90d1546d76983e19937ad2cdae8b8afd',
    ...
    status: true,
    to: '0x5e0e6f1f0bdf9a263e1b1bb6e9759ba182982377',
    ...
    events: {
        Approval: {
            address: '0x5E0e6F1F0bDf9A263e1B1bB6e9759Ba182982377',
            blockNumber: 2650,
            transactionHash: '0x0ae92570560d64fa103c8be1861c8625d34ac560066398d9ad0d389ad5f7e441',
            transactionIndex: 0,
            blockHash: '0x3875c3f3120c1773c3adeb97260808c8a385bf8427bc203d10cbc5d262f67dbc',
            logIndex: 0,
            id: 'log_55296c9d',
            returnValues: {
                '0': '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
                '1': '0x58746F9D739bC81713E5F5512529876F508a6166',
                '2': '2',
                owner: '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
                approved: '0x58746F9D739bC81713E5F5512529876F508a6166',
                tokenId: '2',
            },
            event: 'Approval',
            signature: '0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925',
            raw: {
                data: '0x',
                topics: [ '0x8c5be...', '0x00...afd', '0x00...166', '0x00...002' ],
            },
        },
    },
}

// Using kip17Instance.options.from
// If the value of kip17Instance.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 kip17Instance instance.
> kip17Instance.options.from = '0x{address in hex}'
> kip17Instance.approve('0x{address in hex}', 10).then(console.log)

kip17Instance.setApprovalForAll

kip17Instance.setApprovalForAll(to, approved [, sendParam])

Approves the given operator to, or disallow the given operator, to transfer all tokens of the owner.

Note that the setApprovalForAll method will submit a transaction to the Klaytn network, which will charge the transaction fee to the sender.

Parameters

Name	Type	Description
to	String	The address of an account to be approved/prohibited to transfer the owner's all tokens.
approved	Boolean	This operator will be approved if true. The operator will be disallowed if false.
sendParam	Object

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 KIP-17 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.

Example

// Send via a sendParam object with the from field given 
> kip17Instance.setApprovalForAll('0x{address in hex}', false, { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x34379ac5b71f16f41d5171d021ca2945e02c60d9fb7f85fc0127262c2ce72b47',
    blockNumber: 3340,
    contractAddress: null,
    from: '0x1147c04b90d1546d76983e19937ad2cdae8b8afd',
    ...
    status: true,
    to: '0x1f15b1a4da5437b29bfb7f248b5e344e6b16b654',
    ...
    events: {
        ApprovalForAll: {
            address: '0x1f15B1A4DA5437b29BfB7f248B5e344E6b16b654',
            blockNumber: 3340,
            transactionHash: '0x72fdf23482b9cf164638e6cbdfdf56541a6189c88639e21f076a8a50ef749a50',
            transactionIndex: 0,
            blockHash: '0x34379ac5b71f16f41d5171d021ca2945e02c60d9fb7f85fc0127262c2ce72b47',
            logIndex: 0,
            id: 'log_1069ad22',
            returnValues: {
                '0': '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
                '1': '0x399bE7034F26feFB5AE683e488903B8bE5ad38b8',
                '2': false,
                owner: '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
                operator: '0x399bE7034F26feFB5AE683e488903B8bE5ad38b8',
                approved: false,
            },
            event: 'ApprovalForAll',
            signature: '0x17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c31',
            raw: {
                data: '0x0000000000000000000000000000000000000000000000000000000000000000',
                topics: [ '0x17307...', '0x00...afd', '0x00...8b8' ],
            },
        },
    },
}

// Using kip17Instance.options.from
// If the value of kip17Instance.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 kip17Instance instance.
> kip17Instance.options.from = '0x{address in hex}'
> kip17Instance.setApprovalForAll('0x{address in hex}', true).then(console.log)

kip17Instance.transferFrom

kip17Instance.transferFrom(from, to, tokenId [, sendParam])

Transfers the token of the given token id tokenId from the token owner's balance to another address. The address who was approved to send the token owner's token (the operator) or the token owner itself is expected to execute this token transferring transaction. Thus, the approved one or 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. It is recommended to use safeTransferFrom whenever possible instead of this method.

Note that sending this transaction will charge the transaction fee to the transaction sender.

Parameters

Name	Type	Description
from	String	The address of the owner or the approved operator of the given token.
to	String	The address of the account to receive the token.
tokenId	BigNumber | String | Number	The id of the token you want to transfer.
sendParam	Object

NOTE The tokenId 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 KIP-17 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.

Example

// Send via a sendParam object with the from field given 
> kip17Instance.transferFrom('0x{address in hex}', '0x{address in hex}', 2, { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x9cae3aa93d327804f333674a77d5d01d8c7908c49749b0d747b6391faa232b58',
    blockNumber: 3592,
    contractAddress: null,
    from: '0x9c4fc0ab840914a29c7deb5cc5c625a4cec3a9cd',
    ...
    status: true,
    to: '0x6e611498570bbc8cb127899c4d24e156ec72473a',
    ...
    events: {
        Transfer: {
            address: '0x6e611498570bBc8cb127899C4D24e156ec72473a',
            blockNumber: 3592,
            transactionHash: '0x386af961e5acda2c5bd58ec71ee52f579dc2b07a2e5ec97678453f04cc1b709a',
            transactionIndex: 0,
            blockHash: '0x9cae3aa93d327804f333674a77d5d01d8c7908c49749b0d747b6391faa232b58',
            logIndex: 0,
            id: 'log_c2ba5874',
            returnValues: {
                '0': '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
                '1': '0x045796ABC035001CF50274FcA8A2614Abf5dd6bf',
                '2': '2',
                from: '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
                to: '0x045796ABC035001CF50274FcA8A2614Abf5dd6bf',
                tokenId: '2',
            },
            event: 'Transfer',
            signature: '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
            raw: {
                data: '0x',
                topics: [ '0xddf25...', '0x00...afd', '0x00...6bf', '0x00...002' ],
            },
        },
    },
}

// Using kip17Instance.options.from
// If the value of kip17Instance.options.from is set, this value is used as the default value 
// unless you specify `from` in sendParam object when sending a transaction with a kip17Instance instance.
> kip17Instance.options.from = '0x{address in hex}'
> kip17Instance.transferFrom('0x{address in hex}', '0x{address in hex}', 2).then(console.log)

kip17Instance.safeTransferFrom

kip17Instance.safeTransferFrom(from, to, tokenId [, data] [, sendParam])

Safely transfers the token of the given token id tokenId from the token owner's balance to another address. The address who was approved to send the token owner's token (the operator) or the token owner itself is expected to execute this token transferring transaction. Thus, the approved one or 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 to is a contract address, it must implement IKIP17Receiver.onKIP17Received. otherwise, the transfer is reverted.

Note that sending this transaction will charge the transaction fee to the transaction sender.

Parameters

Name	Type	Description
from	String	The address of the owner or the approved operator of the given token.
to	String	The address of the account to receive the token.
tokenId	BigNumber | String | Number	The id of the token you want to transfer.
data	Buffer | String | Number	(optional) The optional data to send along with the call.
sendParam	Object

NOTE The tokenId 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 KIP-17 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)
> kip17Instance.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 9, { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x14c5bebc2be86081d8375ba11edba0e541be1df24c1beced1a9e82e3083a8035',
    blockNumber: 6260,
    contractAddress: null,
    from: '0x80b88b47361cec0baee1947868fc872b784cf91e',
    ...
    status: true,
    to: '0xa9066e2b62483bcdf6358874cb87f9e0046e8ad3',
    ...
    events: {
        Transfer: {
            address: '0xA9066e2B62483bcdf6358874CB87f9e0046E8ad3',
            blockNumber: 6260,
            transactionHash: '0x0a92436289e70018f9ebef0df5d3ce87874afd8e5058fcc08fefc6de3e0e9b36',
            transactionIndex: 0,
            blockHash: '0x14c5bebc2be86081d8375ba11edba0e541be1df24c1beced1a9e82e3083a8035',
            logIndex: 0,
            id: 'log_c9c17595',
            returnValues: {
                '0': '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
                '1': '0x0F47Ea1A10B8F7D61c894E392EfaC990A314d313',
                '2': '9',
                from: '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
                to: '0x0F47Ea1A10B8F7D61c894E392EfaC990A314d313',
                tokenId: '9',
            },
            event: 'Transfer',
            signature: '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
            raw: {
                data: '0x',
                topics: [ '0xddf25...', '0x00...afd', '0x00...313', '0x00...009' ],
            },
        },
    },
}

// Send via a sendParam object with the from field given (with data)
> kip17Instance.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 11, '0x1234', { from: '0x{address in hex}' }).then(console.log)

// Using kip17Instance.options.from
// If the value of kip17Instance.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 kip17Instance instance.
> kip17Instance.options.from = '0x{address in hex}'
> kip17Instance.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 11).then(console.log)

kip17Instance.addMinter

kip17Instance.addMinter(account [, sendParam])

Adds an account as a minter, who are permitted to mint tokens.

Note that the addMinter method will submit a transaction to the Klaytn network, which will charge the transaction fee to the sender.

Parameters

Name	Type	Description
account	String	The address of the account to be added as a minter.
sendParam	Object

NOTE If sendParam.from or KIP17Instance.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 KIP-17 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.

Example

// Send via a sendParam object with the from field given 
> kip17Instance.addMinter('0x{address in hex}', { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0xecd0fb45a32323d5cb14558d1d9299393022d5e7284519598dbd8b14c4c55930',
    blockNumber: 8307,
    contractAddress: null,
    from: '0x1147c04b90d1546d76983e19937ad2cdae8b8afd',
    ...
    status: true,
    to: '0x1595b5c1027ed36dcb32e4d39766b896d5b97ecb',
    ...
    events: {
        MinterAdded: {
            address: '0x1595b5c1027ed36dCB32e4D39766b896d5B97ecb',
            blockNumber: 8307,
            transactionHash: '0xf8da21958c84aa3ed8bfa5eea0649c5b9a895efa8c7a715196e000bef4f0b8bd',
            transactionIndex: 0,
            blockHash: '0xecd0fb45a32323d5cb14558d1d9299393022d5e7284519598dbd8b14c4c55930',
            logIndex: 0,
            id: 'log_f40a92bf',
            returnValues: {
                '0': '0x90170C1E7E8C14BBf1124f52980372088BA540Dc',
                account: '0x90170C1E7E8C14BBf1124f52980372088BA540Dc',
            },
            event: 'MinterAdded',
            signature: '0x6ae172837ea30b801fbfcdd4108aa1d5bf8ff775444fd70256b44e6bf3dfc3f6',
            raw: {
                data: '0x',
                topics: [ '0x6ae17...', '0x00...0dc' ],
            },
        },
    },
}

// Using kip17Instance.options.from
// If the value of kip17Instance.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 kip17Instance instance.
> kip17Instance.options.from = '0x{address in hex}'
> kip17Instance.addMinter('0x{address in hex}').then(console.log)

kip17Instance.renounceMinter

kip17Instance.renounceMinter([sendParam])

Renounces the right to mint tokens. Only a minter address can renounce the minting right.

Note that the renounceMinter method will submit a transaction to the Klaytn network, which will charge the transaction fee to the sender.

Parameters

Name	Type	Description
sendParam	Object

If sendParam.from or KIP17Instance.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 KIP-17 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.

Example

// Send via a sendParam object with the from field given 
> kip17Instance.renounceMinter({ from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0xe130d7ee71a2c55b3cf4e2bce9ea26e7c2cde556c7f8288abac60121b27c26c8',
    blockNumber: 8542,
    contractAddress: null,
    from: '0xb72f5cf2627e6614984d8a9f27ee426b29191831',
    ...
    status: true,
    to: '0xf9d0663fc29c48495f42c0b061cb06df6df76c34',
    ...
    events: {
        MinterRemoved: {
            address: '0xF9D0663fC29c48495F42c0b061cB06Df6DF76c34',
            blockNumber: 8542,
            transactionHash: '0x557a4e7b9fd6577ffdb14c2e1f00c0009a7bbda2294502fa765250632b5b0f99',
            transactionIndex: 0,
            blockHash: '0xe130d7ee71a2c55b3cf4e2bce9ea26e7c2cde556c7f8288abac60121b27c26c8',
            logIndex: 0,
            id: 'log_04b47645',
            returnValues: {
                '0': '0xB72F5cF2627e6614984D8A9F27eE426b29191831',
                account: '0xB72F5cF2627e6614984D8A9F27eE426b29191831',
            },
            event: 'MinterRemoved',
            signature: '0xe94479a9f7e1952cc78f2d6baab678adc1b772d936c6583def489e524cb66692',
            raw: {
                data: '0x',
                topics: [ '0xe9447...', '0x00...831' ],
            },
        },
    },
}

// Using kip17Instance.options.from
// If the value of kip17Instance.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 kip17Instance instance.
> kip17Instance.options.from = '0x{address in hex}'
> kip17Instance.renounceMinter().then(console.log)

kip17Instance.mintWithTokenURI

kip17Instance.mintWithTokenURI(to, tokenId, tokenURI [, sendParam])

Creates a token with the given uri and assigns them to the given account. This method increases the total supply of this token.

Note that the mintWithTokenURI method will submit a transaction to the Klaytn network, which will charge the transaction fee to the sender.

Parameters

Name	Type	Description
to	String	The address of the account to which the minted token will be issued.
tokenId	BigNumber | String | Number	The id of the token to be minted.
tokenURI	String	The uri string of the token to be minted.
sendParam	Object

NOTE The tokenId 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.

NOTE If sendParam.from or KIP17Instance.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 KIP-17 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.

Example

// Send via a sendParam object with the from field given 
> kip17Instance.mintWithTokenURI('0x{address in hex}', 18, tokenURI, { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0xd2473b9853ad33c5fa0a75187e65733614ed4f8c937d06e239768a5ca32d7c7f',
    blockNumber: 9313,
    contractAddress: null,
    from: '0x1147c04b90d1546d76983e19937ad2cdae8b8afd',
    ...
    status: true,
    to: '0x7fbf73709054007f5262692f8faf27dee75ab3a6',
    ...
    events: {
        Transfer: {
            address: '0x7FBf73709054007f5262692f8FaF27dEE75Ab3A6',
            blockNumber: 9313,
            transactionHash: '0x17c2eda25c8a817915e3dd77b4fb4838259e8b49ae1c0d8e369167f715a08e7f',
            transactionIndex: 0,
            blockHash: '0xd2473b9853ad33c5fa0a75187e65733614ed4f8c937d06e239768a5ca32d7c7f',
            logIndex: 0,
            id: 'log_d060e77e',
            returnValues: {
                '0': '0x0000000000000000000000000000000000000000',
                '1': '0x203ad91221290901CFDAC9399aCf664499924744',
                '2': '18',
                from: '0x0000000000000000000000000000000000000000',
                to: '0x203ad91221290901CFDAC9399aCf664499924744',
                tokenId: '18',
            },
            event: 'Transfer',
            signature: '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
            raw: {
                data: '0x',
                topics: [ '0xddf25...', '0x00...000', '0x00...744', '0x00...012' ],
            },
        },
    },
}

// Using kip17Instance.options.from
// If the value of kip17Instance.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 kip17Instance instance.
> kip17Instance.options.from = '0x{address in hex}'
> kip17Instance.mintWithTokenURI('0x{address in hex}', 18, tokenURI).then(console.log)

kip17Instance.burn

kip17Instance.burn(tokenId [, sendParam])

Destroys the token of the given token id. Without sendParam.from nor KIP17Instance.options.from being provided, an error would occur.

Note that the burn method will submit a transaction to the Klaytn network, which will charge the transaction fee to the sender.

Parameters

Name	Type	Description
tokenId	BigNumber | String | Number	The id of the token to be destroyed.
sendParam	Object

NOTE The tokenId 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 KIP-17 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.

Example

// Send via a sendParam object with the from field given 
> kip17Instance.burn(14, { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x09d8ed5582fdd1c39b0f19f14f065659fe275a60856d86a1840535f6df1a2d51',
    blockNumber: 18237,
    contractAddress: null,
    from: '0x1147c04b90d1546d76983e19937ad2cdae8b8afd',
    ...
    status: true,
    to: '0x2032e61c79a951aacef8033adca96fc3b9b747b4',
    ...
    events: {
        Transfer: {
            address: '0x2032e61C79A951AACEf8033AdCa96fC3b9b747b4',
            blockNumber: 18237,
            transactionHash: '0x4e377d8d65c8565c7bc91568bcdcc0fddeb46a02a778725e437f368a8d9c6165',
            transactionIndex: 0,
            blockHash: '0x09d8ed5582fdd1c39b0f19f14f065659fe275a60856d86a1840535f6df1a2d51',
            logIndex: 0,
            id: 'log_5af49695',
            returnValues: {
                '0': '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
                '1': '0x0000000000000000000000000000000000000000',
                '2': '14',
                from: '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
                to: '0x0000000000000000000000000000000000000000',
                tokenId: '14',
            },
            event: 'Transfer',
            signature: '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
            raw: {
                data: '0x',
                topics: [ '0xddf25...', '0x00...afd', '0x00...000', '0x00...00e' ],
            },
        },
    },
}

// Using kip17Instance.options.from
// If the value of kip17Instance.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 kip17Instance instance.
> kip17Instance.options.from = '0x{address in hex}'
> kip17Instance.burn(14).then(console.log)

kip17Instance.pause

kip17Instance.pause([sendParam])

Suspends functions related to sending tokens.

Note that the pause method will submit a transaction to the Klaytn network, which will charge the transaction fee to the sender.

Parameters

Name	Type	Description
sendParam