caver.kct.kip37
caver.kct.kip37은 JavaScript의 객체로서 KIP-37을 구현하는 스마트 컨트랙트를 Klaytn 블록체인 플랫폼에서 쉽게 다룰 수 있도록 도와줍니다.
caver.kct.kip37는 KIP-37 토큰 컨트랙트를 구현하기 위해 caver.contract를 상속합니다. caver.kct.kip37caver.contract와 동일한 속성값들을 가지며, 추가 기능 구현을 위한 메서드를 더 가지고 있습니다. 이 장은 caver.kct.kip37 메서드들 중 오직 새롭게 추가된 것만을 소개합니다.
caver-js에서 KIP-37을 구현한 예시는 Klaytn Contracts Github Repo에서 확인할 수 있습니다.
For more information about KIP-37, see Klaytn Improvement Proposals.
참고 caver.kct.kip37는 caver-js v1.5.7부터 지원됩니다.

caver.kct.kip37.deploy

caver.kct.kip37.deploy(tokenInfo, deployer)
KIP-37 토큰 컨트랙트를 Klaytn 블록체인에 배포합니다. caver.kct.kip37.deploy를 사용해 배포한 컨트랙트는 KIP-37 표준을 따르는 멀티 토큰입니다.
성공적으로 배포된 후, 프로미스는 새로운 KIP37 인스턴스를 반환할 것입니다.
Parameters
이름
타입
설명
tokenInfo
객체
Klaytn 블록체인에 KIP-37 토큰 컨트랙트를 배포하는 데 필요한 정보입니다. 자세한 내용은 아래 표를 참조하세요.
deployer
string | object
KIP-37 토큰 컨트랙트를 배포할 keyring 인스턴스의 계정 주소입니다. 이 주소는 반드시 배포를 위해 충분한 KLAY를 가지고 있어야 합니다. 자세한 내용은 Keyring을 참조하세요. 트랜잭션 전송 시 사용할 필드를 자체적으로 정의하고 싶다면 객체 타입을 매개변수로 전달하면 됩니다. KIP-37 컨트랙트 배포 시 수수료 위임을 이용하고 싶다면, 객체 내 수수료 위임과 관련된 필드를 정의할 수 있습니다. 객체에 정의될 수 있는 필드에 대해서는 create의 매개변수 설명을 참고하십시오.
tokenInfo 객체는 다음을 반드시 포함해야 합니다:
이름
타입
설명
uri
string
The URI for all token types, by relying on the token type ID substitution mechanism.
리턴값
PromiEvent: 이벤트 이미터와 결합된 프로미스이며 새로운 KIP37 인스턴스를 반환합니다. 추가로 다음 이벤트가 발생할 수 있습니다.
이름
타입
설명
transactionHash
string
트랜잭션이 전송된 직후 및 트랜잭션 해시를 사용할 수 있을 때 발생합니다.
receipt
객체
트랜잭션 영수증을 사용할 수 있을 때 발생합니다. 영수증 객체 속성값들에 관한 자세한 정보는 getTransactionReceipt를 참고하십시오. KIP37 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
error
에러
전송 중 오류가 나타나면 발생됩니다.
예시
// 프로미스 사용
> caver.kct.kip37.deploy({
uri: 'https://caver.example/{id}.json',
}, '0x{address in hex}').then(console.log)
KIP37 {
...
_address: '0x7314B733723AA4a91879b15a6FEdd8962F413CB2',
_jsonInterface: [
...
{
anonymous: false,
inputs: [{ indexed: false, name: 'value', type: 'string' }, { indexed: true, name: 'id', type: 'uint256' }],
name: 'URI',
type: 'event',
signature: '0x6bb7ff708619ba0610cba295a58592e0451dee2622938c8755667688daf3529b',
}
]
}
// 두 번째 파라미터로 객체 전달
> caver.kct.kip37.deploy({
uri: 'https://caver.example/{id}.json',
},
{
from: '0x{address in hex}',
feeDelegation: true,
feePayer: '0x{address in hex}',
}).then(console.log)
// 이벤트 이미터와 프로미스 사용
> caver.kct.kip37.deploy({
uri: 'https://caver.example/{id}.json',
}, '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(newKIP37Instance) {
console.log(newKIP37Instance.options.address) // instance with the new token contract address
})

caver.kct.kip37.detectInterface

