caver.kct.kip37
caver.kct.kip37
은 JavaScript의 객체로서 KIP-37을 구현하는 스마트 컨트랙트를 Klaytn 블록체인 플랫폼에서 쉽게 다룰 수 있도록 도와줍니다.caver.kct.kip37
는 KIP-37 토큰 컨트랙트를 구현하기 위해 caver.contract를 상속합니다. caver.kct.kip37
은 caver.contract
와 동일한 속성값들을 가지며, 추가 기능 구현을 위한 메서드를 더 가지고 있습니다. 이 장은 caver.kct.kip37
메서드들 중 오직 새롭게 추가된 것만을 소개합니다.The code that implements KIP-37 for caver-js is available on the Klaytn Contracts Github Repo. KIP-37 for caver-js supports Ownable interface. Using this, you can designate a contract owner when deploying a contract
caver.kct.kip37.deploy(tokenInfo, deployer)
KIP-37 토큰 컨트랙트를 Klaytn 블록체인에 배포합니다. caver.kct.kip37.deploy를 사용해 배포한 컨트랙트는 KIP-37 표준을 따르는 멀티 토큰입니다.
성공적으로 배포된 후, 프로미스는 새로운 KIP37 인스턴스를 반환할 것입니다.
Parameters
Name | Type | Description |
---|---|---|
tokenInfo | object | Klaytn 블록체인에 KIP-37 토큰 컨트랙트를 배포하는 데 필요한 정보입니다. See the below table for the details. |
deployer | string | object |
The tokenInfo object must contain the following:
Name | Type | Description |
---|---|---|
uri | string |
Return Value
PromiEvent
: 이벤트 이미터와 결합된 프로미스이며 새로운 KIP37 인스턴스를 반환합니다. Additionally, the following events can occur:Name | Type | Description |
---|---|---|
transactionHash | string | Fired right after the transaction is sent and a transaction hash is available. |
receipt | object | Fired when the transaction receipt is available. If you want to know about the properties inside the receipt object, see getTransactionReceipt. KIP37 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다. |
error | Error | Fired if an error occurs during sending. |
Token Enrollment
- 1.To enroll a token on a block explorer, the contract creator must fill out a submission request form. Make note of the specified information required on the form.
- 2.Smart Contract Environment
- Compiler Type: Solidity
- Compiler version: v0.8.4+commit.c7e474f2
- Open Source License Type: MIT
- 3.Smart Contract Detail
- Optimization: --optimize-run 200
- 4.
Example
// 프로미스 사용
> 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(contractAddress)
Returns the information of the interface implemented by the token contract. This static function will use kip37.detectInterface.
Parameters
Name | Type | Description |
---|---|---|
contractAddress | string | KIP-37 토큰 컨트랙트의 주소입니다. |
Return Value
Promise
returns an object
containing the result with boolean values whether each KIP-37 interface is implemented.Example
> 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([tokenAddress])
Creates a new KIP37 instance with its bound methods and events. This function works the same as new KIP37.
Parameters
Return Value
Example
// 매개변수 없는 KIP17 인스턴스 생성
> const kip17 = caver.kct.kip37.create()
// 토큰 주소를 가진 KIP37 인스턴스 생성
> const kip17 = caver.kct.kip37.create('0x{address in hex}')
new caver.kct.kip37([tokenAddress])
Creates a new KIP37 instance with its bound methods and events.
Parameters
Name | Type | Description |
---|---|---|
tokenAddress | string | (선택 사항) KIP-37 토큰 컨트랙트 주소이며 나중에 kip37.options.address = '0x1234..' 로 값을 설정할 수 있습니다. |
Return Value
Type | Description |
---|---|
object | 인스턴스 메소드와 이벤트들을 갖고 있는 KIP37 인스턴스입니다. |
Example
// 매개변수 없는 KIP37 인스턴스 생성
> const kip37 = new caver.kct.kip37()
// 토큰 주소를 가진 KIP37 인스턴스 생성
> const kip37 = new caver.kct.kip37('0x{address in hex}')
kip37.clone([tokenAddress])
Clones the current KIP37 instance.
Parameters
Name | Type | Description |
---|---|---|
tokenAddress | string | (선택 사항) 다른 KIP37 토큰을 배포했던 스마트 컨트랙트 주소입니다. If omitted, it will be set to the contract address in the original instance. |
Return Value
Type | Description |
---|---|
object | 원본 KIP37 인스턴스를 복제한 인스턴스입니다. |
Example
> const kip37 = new caver.kct.kip37(address)
// 매개변수 없이 클론
> const cloned = kip37.clone()
// 새 토큰 컨트랙트 주소와 함께 클론
> const cloned = kip37.clone('0x{address in hex}')
kip37.detectInterface()
Returns the information of the interface implemented by the token contract.
Parameters
None
Return Value
Promise
returns an object
containing the result with boolean values whether each KIP-37 interface is implemented.Example
> kip37.detectInterface().then(console.log)
{
IKIP37: true,
IKIP37Metadata: true,
IKIP37Mintable: true,
IKIP37Burnable: true,
IKIP37Pausable: true,
}
kip37.supportsInterface(interfaceId)
Return
true
if this contract implements the interface defined by interfaceId
.Parameters
Name | Type | Description |
---|---|---|
interfaceId | string | The interfaceId to be checked. |
Return Value
Promise
returns boolean
: true
if this contract implements the interface defined by interfaceId
.Example
> kip37.supportsInterface('0x6433ca1f').then(console.log)
true
> kip37.supportsInterface('0x3a2820fe').then(console.log)
false
kip37.uri(id)
Returns distinct Uniform Resource Identifier (URI) of the given token.
If the string "{id}" exists in any URI, this function will replace this with the actual token ID in hexadecimal form. Please refer to KIP-34 Metadata.
Parameters
Name | Type | Description |
---|---|---|
id | BigNumber | string | number | URI를 받을 토큰 ID입니다. |
NOTE The
id
parameter accepts number
type but if the fed value were out of the range capped by number.MAX_SAFE_INTEGER, it might cause an unexpected result or error. In this case, it is recommended to use the BigNumber
type, especially for a uint256
sized numeric input value.Return Value
Promise
returns string
: The uri of the token.Example
> kip37.uri('0x0').then(console.log)
'https://caver.example/0000000000000000000000000000000000000000000000000000000000000000.json'
kip37.totalSupply(id)
Returns the total token supply of the specific token.
Parameters
Name | Type | Description |
---|---|---|
id | BigNumber | string | number | 총 발행량을 확인할 토큰의 ID입니다. |
NOTE The
id
parameter accepts number
type but if the fed value were out of the range capped by number.MAX_SAFE_INTEGER, it might cause an unexpected result or error. In this case, it is recommended to use the BigNumber
type, especially for a uint256
sized numeric input value.Return Value
Promise
returns BigNumber
: The total number of tokens.Example
> kip37.totalSupply(0).then(console.log)
10000000000
kip37.balanceOf(account, id)
Returns the amount of tokens of token type
id
owned by account
.Parameters
Name | Type | Description |
---|---|---|
account | string | 잔액을 확인할 계정 주소입니다. |
id | BigNumber | string | number | 잔액을 확인할 토큰의 ID입니다. |
NOTE The
id
parameter accepts number
type but if the fed value were out of the range capped by number.MAX_SAFE_INTEGER, it might cause an unexpected result or error. In this case, it is recommended to use the BigNumber
type, especially for a uint256
sized numeric input value.Return Value
Promise
returns BigNumber
: The amount of token that account has.Example
> kip37.balanceOf('0x{address in hex}', 0).then(console.log)
20
kip37.balanceOfBatch(accounts, ids)
Returns the balance of multiple account/token pairs.
balanceOfBatch
is a batch operation of balanceOf, and the length of arrays with accounts
and ids
must be the same.Parameters
Name | Type | Description |
---|---|---|
accounts | Array | The address of the account for which you want to see balance. |
ids | Array | 잔액을 확인할 토큰 ID의 배열입니다. |
Return Value
Promise
returns Array
: The balance of multiple account/token pairs.Example
> kip37.balanceOfBatch(['0x{address in hex}', '0x{address in hex}'], [0, 1]).then(console.log)
[ 20, 30 ]
kip37.isMinter(address)
Returns
true
if the given account is a minter who can issue new KIP37 tokens.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
kip37.isMinter(address)
kip37.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
> kip37.isPauser('0x{address in hex}').then(console.log)
true
> kip37.isPauser('0x{address in hex}').then(console.log)
false
kip37.pause()
Returns whether or not the token contract's transaction (or specific token) is paused.
If id parameter is not defined, return whether the token contract's transaction is paused. If id parameter is defined, return whether the specific token is paused.
Parameters
Name | Type | Description |
---|---|---|
id | BigNumber | string | number | (선택 사항) 중단 여부 확인을 위한 토큰 ID입니다. 해당 파라미터 미입력시 paused 함수는 컨트랙트가 중단 상태에 있는지 여부를 반환합니다. |
NOTE The
id
parameter accepts number
type but if the fed value were out of the range capped by number.MAX_SAFE_INTEGER, it might cause an unexpected result or error. In this case, it is recommended to use the BigNumber
type, especially for a uint256
sized numeric input value.Return Value
Promise
returns boolean
: true
if the contract (or specific token) is paused.Example
// 토큰 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(owner, operator)
Queries the approval status of an operator for a given owner. Returns
true
if an operator is approved by a given owner.Parameters
Name | Type | Description |
---|---|---|
owner | string | 소유자의 주소입니다. |
operator | string | Operator의 주소입니다. |
Return Value
Promise
returns boolean
: True if the operator is approved, false if notExample
> 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(id, initialSupply [, uri] [, sendParam])
Creates a new token type and assigns
initialSupply
to the minter.Note that this method will submit a transaction to the Klaytn network, which will charge the transaction fee to the transaction sender.
Parameters
Name | Type | Description |
---|---|---|
id | BigNumber | string | number | 생성할 토큰 ID입니다. |
initialSupply | BigNumber | string | number | 발행할 토큰의 양입니다. |
uri | string | (선택 사항) 생성된 토큰의 URI입니다. |
sendParam | object | (선택 사항) 트랜잭션을 보내는 데 필요한 파라미터들을 가지고 있는 객체입니다. |
NOTE The
id
, initialSupply
parameters accept number
type but if the fed value were out of the range capped by number.MAX_SAFE_INTEGER, it might cause an unexpected result or error. In this case, it is recommended to use the BigNumber
type, especially for a uint256
sized numeric input value.The
sendParam
object contains the following:Name | Type | Description |
---|---|---|
from | string | (optional) The address from which the transaction should be sent. 미입력시 kip37.options.from 에 의해 지정됩니다. sendParam 객체의 from 또는 kip37.options.from 가 주어지지 않으면 오류가 발생합니다. |
gas | number | string | (선택 사항) 이 트랜잭션이 쓸 수 있는 최대 가스량 (가스 제한) 입니다. 미입력시 caver-js가 kip37.methods.approve(spender, amount).estimateGas({from}) 를 호출하여 이 값을 지정합니다. |
gasPrice | number | string | (선택 사항) 이 트랜잭션에 사용할 peb 단위의 가스 가격. If omitted, it will be set by caver-js via calling caver.klay.getGasPrice . |
value | number | string | BN | BigNumber | (optional) The value to be transferred in peb. |
feeDelegation | boolean | (optional, default false ) Whether to use fee delegation transaction. 미입력시 kip37.options.feeDelegation 를 사용합니다. If both omitted, fee delegation is not used. |
feePayer | string | (optional) The address of the fee payer paying the transaction fee. When feeDelegation is true , the value is set to the feePayer field in the transaction. 미입력시 kip37.options.feePayer 를 사용합니다. If both omitted, throws an error. |
feeRatio | string | (optional) The ratio of the transaction fee the fee payer will be burdened with. If feeDelegation is true and feeRatio is set to a valid value, a partial fee delegation transaction is used. The valid range of this is between 1 and 99. The ratio of 0, or 100 and above are not allowed. 미입력시 kip37.options.feeRatio 를 사용합니다. |
Return Value
Promise
returns object
- The receipt containing the result of the transaction execution. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. Receipts from KIP37 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.Example
// 주어진 필드에서 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(operator, approved [, sendParam])
Approves the given operator, or disallow the given operator, to transfer all tokens of the owner.
Note that this method will submit a transaction to the Klaytn network, which will charge the transaction fee to the transaction sender.
Parameters
Name | Type | Description |
---|---|---|
operator | 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. sendParam에 관한 자세한 정보는 kip37.create의 파라미터 설명을 참고하십시오. |
Return Value
Promise
returns object
- The receipt containing the result of the transaction execution. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. Receipts from KIP37 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.Example
// 주어진 필드에서 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(from, recipient, id, amount, data [, sendParam])
Safely transfers the given
amount
tokens of specific token type id
from from
to the recipient
.The address that was authorized to send the owner's token (the operator) or the token owner him/herself is expected to execute this token transfer transaction. Thus, an authorized address or the token owner should be the sender of this transaction whose address must be given at
sendParam.from
or kip37.options.from
. Unless both sendParam.from
and kip37.options.from
are provided, an error would occur.If the recipient was a contract address, it should implement IKIP37Receiver.onKIP37Received. Otherwise, the transfer is reverted.
Note that this method will submit a transaction to the Klaytn network, which will charge the transaction fee to the transaction sender.
Parameters
Name | Type | Description |
---|---|---|
from | string | 토큰을 소유한 계정 주소입니다. 이 계정 주소 잔액에서 allowance(kip7Instance.approve)를 사용해 토큰이 보내집니다. |
recipient | string | The address of the account to receive the token. |
id | BigNumber | string | number | 전송할 토큰 ID입니다. |
amount | BigNumber | string | number | 전송할 토큰 수량입니다. |
data | Buffer | string | number | (optional) The optional data to send along with the call. |
sendParam | object | (optional) An object with defined parameters for sending a transaction. For more information about sendParam, refer to the parameter description of kip37.create. |
NOTE The
id
and amount
parameters accept number
type but if the fed value were out of the range capped by number.MAX_SAFE_INTEGER, it might cause an unexpected result or error. In this case, it is recommended to use the BigNumber
type, especially for a uint256
sized numeric input value.Return Value
Promise
returns object
- The receipt containing the result of the transaction execution. If you want to know about the properties inside the receipt object, see the description of getTransactionReceipt. Receipts from KIP37 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.Example
// 주어진 필드에서 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: {