caver.klay.KIP17
KIP-17 표준을 구현한 스마트 컨트랙트와 상호작용하는 데 사용되는 caver-js 객체입니다.
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.
caver-js에서 KIP-17을 구현한 예시는 Klaytn Contracts Github Repo에서 확인할 수 있습니다.
For more information about KIP-17, see 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 인스턴스를 반환할 것입니다.
Parameters
이름
타입
설명
tokenInfo
Object
Klaytn 블록체인에 KIP-17 토큰 컨트랙트를 배포하는 데 필요한 정보입니다. 자세한 내용은 아래 표를 참조하세요.
deployer
String
KIP-17 토큰 컨트랙트를 배포하는 계정 주소입니다. 이 계정은 반드시 배포를 위해 충분한 KLAY를 가지고 있어야 합니다.
tokenInfo 객체는 다음을 반드시 포함해야 합니다:
이름
타입
설명
명칭
String
토큰 이름입니다.
기호
String
토큰 심볼입니다.
리턴값
PromiEvent: 이벤트 이미터와 결합된 프로미스이며 새로운 KIP17 인스턴스를 반환합니다. 추가로 다음 이벤트가 발생할 수 있습니다.
이름
타입
설명
transactionHash
String
트랜잭션이 전송된 직후 및 트랜잭션 해시를 사용할 수 있을 때 발생합니다.
receipt
Object
트랜잭션 영수증을 사용할 수 있을 때 발생합니다. If you want to know about the properties inside the receipt object, see getTransactionReceipt. KIP17 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
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 인스턴스를 인스턴스 메소드, 이벤트들과 함께 생성합니다.
Parameters
이름
타입
설명
tokenAddress
String
(optional) The address of the KIP-17 token contract, which can be assigned later through 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 인스턴스를 복제합니다.
Parameters
이름
타입
설명
tokenAddress
String
(optional) The address of the smart contract that deployed another KIP-17 token. 입력을 생략하면, 이 주소는 원본 인스턴스의 컨트랙트 주소로 설정됩니다.
리턴값
타입
설명
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를 반환합니다.
Parameters
이름
타입
설명
interfaceId
String
확인할 interfaceId입니다.
리턴값
프로미스Boolean을 반환: 이 컨트랙트가 해당 interfaceId를 가진 인터페이스를 구현한다면 true를 반환합니다.
예시
> kip17Instance.supportsInterface('0x80ac58cd').then(console.log)
true
> kip17Instance.supportsInterface('0xa22cb465').then(console.log)
false

kip17Instance.name

kip17Instance.name()
토큰 이름을 반환합니다.
Parameters
없음
리턴값
프로미스String을 반환: 토큰의 이름입니다.
예시
> kip17Instance.name().then(console.log)
Jasmine

kip17Instance.symbol

kip17Instance.symbol()
토큰 심볼을 반환합니다.
Parameters
없음
리턴값
프로미스String을 반환: 토큰의 심볼입니다.
예시
> kip17Instance.symbol().then(console.log)
JAS

kip17Instance.totalSupply

kip17Instance.totalSupply()
컨트랙트가 발행한 토큰 총 개수를 반환합니다.
Parameters
없음
리턴값
프로미스BigNumber를 반환: 토큰의 총 수량입니다.
예시
> kip17Instance.totalSupply().then(console.log)
10

kip17Instance.tokenURI

kip17Instance.tokenURI(tokenId)
주어진 토큰 ID에 대한 URI를 반환합니다.
Parameters
이름
타입
설명
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. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
Promise returns String: The URI of the given token.
예시
> kip17Instance.tokenURI(0).then(console.log)
https://kip17.example/uri-ex-caver.json

kip17Instance.tokenOfOwnerByIndex

kip17Instance.tokenOfOwnerByIndex(owner, index)
owner의 토큰 목록에서 주어진 인덱스에 위치한 토큰의 ID를 반환합니다.
Parameters
이름
타입
설명
owner
String
토큰을 소유한 계정 주소입니다.
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. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
프로미스BigNumber를 반환: 토큰의 Id입니다.
예시
> kip17Instance.tokenOfOwnerByIndex('0x{address in hex}', 5).then(console.log)
5

kip17Instance.tokenByIndex