caver.kct.kip37.detectInterface(contractAddress)
토큰 컨트랙트에 의해 구현된 인터페이스 정보를 반환합니다. 이 정적 함수는 kip37.detectInterface를 사용합니다.
Parameters
이름
타입
설명
contractAddress
string
KIP-37 토큰 컨트랙트의 주소입니다.
리턴값
Promise returns an object containing the result with boolean values whether each KIP-37 interface is implemented.
예시
> caver.kct.kip37.detectInterface('0x{address in hex}').then(console.log)
{
IKIP37: true,
IKIP37Metadata: true,
IKIP37Mintable: true,
IKIP37Burnable: true,
IKIP37Pausable: true,
}

caver.kct.kip37.create

caver.kct.kip37.create([tokenAddress])
새로운 KIP37 인스턴스를 인스턴스 메소드, 이벤트들과 함께 생성합니다. 이 함수는 new KIP37과 동일하게 작동합니다.
참고 caver.kct.kip37.create는 caver-js v1.6.1부터 지원됩니다.
Parameters
new KIP37을 참고하세요.
리턴값
new KIP37을 참고하세요.
예시
// 매개변수 없는 KIP17 인스턴스 생성
> const kip17 = caver.kct.kip37.create()
// 토큰 주소를 가진 KIP37 인스턴스 생성
> const kip17 = caver.kct.kip37.create('0x{address in hex}')

new KIP37

new caver.kct.kip37([tokenAddress])
새로운 KIP37 인스턴스를 인스턴스 메소드, 이벤트들과 함께 생성합니다.
Parameters
이름
타입
설명
tokenAddress
string
(선택 사항) KIP-37 토큰 컨트랙트 주소이며 나중에 kip37.options.address = '0x1234..'로 값을 설정할 수 있습니다.
리턴값
타입
설명
객체
인스턴스 메소드와 이벤트들을 갖고 있는 KIP37 인스턴스입니다.
예시
// 매개변수 없는 KIP37 인스턴스 생성
> const kip37 = new caver.kct.kip37()
// 토큰 주소를 가진 KIP37 인스턴스 생성
> const kip37 = new caver.kct.kip37('0x{address in hex}')

kip37.clone

kip37.clone([tokenAddress])
현재 KIP37 인스턴스를 복제합니다.
Parameters
이름
타입
설명
tokenAddress
string
(선택 사항) 다른 KIP37 토큰을 배포했던 스마트 컨트랙트 주소입니다. 입력을 생략하면, 이 주소는 원본 인스턴스의 컨트랙트 주소로 설정됩니다.
리턴값
타입
설명
객체
원본 KIP37 인스턴스를 복제한 인스턴스입니다.
예시
> const kip37 = new caver.kct.kip37(address)
// 매개변수 없이 클론
> const cloned = kip37.clone()
// 새 토큰 컨트랙트 주소와 함께 클론
> const cloned = kip37.clone('0x{address in hex}')

kip37.detectInterface

kip37.detectInterface()
토큰 컨트랙트에 의해 구현된 인터페이스 정보를 반환합니다.
Parameters
없음
리턴값
Promise returns an object containing the result with boolean values whether each KIP-37 interface is implemented.
예시
> kip37.detectInterface().then(console.log)
{
IKIP37: true,
IKIP37Metadata: true,
IKIP37Mintable: true,
IKIP37Burnable: true,
IKIP37Pausable: true,
}

kip37.supportsInterface

kip37.supportsInterface(interfaceId)
이 컨트랙트가 interfaceId로 정의된 인터페이스를 구현한다면 true를 반환합니다.
Parameters
이름
타입
설명
interfaceId
string
확인할 interfaceId입니다.
리턴값
프로미스Boolean을 반환: 이 컨트랙트가 해당 interfaceId를 가진 인터페이스를 구현한다면 true를 반환합니다.
예시
> kip37.supportsInterface('0x6433ca1f').then(console.log)
true
> kip37.supportsInterface('0x3a2820fe').then(console.log)
false

kip37.uri

kip37.uri(id)
주어진 토큰의 고유한 Uniform Resource Identifier (URI)를 반환합니다.
어느 URI에 문자열 "{id}"가 포함된다면, 이 함수는 16진수 형식의 실제 토큰 ID로 이를 대체합니다. Please refer to KIP-34 Metadata.
Parameters
이름
타입
설명
id
BigNumber | string | number
URI를 받을 토큰 ID입니다.
참고 id 파라미터는 number 타입 값을 받지만, 입력된 값이 number.MAX_SAFE_INTEGER 범위를 초과하면 예상치 못한 결과 또는 에러를 일으킬 수 있습니다. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
Promisestring을 반환: 토큰의 URI입니다.
예시
> kip37.uri('0x0').then(console.log)
'https://caver.example/0000000000000000000000000000000000000000000000000000000000000000.json'

