caver.klay.KIP17

KIP-17 표준을 구현한 스마트 컨트랙트와 상호작용하는 데 사용되는 caver-js 객체입니다.

caver.klay.KIP17은 KIP-17 표준을 구현한 스마트 컨트랙트를 JavaScript 객체 형태로 Klaytn 블록체인에서 손쉽게 다룰 수 있도록 돕습니다.

caver.klay.KIP17는 KIP-17 토큰 컨트랙트를 구현하기 위해 caver.klay.Contract를 상속합니다. caver.klay.KIP17은 caver.klay.Contract와 동일한 속성값들을 가지며, 추가 기능 구현을 위해 메서드를 더 가지고 있습니다. 이 장은 caver.klay.KIP17 메서드들 중 오직 새롭게 추가된 것만을 소개합니다.

caver-js에서 KIP-17을 구현한 예시는 Klaytn Contracts Github Repo에서 확인할 수 있습니다.

KIP-17에 관한 더 자세한 정보는 Klaytn Improvement Proposals를 참조하십시오.

참고 caver.klay.KIP17은 caver-js v1.4.1부터 지원됩니다.

caver.klay.KIP17.deploy

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

KIP-17 토큰 컨트랙트를 Klaytn 블록체인에 배포합니다. caver.klay.KIP17.deploy를 사용해 배포한 컨트랙트는 KIP-17 표준을 따르는 대체 불가 토큰입니다.

성공적으로 배포된 후, 프로미스는 새로운 KIP17 인스턴스를 반환할 것입니다.

파라미터

이름	타입	설명
tokenInfo	Object	Klaytn 블록체인에 KIP-17 토큰 컨트랙트를 배포하는 데 필요한 정보입니다. 자세한 내용은 아래 표를 참조하세요.
deployer	String	KIP-17 토큰 컨트랙트를 배포하는 계정 주소입니다. 이 계정은 반드시 배포를 위해 충분한 KLAY를 가지고 있어야 합니다.

tokenInfo 객체는 다음을 반드시 포함해야 합니다:

이름	타입	설명
name	String	토큰 이름입니다.
symbol	String	토큰 심볼입니다.

리턴값

PromiEvent: 이벤트 이미터와 결합된 프로미스이며 새로운 KIP17 인스턴스를 반환합니다. 추가로 다음 이벤트가 발생할 수 있습니다.

이름	타입	설명
transactionHash	String	트랜잭션이 전송된 직후 및 트랜잭션 해시를 사용할 수 있을 때 발생합니다.
receipt	Object	트랜잭션 영수증을 사용할 수 있을 때 발생합니다. 영수증 객체 속성값들에 관한 자세한 정보는 getTransactionReceipt를 참고하십시오. KIP17 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
error	Error	전송 중 오류가 나타나면 발생합니다.

예시

// 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])

새로운 KIP17 인스턴스를 인스턴스 메서드, 이벤트들과 함께 생성합니다.

파라미터

이름	타입	설명
tokenAddress	String	(선택 사항) KIP-17 토큰 컨트랙트 주소이며 나중에 kip17Instance.options.address = '0x1234..'로 값을 설정할 수 있습니다.

리턴값

타입	설명
Object	인스턴스 메소드와 이벤트들을 갖고 있는 KIP17 인스턴스입니다.

예시

// 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])

현재 KIP17 인스턴스를 복제합니다.

파라미터

이름	타입	설명
tokenAddress	String	(선택 사항) 다른 KIP-17 토큰을 배포했던 스마트 컨트랙트 주소입니다. 미입력시 원본 인스턴스의 컨트랙트 주소로 설정됩니다.

리턴값

타입	설명
Object	원본 KIP17 인스턴스를 복제한 인스턴스입니다.

예시

> 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)

이 컨트랙트가 interfaceId로 정의된 인터페이스를 구현한다면 true를 반환합니다.

파라미터

이름	타입	설명
interfaceId	String	확인할 interfaceId입니다.

리턴값

프로미스는 Boolean을 반환: 이 컨트랙트가 해당 interfaceId를 가진 인터페이스를 구현한다면 true를 반환합니다.