kip17Instance.tokenByIndex(index)
이 컨트랙트에 있는 모든 토큰들의 목록에서 주어진 인덱스에 위치한 토큰의 ID를 반환합니다. 인덱스 값이 토큰의 총 개수보다 크거나 같다면 실행이 거부됩니다.
Parameters
이름
타입
설명
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. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
프로미스BigNumber를 반환: 토큰의 Id입니다.
예시
> kip17Instance.tokenByIndex(1).then(console.log)
1

kip17Instance.balanceOf

kip17Instance.balanceOf(address)
주어진 계정 주소의 잔액을 반환합니다. The balance of an account in KIP-17 is the total number of NFTs (Non-Fungible Tokens) owned by the account.
Parameters
이름
타입
설명
주소
String
잔액을 확인할 계정 주소입니다.
리턴값
프로미스BigNumber를 반환: 계정 잔고입니다.
예시
> kip17Instance.balanceOf('0x{address in hex}').then(console.log)
9

kip17Instance.ownerOf

kip17Instance.ownerOf(tokenId)
특정 토큰 ID를 소유한 계정의 주소를 반환합니다.
Parameters
이름
타입
설명
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. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
Promise returns String: The address of the account that owns the given token.
예시
> kip17Instance.ownerOf(8).then(console.log)
0x0e0E95426343d97CC7BB913C7D7DBea065A31814

kip17Instance.getApproved

kip17Instance.getApproved(tokenId)
이 토큰을 전송할 권한이 있는 계정 주소를 반환합니다. 권한 있는 계정이 없다면 ''zero" 주소를 반환합니다. 주어진 토큰 ID가 존재하지 않으면 실행이 거부됩니다.
Parameters
이름
타입
설명
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. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
Promise returns String: The address of the account that has the right to transfer the given token.
예시
// 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)
operator에게 owner 소유한 모든 토큰을 전송할 권한이 있다면 true를 반환합니다.
Parameters
이름
타입
설명
owner
String
토큰을 소유한 계정 주소입니다. 이 계정은 operator에게 자신의 모든 토큰을 전송하도록 허락한 계정입니다.
operator
String
토큰 소유자를 대신해 토큰 소유자의 모든 토큰을 전송하도록 허락받은 계정 주소입니다.
리턴값
Promise returns Boolean: true if an operator is approved to send all tokens that belong to the owner.
예시
> 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)
주어진 계정이 KIP-17을 준수하는 현재 컨트랙트에서 새 토큰을 발행할 수 있는 발행자라면 true를 반환합니다.
Parameters
이름
타입
설명
주소
String
발행 권한을 가지고 있는지를 확인받을 계정 주소입니다.
리턴값
프로미스Boolean을 반환: 계정이 발행자라면 true를 반환합니다.
예시
> kip17Instance.isMinter('0x{address in hex}').then(console.log)
true
> kip17Instance.isMinter('0x{address in hex}').then(console.log)
false

kip17Instance.paused

kip17Instance.paused()
컨트랙트가 작동을 멈추었다면 true를 반환하고, 그렇지 않으면 false를 반환합니다.
Parameters
없음
리턴값
프로미스Boolean을 반환: 이 컨트랙트가 중지되었다면 true를 반환합니다.
예시
> kip17Instance.paused().then(console.log)
true
> kip17Instance.paused().then(console.log)
false

kip17Instance.isPauser