kip37.totalSupply

kip37.totalSupply(id)
특정 토큰의 총 발행량을 반환합니다.
Parameters
이름
타입
설명
id
BigNumber | string | number
총 발행량을 확인할 토큰의 ID입니다.
참고 id 파라미터는 number 타입 값을 받지만, 입력된 값이 number.MAX_SAFE_INTEGER 범위를 초과하면 예상치 못한 결과 또는 에러를 일으킬 수 있습니다. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
프로미스BigNumber를 반환: 토큰의 총 수량입니다.
예시
> kip37.totalSupply(0).then(console.log)
10000000000

kip37.balanceOf

kip37.balanceOf(account, id)
account가 소유한, 타입 id의 토큰 수량을 반환합니다.
Parameters
이름
타입
설명
account
string
잔액을 확인할 계정 주소입니다.
id
BigNumber | string | number
잔액을 확인할 토큰의 ID입니다.
참고 id 파라미터는 number 타입 값을 받지만, 입력된 값이 number.MAX_SAFE_INTEGER 범위를 초과하면 예상치 못한 결과 또는 에러를 일으킬 수 있습니다. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
PromiseBigNumber를 반환: 계정이 지닌 토큰의 양입니다.
예시
> kip37.balanceOf('0x{address in hex}', 0).then(console.log)
20

kip37.balanceOfBatch

kip37.balanceOfBatch(accounts, ids)
다수의 계정/토큰쌍의 잔액을 반환합니다. balanceOfBatchbalanceOf의 배치 작업으로, accountsids의 배열 길이는 동일해야 합니다.
Parameters
이름
타입
설명
accounts
Array
잔액을 확인할 계정 주소입니다.
ids
Array
잔액을 확인할 토큰 ID의 배열입니다.
리턴값
PromiseArray를 반환: 다수의 계정/토큰쌍 잔액입니다.
예시
> kip37.balanceOfBatch(['0x{address in hex}', '0x{address in hex}'], [0, 1]).then(console.log)
[ 20, 30 ]

kip37.isMinter

kip37.isMinter(address)
주어진 계정이 새 KIP-37 토큰을 발행할 수 있는 발행자라면 true를 반환합니다.
Parameters
이름
타입
설명
주소
string
발행 권한을 가지고 있는지를 확인받을 계정 주소입니다.
리턴값
프로미스Boolean을 반환: 계정이 발행자라면 true를 반환합니다.
예시
kip37.isMinter(address)

kip37.isPauser

kip37.isPauser(address)
주어진 계정이 토큰 전송을 멈출 수 있는 pauser라면 true를 반환합니다.
Parameters
이름
타입
설명
주소
string
토큰 전송을 멈출 권한이 있는지를 확인받을 계정 주소입니다.
리턴값
프로미스Boolean을 반환: 이 계정이 중지 권한을 가진 계정이라면 true를 반환합니다.
예시
> kip37.isPauser('0x{address in hex}').then(console.log)
true
> kip37.isPauser('0x{address in hex}').then(console.log)
false

kip37.paused

kip37.pause()
토큰 컨트랙트의 트랜잭션(또는 특정 토큰)이 중단되었는지 여부를 반환합니다.
id 파라미터가 정의되지 않은 경우, 토큰 컨트랙트 트랜잭션이 중단되었는지 여부를 반환합니다. id 파라미터가 정의된 경우, 특정 토큰이 중단되었는지 여부를 반환합니다.
Parameters
이름
타입
설명
id
BigNumber | string | number
(선택 사항) 중단 여부 확인을 위한 토큰 ID입니다. 해당 파라미터 미입력시 paused 함수는 컨트랙트가 중단 상태에 있는지 여부를 반환합니다.
참고 id 파라미터는 number 타입 값을 받지만, 입력된 값이 number.MAX_SAFE_INTEGER 범위를 초과하면 예상치 못한 결과 또는 에러를 일으킬 수 있습니다. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
PromiseBoolean을 반환: 이 컨트랙트가 중지되었다면 true를 반환합니다.
예시
// 토큰 ID 매개변수 없이
> kip37.paused().then(console.log)
true
> kip37.paused().then(console.log)
false
// 토큰 ID 매개변수와 함께
> kip37.paused(0).then(console.log)
true
> kip37.paused(1).then(console.log)
false