예시

> 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

프로미스는 String을 반환: 토큰의 이름입니다.

Example

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

kip17Instance.symbol

kip17Instance.symbol()

Returns the symbol of the token.

Parameters

None

Return Value

프로미스는 String을 반환: 토큰의 심볼입니다.

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

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

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

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

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

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
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. 생략되면, this.options.from에 의해 지정됩니다. sendParam객체의 from 또는 this.options.from가 주어지지 않으면, 에러가 발생합니다.
gas	Number \	String
gasPrice	Number \	String
value	Number \	String | BN | BigNumber

Return Value

프로미스는 Object를 반환 - 트랜잭션 실행 결과를 담고 있는 영수증입니다. 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	(optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of approve.

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])

주어진 토큰 ID tokenId를 가진 토큰을 토큰 소유자 잔액에서 다른 계정으로 전송합니다. 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. 따라서 토큰을 보내도록 허락받은 계정 또는 토큰 소유자가 이 트랜잭션 발신자이어야 하며, 허락받은 계정의 주소는 반드시 sendParam.from 또는 kip7Instance.options.from에 주어져야 합니다. sendParam.from 또는 kip7Instance.options.from가 주어지지 않는다면 에러가 발생합니다. 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
sendParam	Object	(optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of approve.

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
data	Buffer \	String | Number
sendParam	Object	(optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of approve.

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	(optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of approve.

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	(optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of approve.

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
tokenURI	String	The uri string of the token to be minted.
sendParam	Object	(optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of approve.

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
sendParam	Object	(optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of approve.

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	Object	(optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of approve.

NOTE If sendParam.from or KIP17Instance.options.from were given, it should be a pauser with PauserRole.

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.pause({ from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0xd73c026474b2077a04808ed0ce6713821eaa8afaed476b19d22b28e483747e04',
    blockNumber: 19826,
    contractAddress: null,
    from: '0x1147c04b90d1546d76983e19937ad2cdae8b8afd',
    ...
    status: true,
    to: '0x601c11f396e92436df8d9bbaff3fbfec906b7f67',
    ...
    events: {
        Paused: {
            address: '0x601C11F396E92436Df8d9bBAFf3fbfEc906B7f67',
            blockNumber: 19826,
            transactionHash: '0x549f7786ca5d2c1877be20126fc51c2418194ecaa8cea536d08f72c2f01919d0',
            transactionIndex: 0,
            blockHash: '0xd73c026474b2077a04808ed0ce6713821eaa8afaed476b19d22b28e483747e04',
            logIndex: 0,
            id: 'log_93d26310',
            returnValues: {
                '0': '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
                account: '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
            },
            event: 'Paused',
            signature: '0x62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a258',
            raw: {
                data: '0x0000000000000000000000001147c04b90d1546d76983e19937ad2cdae8b8afd',
                topics: ['0x62e78...'],
            },
        },
    },
}

// 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.pause().then(console.log)

kip17Instance.unpause

kip17Instance.unpause([sendParam])

Resumes the paused contract.

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

Parameters

Name	Type	Description
sendParam	Object	(optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of approve.

NOTE If sendParam.from or KIP17Instance.options.from were given, it should be a pauser with PauserRole.

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.unpause({ from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x6a9fc0c70853e696e687b119ba95971a42d91616a040ec17afe1fd4803f5a6cb',
    blockNumber: 19845,
    contractAddress: null,
    from: '0x1147c04b90d1546d76983e19937ad2cdae8b8afd',
    ...
    status: true,
    to: '0x601c11f396e92436df8d9bbaff3fbfec906b7f67',
    ...
    events: {
        Unpaused: {
            address: '0x601C11F396E92436Df8d9bBAFf3fbfEc906B7f67',
            blockNumber: 19845,
            transactionHash: '0x4f0d2767fc36e5062a34753bc447a2c15b476c304f8e9e013ddf06124db33229',
            transactionIndex: 0,
            blockHash: '0x6a9fc0c70853e696e687b119ba95971a42d91616a040ec17afe1fd4803f5a6cb',
            logIndex: 0,
            id: 'log_364c25d2',
            returnValues: {
                '0': '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
                account: '0x1147c04b90D1546d76983e19937aD2cDAE8b8afD',
            },
            event: 'Unpaused',
            signature: '0x5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa',
            raw: {
                data: '0x0000000000000000000000001147c04b90d1546d76983e19937ad2cdae8b8afd',
                topics: ['0x5db9e...'],
            },
        },
    },
}

// 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.unpause().then(console.log)

kip17Instance.addPauser

kip17Instance.addPauser(account [, sendParam])

Adds an account as a pauser that has the right to suspend the contract.

Note that the addPauser 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 a new pauser.
sendParam	Object	(optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of approve.

NOTE If sendParam.from or KIP17Instance.options.from were given, it should be a pauser with PauserRole.

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.addPauser('0x{address in hex}', { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0xd9f18912c9666a67a2e7445af0abe5140212955b3d35c491e5475d512fdee7d5',
    blockNumber: 20502,
    contractAddress: null,
    from: '0x1147c04b90d1546d76983e19937ad2cdae8b8afd',
    ...
    status: true,
    to: '0x4010afbfbf8d94830b226fc5ff311859af806b90',
    ...
    events: {
        PauserAdded: {
            address: '0x4010afbfbF8d94830b226Fc5ff311859AF806B90',
            blockNumber: 20502,
            transactionHash: '0x5f6fef2df70dcbe67e6d74e201005b618da5d53ac2f85ad31fce39226fd1b70b',
            transactionIndex: 0,
            blockHash: '0xd9f18912c9666a67a2e7445af0abe5140212955b3d35c491e5475d512fdee7d5',
            logIndex: 0,
            id: 'log_bf9f8982',
            returnValues: {
                '0': '0xD050b56bB04Da257D144e6b382318A2B8c58b0B2',
                account: '0xD050b56bB04Da257D144e6b382318A2B8c58b0B2',
            },
            event: 'PauserAdded',
            signature: '0x6719d08c1888103bea251a4ed56406bd0c3e69723c8a1686e017e7bbe159b6f8',
            raw: {
                data: '0x',
                topics: [ '0x6719d...', '0x00...0b2' ],
            },
        },
    },
}

// 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.addPauser('0x{address in hex}').then(console.log)

kip17Instance.renouncePauser

kip17Instance.renouncePauser([sendParam])

Renounces the right to pause the contract. Only a pauser address can renounce its own pausing right.

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

Parameters

Name	Type	Description
sendParam	Object	(optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of approve.

NOTE If sendParam.from or KIP17Instance.options.from were given, it should be a pauser with PauserRole.

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.renouncePauser({ from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x32bb338ca23846478934416d1b1f4152b69a49411d61b316cff8b3a7d62ca91e',
    blockNumber: 20512,
    contractAddress: null,
    from: '0xe04cb220e94e6595427568c954b5d819392813bc',
    ...
    status: true,
    to: '0x4010afbfbf8d94830b226fc5ff311859af806b90',
    ...
    events: {
        PauserRemoved: {
            address: '0x4010afbfbF8d94830b226Fc5ff311859AF806B90',
            blockNumber: 20512,
            transactionHash: '0x72982fa8a8de25c961cd19bd91aa7acf0111feb8e9026e607d89843bcd8f783a',
            transactionIndex: 0,
            blockHash: '0x32bb338ca23846478934416d1b1f4152b69a49411d61b316cff8b3a7d62ca91e',
            logIndex: 0,
            id: 'log_0a9d1350',
            returnValues: {
                '0': '0xE04cB220e94E6595427568c954b5D819392813bC',
                account: '0xE04cB220e94E6595427568c954b5D819392813bC',
            },
            event: 'PauserRemoved',
            signature: '0xcd265ebaf09df2871cc7bd4133404a235ba12eff2041bb89d9c714a2621c7c7e',
            raw: {
                data: '0x',
                topics: [ '0xcd265...', '0x00...3bc' ],
            },
        },
    },
}

// 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.renouncePauser().then(console.log)