kip17Instance.isPauser(address)
주어진 계정이 토큰 전송을 멈출 수 있는 pauser라면 true를 반환합니다.
Parameters
이름
타입
설명
주소
String
토큰 전송을 멈출 권한이 있는지를 확인받을 계정 주소입니다.
리턴값
프로미스Boolean을 반환: 이 계정이 중지 권한을 가진 계정이라면 true를 반환합니다.
예시
> 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])
주어진 토큰 ID를 가진 토큰을 다른 계정에게 전송할 권한을 줍니다. "zero" 주소는 전송 권한을 가진 주소가 없음을 의미합니다. 토큰 1개마다 승인된 주소 1개만 있습니다. 이 메서드는 오직 토큰 소유자나 승인된 operator만 호출할 수 있습니다.
이 메서드는 Klaytn 네트워크에 트랜잭션을 전송하며 트랜잭션 수수료가 트랜잭션 발신자에게 부과됨을 참고하시기 바랍니다.
Parameters
이름
타입
설명
to
String
토큰 소유자를 대신해 토큰을 사용하는 계정 주소입니다.
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. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
sendParam 객체는 다음을 포함할 수 있습니다:
이름
타입
설명
from
String
(optional) The address from which the transaction should be sent. 생략되면, this.options.from에 의해 지정됩니다. sendParam객체의 from 또는 this.options.from가 주어지지 않으면, 에러가 발생합니다.
gas
Number \
String
가스 가격
Number \
String
value
Number \
String | BN | BigNumber
리턴값
프로미스Object를 반환 - 트랜잭션 실행 결과를 담고 있는 영수증입니다. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. KIP-17 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
예시
// 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])
주어진 operator to가 토큰 소유자의 모든 토큰을 전송하도록 허락하거나 전송을 금지합니다.
setApprovalForAll 메서드는 Klaytn 네트워크에 트랜잭션을 전송하며 트랜잭션 수수료가 트랜잭션 발신자에게 부과됨을 참고하시기 바랍니다.
Parameters
이름
타입
설명
to
String
토큰 소유자의 모든 토큰을 전송할 권한을 받거나 전송할 권한을 잃게될 계정 주소입니다.
approved
Boolean
true이면 이 operator는 전송할 권한을 받습니다. false이면 이 operator는 전송할 권한을 잃습니다.
sendParam
Object
(optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of approve.
리턴값
프로미스Object를 반환 - 트랜잭션 실행 결과를 담고 있는 영수증입니다. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. KIP-17 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
예시
// 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.
트랜잭션 전송은 트랜잭션 발신자에게 트랜잭션 수수료를 부과함을 유의하십시오.
Parameters
이름
타입
설명
from
String
주어진 토큰 소유자 주소 또는 주어진 토큰을 전송하도록 승인받은 operator 주소입니다.
to
String
토큰을 받을 계정 주소입니다.
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. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
프로미스Object를 반환 - 트랜잭션 실행 결과를 담고 있는 영수증입니다. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. KIP-17 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
예시
// 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])
더 안전한 방법으로 주어진 토큰 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가 주어지지 않는다면 에러가 발생합니다.
If the to is a contract address, it must implement IKIP17Receiver.onKIP17Received. 그렇지 않으면, 전송은 거부됩니다.
트랜잭션 전송은 트랜잭션 발신자에게 트랜잭션 수수료를 부과함을 유의하십시오.
Parameters
이름
타입
설명
from
String
주어진 토큰 소유자 주소 또는 주어진 토큰을 전송하도록 승인받은 operator 주소입니다.
to
String
토큰을 받을 계정 주소입니다.
tokenId
BigNumber \
String | Number
데이터
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. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
프로미스Object를 반환 - 트랜잭션 실행 결과를 담고 있는 영수증입니다. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. KIP-17 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
예시
// 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])
계정을 발행자에 추가합니다. 발행자는 토큰을 발행하도록 허락된 계정입니다.
addMinter 메서드는 Klaytn 네트워크에 트랜잭션을 전송하며 트랜잭션 수수료가 트랜잭션 발신자에게 부과됨을 참고하시기 바랍니다.
Parameters
이름
타입
설명
account
String
발행자에 추가될 계정 주소입니다.
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.
리턴값
프로미스Object를 반환 - 트랜잭션 실행 결과를 담고 있는 영수증입니다. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. KIP-17 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
예시
// 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])
토큰 발행 권한을 포기합니다. 오직 발행자 주소만이 발행 권한을 포기할 수 있습니다.
renounceMinter 메서드는 Klaytn 네트워크에 트랜잭션을 전송하며 트랜잭션 수수료가 트랜잭션 발신자에게 부과됨을 참고하시기 바랍니다.
Parameters
이름
타입
설명
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.
리턴값
프로미스Object를 반환 - 트랜잭션 실행 결과를 담고 있는 영수증입니다. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. KIP-17 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
예시
// 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])
주어진 URI와 토큰 ID로 토큰을 만들고 주어진 계정에 발행합니다. 이 토큰에는 주어진 URI값이 저장됩니다. 이 메서드는 이 토큰의 총 발행량을 증가시킵니다.
mintWithTokenURI 메서드는 Klaytn 네트워크에 트랜잭션을 전송하며 트랜잭션 수수료가 트랜잭션 발신자에게 부과됨을 참고하시기 바랍니다.
Parameters
이름
타입
설명
to
String
토큰이 발행될 계정 주소입니다.
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