kip37.isApprovedForAll

kip37.isApprovedForAll(owner, operator)
특정 소유자에 대한 operator의 승인 상태를 조회합니다. 특정 소유자가 operator를 승인했을 시 true를 반환합니다.
Parameters
이름
타입
설명
owner
string
소유자의 주소입니다.
operator
string
Operator의 주소입니다.
리턴값
Promiseboolean을 반환: Operator가 승인되었을 시 true, 그렇지 않다면 false를 반환합니다.
예시
> kip37.isApprovedForAll('0x{address in hex}', '0x{address in hex}').then(console.log)
true
> kip37.isApprovedForAll('0x{address in hex}', '0x{address in hex}').then(console.log)
false

kip37.create

kip37.create(id, initialSupply [, uri] [, sendParam])
새로운 토큰 타입을 생성하며, 발행자에게 initialSupply를 할당합니다.
이 메서드는 Klaytn 네트워크에 트랜잭션을 전송하며 트랜잭션 수수료가 트랜잭션 발신자에게 부과됨을 참고하시기 바랍니다.
Parameters
이름
타입
설명
id
BigNumber | string | number
생성할 토큰 ID입니다.
initialSupply
BigNumber | string | number
발행할 토큰의 양입니다.
uri
string
(선택 사항) 생성된 토큰의 URI입니다.
sendParam
객체
(선택 사항) 트랜잭션을 보내는 데 필요한 파라미터들을 가지고 있는 객체입니다.
참고 initialSupply 파라미터는 Number 타입 값을 받지만, 입력된 값이 number.MAX_SAFE_INTEGER 범위를 초과하면 예상치 못한 결과 또는 에러를 일으킬 수 있습니다. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
sendParam 객체는 다음을 포함합니다:
이름
타입
설명
from
string
(선택 사항) 트랜잭션 발신자 주소입니다. 미입력시 kip37.options.from에 의해 지정됩니다. sendParam객체의 from 또는 kip37.options.from가 주어지지 않으면 오류가 발생합니다.
gas
number | string
(선택 사항) 이 트랜잭션이 쓸 수 있는 최대 가스량 (가스 제한) 입니다. 미입력시 caver-js가 kip37.methods.approve(spender, amount).estimateGas({from})를 호출하여 이 값을 지정합니다.
가스 가격
number | string
(선택 사항) 이 트랜잭션에 사용할 peb 단위의 가스 가격. 생략하면 caver.klay.getGasPrice 값으로 caver-js가 설정합니다.
value
number | string | BN | BigNumber
(선택 사항) peb으로 환산한 전송될 토큰 가치.
feeDelegation
boolean
(optional, default false) 수수료 위임 트랜잭션 사용 여부를 나타냅니다. 미입력시 kip37.options.feeDelegation를 사용합니다. 둘 다 미입력시 수수료 위임은 사용되지 않습니다.
feePayer
string
(선택 사항) 트랜잭션 수수료를 부담하는 수수료 납부자의 주소입니다. feeDelegationtrue일 때, 값은 트랜잭션의 feePayer 필드에 설정됩니다. 미입력시 kip37.options.feePayer를 사용합니다. 둘 다 미입력시 오류를 반환합니다.
feeRatio
string
(optional) Fee payer가 부담하게될 트랜잭션 수수료의 비율입니다. feeDelegationtrue이며, feeRatio가 유효한 값으로 설정되었을 경우, 부분 수수료 위임 트랜잭션이 사용됩니다. 유효한 범위는 1에서 99 사이입니다. 0이나 100 이상의 값은 허용되지 않습니다. 미입력시 kip37.options.feeRatio를 사용합니다.
참고 feeDelegation, feePayer, 그리고 feeRatio는 caver-js v1.6.1 이후부터 지원됩니다.
리턴값
프로미스Object를 반환 - 트랜잭션 실행 결과를 담고 있는 영수증입니다. 영수증 객체 속성값에 대한 자세한 정보는 getTransactionReceipt를 참고하세요. KIP37 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
예시
// 주어진 필드에서 sendParam 객체를 통해 전송
> kip37.create(2, '1000000000000000000', { from: '0x{address in hex}' }).then(console.log)
{
blockHash: '0xf1cefd8efbde83595742dc88308143dde50e7bee39a3a0cfea92ed5df3529d61',
blocknumber: 2823,
contractAddress: null,
from: '0xfb8789cd544881f820fbff1728ba7c240a539f48',
...
status: true,
to: '0x394091d163ebdebcae876cb96cf0e0984c28a1e9',
...
events: {
TransferSingle: {
address: '0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9',
blockNumber: 2823,
transactionHash: '0xee8cdaa0089681d90a52c1539e75c6e26b3eb67affd4fbf70033ba010a3f0d26',
transactionIndex: 0,
blockHash: '0xf1cefd8efbde83595742dc88308143dde50e7bee39a3a0cfea92ed5df3529d61',
logIndex: 0,
id: 'log_ca64e74b',
returnValues: {
'0': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
'1': '0x0000000000000000000000000000000000000000',
'2': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
'3': '2',
'4': '1000000000000000000',
operator: '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
from: '0x0000000000000000000000000000000000000000',
to: '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
id: '2',
value: '1000000000000000000',
},
event: 'TransferSingle',
signature: '0xc3d58168c5ae7397731d063d5bbf3d657854427343f4c083240f7aacaa2d0f62',
raw: {
data: '0x...40000',
topics: [ '0xc3d58...', '0x00...f48', '0x00...000', '0x00...f48' ],
},
},
},
}
// 스마트 컨트랙트 실행을 위해 수수료 대납 트랜잭션 사용
> kip37.create(2, '1000000000000000000', {
from: '0x{address in hex}'
feeDelegation: true,
feePayer: '0x{address in hex}'
}).then(console.log)
// kip37.options.from 사용
// kip37 인스턴스로 트랜잭션을 보낼 때 만약 kip37.options.from 값이 정해져 있는 경우
// sendParam 객체에 `from`를 명시하지 않는 이상 kip37 인스턴스로 트랜잭션을 보낼 때 그 값을 사용
> kip37.options.from = '0x{address in hex}'
> kip37.create(2, '1000000000000000000').then(console.log)

kip37.setApprovalForAll

kip37.setApprovalForAll(operator, approved [, sendParam])
주어진 operator가 소유자의 모든 토큰을 전송하도록 승인하거나 금지합니다.
이 메서드는 Klaytn 네트워크에 트랜잭션을 전송하며 트랜잭션 수수료가 트랜잭션 발신자에게 부과됨을 참고하시기 바랍니다.
Parameters
이름
타입
설명
operator
string
토큰 소유자의 모든 토큰을 전송할 권한을 받거나 전송할 권한을 잃게될 계정 주소입니다.
approved
boolean
true이면 이 operator는 전송할 권한을 받습니다. false이면 이 operator는 전송할 권한을 잃습니다.
sendParam
객체
(선택 사항) 트랜잭션 전송을 위해 사용될 파라미터들이 정의된 객체입니다. sendParam에 관한 자세한 정보는 kip37.create의 파라미터 설명을 참고하십시오.
리턴값
프로미스Object를 반환 - 트랜잭션 실행 결과를 담고 있는 영수증입니다. 영수증 객체 속성값에 대한 자세한 정보는 getTransactionReceipt를 참고하세요. KIP37 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
예시
// 주어진 필드에서 sendParam 객체를 통해 전송
> kip37.setApprovalForAll('0x{address in hex}', true, { from: '0x{address in hex}' }).then(console.log)
{
blockHash: '0x0ee7be40f8b9f4d93d68235acef9fba08fde392a93a1a1743243cb9686943a47',
blockNumber: 3289,
contractAddress: null,
from: '0xfb8789cd544881f820fbff1728ba7c240a539f48',
...
status: true,
to: '0x394091d163ebdebcae876cb96cf0e0984c28a1e9',
...
events: {
ApprovalForAll: {
address: '0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9',
blockNumber: 3289,
transactionHash: '0x5e94aa4af5f7604f1b32129fa8463c43cae4ff118f80645bfabcc6181667b8ab',
transactionIndex: 0,
blockHash: '0x0ee7be40f8b9f4d93d68235acef9fba08fde392a93a1a1743243cb9686943a47',
logIndex: 0,
id: 'log_b1f9938f',
returnValues: {
'0': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
'1': '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6',
'2': true,
account: '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
operator: '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6',
approved: true,
},
event: 'ApprovalForAll',
signature: '0x17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c31',
raw: {
data: '0x00...001',
topics: [ '0x17307...', '0x00...f48', '0x00...1a6' ],
},
},
},
}
// 스마트 컨트랙트 실행을 위해 수수료 대납 트랜잭션 사용
> kip37.setApprovalForAll('0x{address in hex}', true, {
from: '0x{address in hex}'
feeDelegation: true,
feePayer: '0x{address in hex}'
}).then(console.log)
// kip37.options.from 사용
// kip37 인스턴스로 트랜잭션을 보낼 때 만약 kip37.options.from 값이 정해져 있는 경우
// sendParam 객체에 `from`를 명시하지 않는 이상 kip37 인스턴스로 트랜잭션을 보낼 때 그 값을 사용
> kip37.options.from = '0x{address in hex}'
> kip37.setApprovalForAll('0x{address in hex}', true).then(console.log)

kip37.safeTransferFrom

kip37.safeTransferFrom(from, recipient, id, amount, data [, sendParam])
타입이 id인 특정 토큰의 주어진 amountfrom으로부터 recipient에 안전하게 전송합니다.
The address that was authorized to send the owner's token (the operator) or the token owner him/herself is expected to execute this token transfer transaction. Thus, an authorized address or the token owner should be the sender of this transaction whose address must be given at sendParam.from or kip37.options.from. Unless both sendParam.from and kip37.options.from are provided, an error would occur.
If the recipient was a contract address, it should implement IKIP37Receiver.onKIP37Received. 그렇지 않으면, 전송은 거부됩니다.
이 메서드는 Klaytn 네트워크에 트랜잭션을 전송하며 트랜잭션 수수료가 트랜잭션 발신자에게 부과됨을 참고하시기 바랍니다.
Parameters
이름
타입
설명
from
string
토큰을 소유한 계정 주소입니다. 이 계정 주소 잔액에서 allowance(kip7Instance.approve)를 사용해 토큰이 보내집니다.
recipient
string
토큰을 받을 계정 주소입니다.
id
BigNumber | string | number
전송할 토큰 ID입니다.
amount
BigNumber | string | number
전송할 토큰 수량입니다.
데이터
Buffer | string | number
(선택 사항) 호출 시 함께 보낼 데이터입니다.
sendParam
객체
(선택 사항) 트랜잭션 전송을 위해 사용될 파라미터들이 정의된 객체입니다. sendParam에 관한 자세한 정보는 kip37.create의 파라미터 설명을 참고하십시오.
참고 idamount 파라미터는 number 타입 값을 받지만, 입력된 값이 number.MAX_SAFE_INTEGER 범위를 초과하면 예상치 못한 결과 또는 에러를 일으킬 수 있습니다. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
프로미스Object를 반환 - 트랜잭션 실행 결과를 담고 있는 영수증입니다. 영수증 객체 속성값에 대한 자세한 정보는 getTransactionReceipt를 참고하세요. KIP37 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
예시
// 주어진 필드에서 sendParam 객체를 통해 전송 (데이터 없이)
> kip37.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 2, 10000, { from: '0x{address in hex}' }).then(console.log)
{
blockHash: '0x7dbe4c5bd916ad1aafef87fe6c8b32083080df4ec07f26b6c7a487bb3cc1cf64',
blocknumber: 3983,
contractAddress: null,
from: '0xfb8789cd544881f820fbff1728ba7c240a539f48',
...
status: true,
to: '0x394091d163ebdebcae876cb96cf0e0984c28a1e9',
...
events: {
TransferSingle: {
address: '0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9',
blockNumber: 3983,
transactionHash: '0x0efc60b88fc55ef37eafbd18057404334dfd595ce4c2c0ff75f0922b928735e7',
transactionIndex: 0,
blockHash: '0x7dbe4c5bd916ad1aafef87fe6c8b32083080df4ec07f26b6c7a487bb3cc1cf64',
logIndex: 0,
id: 'log_cddf554f',
returnValues: {
'0': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
'1': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
'2': '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6',
'3': '2',
'4': '1000',
operator: '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
from: '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
to: '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6',
id: '2',
value: '1000',
},
event: 'TransferSingle',
signature: '0xc3d58168c5ae7397731d063d5bbf3d657854427343f4c083240f7aacaa2d0f62',
raw: {
data: '0x00...3e8',
topics: [ '0xc3d58...', '0x00...f48', '0x00...f48', '0x00...1a6' ],
},
},
},
}
// Using FD transaction to execute the smart contract
> kip37.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 2, 10000, true, {
from: '0x{address in hex}'
feeDelegation: true,
feePayer: '0x{address in hex}'
}).then(console.log)
// 주어진 from 필드에서 sendParam 객체를 통해 전송 (데이터와 함께)
> kip37.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 2, 10000, 'data' { from: '0x{address in hex}' }).then(console.log)
// kip37.options.from 사용
// kip37 인스턴스로 트랜잭션을 보낼 때 만약 kip37.options.from 값이 정해져 있는 경우
// sendParam 객체에 `from`를 명시하지 않는 이상 kip37 인스턴스로 트랜잭션을 보낼 때 그 값을 사용
> kip37.options.from = '0x{address in hex}'
> kip37.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 2, 10000).then(console.log)

kip37.safeBatchTransferFrom

kip37.safeBatchTransferFrom(from, recipient, ids, amounts, data [, sendParam])
from에서 recipient로 다수의 토큰 ID와 값들의 전송을 안전하게 배치(batch) 합니다.
토큰 소유자의 토큰을 보내도록 허락받은 주소인 operator, 또는 토큰 소유자 자신이 이 토큰 전송 트랜잭션을 실행할 수 있습니다. 따라서 토큰을 보내도록 승인 계정 또는 토큰 소유자가 이 트랜잭션 발신자이어야 하며, 허락받은 계정의 주소는 반드시 sendParam.from 또는 kip37.options.from에 주어져야 합니다. Unless both sendParam.from and kip37.options.from are provided, an error would occur.
If the recipient was a contract address, it should implement IKIP37Receiver.onKIP37Received. 그렇지 않으면, 전송은 거부됩니다.
이 메서드는 Klaytn 네트워크에 트랜잭션을 전송하며 트랜잭션 수수료가 트랜잭션 발신자에게 부과됨을 참고하시기 바랍니다.
Parameters
이름
타입
설명
from
string
토큰을 소유한 계정 주소입니다. 이 계정 주소 잔액에서 allowance(kip7Instance.approve)를 사용해 토큰이 보내집니다.
recipient
string
토큰을 받을 계정 주소입니다.
ids
Array
전송할 토큰 ID의 배열입니다.
amounts
Array
전송하고자 하는 토큰 수량의 배열입니다.
데이터
Buffer | string | number
(선택 사항) 호출 시 함께 보낼 데이터입니다.
sendParam
객체
(선택 사항) 트랜잭션 전송을 위해 사용될 파라미터들이 정의된 객체입니다. sendParam에 관한 자세한 정보는 kip37.create의 파라미터 설명을 참고하십시오.
참고 idamount 파라미터는 number 타입 값을 받지만, 입력된 값이 number.MAX_SAFE_INTEGER 범위를 초과하면 예상치 못한 결과 또는 에러를 일으킬 수 있습니다. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
리턴값
프로미스Object를 반환 - 트랜잭션 실행 결과를 담고 있는 영수증입니다. 영수증 객체 속성값에 대한 자세한 정보는 getTransactionReceipt를 참고하세요. KIP37 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
예시
// 주어진 필드에서 sendParam 객체를 통해 전송 (데이터 없이)
> kip37.safeBatchTransferFrom('0x{address in hex}', '0x{address in hex}', [1, 2], [10, 1000], { from: '0x{address in hex}' }).then(console.log)
{
blockHash: '0x9e469494463a02ec4f9e2530e014089d6be3146a5485161a530a8e6373d472a6',
blocknumber: 4621,
contractAddress: null,
from: '0xfb8789cd544881f820fbff1728ba7c240a539f48',
...
status: true,
to: '0x394091d163ebdebcae876cb96cf0e0984c28a1e9',
...
events: {
TransferBatch: {
address: '0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9',
blockNumber: 4621,
transactionHash: '0x557213eef8ae096bc35f5b3bee0e7cf87ecd87129b4a16d4e35a7356c341dad8',
transactionIndex: 0,
blockHash: '0x9e469494463a02ec4f9e2530e014089d6be3146a5485161a530a8e6373d472a6',
logIndex: 0,
id: 'log_b050bacc',
returnValues: {
'0': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
'1': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
'2': '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6',
'3': ['1', '2'],
'4': ['10', '1000'],
operator: '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
from: '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
to: '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6',
ids: ['1', '2'],
values: ['10', '1000'],
},
event: 'TransferBatch',
signature: '0x4a39dc06d4c0dbc64b70af90fd698a233a518aa5d07e595d983b8c0526c8f7fb',
raw: {
data: '0x00...3e8',
topics: [ '0x4a39d...', '0x00...f48', '0x00...f48', '0x00...1a6' ],
},
},
},
}
// 스마트 컨트랙트 실행을 위해 수수료 대납 트랜잭션 사용
> kip37.safeBatchTransferFrom('0x{address in hex}', '0x{address in hex}', [1, 2], [10, 1000], {
from: '0x{address in hex}'
feeDelegation: true,
feePayer: '0x{address in hex}'
}).then(console.log)
// 주어진 from 필드에서 sendParam 객체를 통해 전송 (데이터와 함께)
> kip37.safeBatchTransferFrom('0x{address in hex}', '0x{address in hex}', [1, 2], [10, 1000], 'data', { from: '0x{address in hex}' }).then(console.log)
// kip37.options.from 사용
// kip37 인스턴스로 트랜잭션을 보낼 때 만약 kip37.options.from 값이 정해져 있는 경우
// sendParam 객체에 `from`을 명시하지 않는 이상 kip37 인스턴스로 트랜잭션을 보낼 때 그 값을 사용
> kip37.options.from = '0x{address in hex}'
> kip37.safeBatchTransferFrom('0x{address in hex}', '0x{address in hex}', [1, 2], [10, 1000]).then(console.log)

kip37.mint

kip37.mint(to, id, value [, sendParam])
특정 타입 id의 토큰을 발행하며, tovalue 변수에 맞게 토큰을 할당합니다. 발행 함수를 사용하면 tovalue에 배열을 파라미터로 전달함으로써 다수의 계정에 한 번에 다양한 토큰을 발행할 수 있습니다.
이 메서드는 Klaytn 네트워크에 트랜잭션을 전송하며 트랜잭션 수수료가 트랜잭션 발신자에게 부과됨을 참고하시기 바랍니다.
Parameters
이름
타입
설명
to
string | Array
토큰이 발행될 계정의 주소 또는 주소들의 배열입니다.
id
BigNumber | string | number
발행할 토큰 ID입니다.
value
BigNumber | string | number | Array
발행될 토큰 수량입니다. 다수의 주소를 포함한 배열은 배열 형식으로 to 파라미터에 전달되어야 합니다.
sendParam
객체
(선택 사항) 트랜잭션 전송을 위해 사용될 파라미터들이 정의된 객체입니다. sendParam에 관한 자세한 정보는 kip37.create의 파라미터 설명을 참고하십시오.
참고 idvalue 파라미터는 number 타입 값을 받지만, 입력된 값이 number.MAX_SAFE_INTEGER 범위를 초과하면 예상치 못한 결과 또는 에러를 일으킬 수 있습니다. 이 경우, BigNumber 타입 값 사용이 권장되며, 특히 uint256 크기의 숫자 입력은 BigNumber 타입 값을 사용하는 것이 좋습니다.
참고 만약 sendParam.from 또는 kip37.options.from이 주어졌다면, 이 주소는 반드시 MinterRole를 가진 발행자이어야 합니다.
리턴값
프로미스Object를 반환 - 트랜잭션 실행 결과를 담고 있는 영수증입니다. 영수증 객체 속성값에 대한 자세한 정보는 getTransactionReceipt를 참고하세요. KIP37 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.
예시
// 주어진 필드에서 sendParam 객체를 통해 전송 (특정 계정에 토큰 발행)
> kip37.mint('0x{address in hex}', 2, 1000, { from: '0x{address in hex}' }).then(console.log)
{
blockHash: '0xca4489a003dc781645475b7db11106da61b7438d86910920f953d8b2dab4a701',
blocknumber: 12868,
contractAddress: null,
from: '0xfb8789cd544881f820fbff1728ba7c240a539f48',
...
status: true,
to: '0x394091d163ebdebcae876cb96cf0e0984c28a1e9',
...
events: {
TransferSingle: {
address: '0x394091D163eBDEbcAe876cb96CF0E0984C28a1e9',
blockNumber: 12868,
transactionHash: '0xed25e305904e6efb613a6fe8b7370488554f6508b6701e9a0167c95d341c73dc',
transactionIndex: 0,
blockHash: '0xca4489a003dc781645475b7db11106da61b7438d86910920f953d8b2dab4a701',
logIndex: 0,
id: 'log_04dffde1',
returnValues: {
'0': '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
'1': '0x0000000000000000000000000000000000000000',
'2': '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6',
'3': '2',
'4': '1000',
operator: '0xfb8789cD544881F820Fbff1728Ba7c240a539F48',
from: '0x0000000000000000000000000000000000000000',
to: '0xF896C5aFD69239722013aD0041EF33B5A2fDB1A6',
id: '2',
value: '1000',
},
event: 'TransferSingle',
signature: