caver.kct.kip7

caver.kct.kip7는 JavaScript의 객체로서 KIP-7을 구현하는 스마트 컨트랙트를 Klaytn 블록체인 플랫폼에서 쉽게 다룰 수 있도록 도와줍니다.

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

caver.kct.kip7에서 사용된 abi와 바이트 코드는 OpenZeppelin 예시를 사용하여 구현되었습니다.

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

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

caver.kct.kip7.deploy

caver.kct.kip7.deploy(tokenInfo, deployer)

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

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

Parameters

NameTypeDescription

tokenInfo

object

Klaytn 블록체인에 KIP-7 토큰 컨트랙트를 배포하는 데 필요한 정보입니다. See the below table for the details.

deployer

string | object

KIP-7 토큰 컨트랙트를 배포하는 주소입니다. 이 주소는 keyring에 존재합니다. keyring에 있는 이 계정 주소는 반드시 배포를 위해 충분한 KLAY를 가지고 있어야 합니다. If you want to define your own fields to use when sending transactions, you can pass the object type as a parameter. KIP-7 컨트랙트 배포 시 수수료 위임을 이용하고 싶다면, 객체 내 수수료 위임과 관련된 필드를 정의할 수 있습니다. sendParam에 관한 자세한 정보는 approve의 매개변수 설명을 참고하십시오.

The tokenInfo object must contain the following:

NameTypeDescription

name

string

The name of the token.

symbol

string

The symbol of the token.

decimals

number

토큰이 사용하는 소수점 자릿수입니다.

initialSupply

BigNumber | string | number

최초 공급될 토큰 총 수량입니다.

참고 initialSupply 파라미터는 number 타입을 받지만, 입력된 값이 number.MAX_SAFE_INTEGER 범위를 초과할 경우, 예상치 못한 결과나 오류가 발생할 수 있습니다. In this case, it is recommended to use the BigNumber type, especially for a uint256 sized numeric input value.

Return Value

PromiEvent: 이벤트 이미터와 결합된 프로미스이며 새로운 KIP7 인스턴스를 반환합니다. Additionally, the following events can occur:

NameTypeDescription

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. KIP7 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.

error

Error

Fired if an error occurs during sending.

Example

// 프로미스 사용
> caver.kct.kip7.deploy({
    name: 'Jasmine',
    symbol: 'JAS',
    decimals: 18,
    initialSupply: '100000000000000000000',
}, '0x{address in hex}').then(console.log)
KIP7 {
    ...
    _address: '0x598367e443D8a2b644Fec69a2C12aF44BC283f23',
    _jsonInterface: [
        ...
        {
            anonymous: false,
            inputs: [
                { indexed: true, name: 'owner', type: 'address' },
                    { indexed: true, name: 'spender', type: 'address' },
                    { indexed: false, name: 'value', type: 'uint256' }
            ],
            name: 'Approval',
            type: 'event',
            signature:  '0x8c5be...'
        }
    ] 
}

// 두 번째 파라미터로서 객체 전달
> caver.kct.kip7.deploy({
        name: 'Jasmine',
        symbol: 'JAS',
        decimals: 18,
        initialSupply: '100000000000000000000',
    },
    {
        from: '0x{address in hex}',
        feeDelegation: true,
        feePayer: '0x{address in hex}',
    }).then(console.log)

// 이벤트 이미터와 프로미스 사용
> caver.kct.kip7.deploy({
    name: 'Jasmine',
    symbol: 'JAS',
    decimals: 18,
    initialSupply: '100000',
}, '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(newKIP7Instance) {
    console.log(newKIP7Instance.options.address) // instance with the new token contract address
})

caver.kct.kip7.detectInterface

caver.kct.kip7.detectInterface(contractAddress)

Returns the information of the interface implemented by the token contract. 이 정적 함수는 kip7.detectInterface를 사용합니다.

Parameters

NameTypeDescription

contractAddress

string

The address of the KIP-7 token contract

Return Value

Promise returns an object containing the result with boolean values whether each KIP-7 interface is implemented.

Example

> caver.kct.kip7.detectInterface('0x{address in hex}').then(console.log)
{
    IKIP7: true,
    IKIP7Metadata: true,
    IKIP7Mintable: true,
    IKIP7Burnable: true,
    IKIP7Pausable: true,
}

caver.kct.kip7.create

caver.kct.kip7.create([tokenAddress])

새로운 KIP7 인스턴스를 인스턴스 메소드, 이벤트들과 함께 생성합니다. 이 함수는 new KIP7과 동일하게 작동합니다.

참고 caver.kct.kip7.create는 caver-js v1.6.1부터 지원됩니다.

Parameters

new KIP7를 참고하세요.

Return Value

See the new KIP7.

Example

// 매개변수 없는 KIP7 인스턴스 생성
> const kip7 = caver.kct.kip7.create()

// 토큰 주소를 가진 KIP7 인스턴스 생성
> const kip7 = caver.kct.kip7.create('0x{address in hex}')

new KIP7

new caver.kct.kip7([tokenAddress])

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

Parameters

NameTypeDescription

tokenAddress

string

(선택 사항) KIP-7 토큰 컨트랙트 주소이며 나중에 kip7.options.address = '0x1234..'로 값을 설정할 수 있습니다.

Return Value

TypeDescription

object

인스턴스 메소드와 이벤트들을 갖고 있는 KIP7 인스턴스입니다.

Example

// 매개변수 없는 KIP7 인스턴스 생성
> const kip7 = caver.kct.kip7()

// 토큰 주소를 가진 KIP7 인스턴스 생성
> const kip7 = caver.kct.kip7('0x{address in hex}')

kip7.clone

kip7.clone([tokenAddress])

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

Parameters

NameTypeDescription

tokenAddress

string

(선택 사항) 다른 KIP-7 토큰을 배포했던 스마트 컨트랙트 주소입니다. If omitted, it will be set to the contract address in the original instance.

Return Value

TypeDescription

object

원본 KIP7 인스턴스를 복제한 인스턴스입니다.

Example

> const kip7 = new caver.kct.kip7(address)

// 매개변수 없이 클론
> const cloned = kip7.clone()

// 새 토큰 컨트랙트 주소를 가지고 클론
> const cloned = kip7.clone('0x{address in hex}')

kip7.detectInterface

kip7.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-7 interface is implemented.

Example

> kip7.detectInterface().then(console.log)
{
    IKIP7: true,
    IKIP7Metadata: true,
    IKIP7Mintable: true,
    IKIP7Burnable: true,
    IKIP7Pausable: true,
}

kip7.supportsInterface

kip7.supportsInterface(interfaceId)

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

Parameters

NameTypeDescription

interfaceId

string

The interfaceId to be checked.

Return Value

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

Example

> kip7.supportsInterface('0x65787371').then(console.log)
true

> kip7.supportsInterface('0x3a2820fe').then(console.log)
false

kip7.name

kip7.name()

토큰 이름을 반환합니다.

Parameters

None

Return Value

Promise returns string: The name of the token.

Example

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

kip7.symbol

kip7.symbol()

토큰 심볼을 반환합니다.

Parameters

None

Return Value

Promise returns string: The symbol of the token.

Example

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

kip7.decimals

kip7.decimals()

토큰이 사용하는 소수점 자릿수를 반환합니다.

Parameters

None

Return Value

프로미스Number를 반환: 토큰이 사용하는 소수점 자릿수입니다.

Example

> kip7.decimals().then(console.log)
18

kip7.totalSupply

kip7.totalSupply()

토큰의 총 공급량을 반환합니다.

Parameters

None

Return Value

Promise returns BigNumber: The total number of tokens.

Example

> kip7.totalSupply().then(console.log)
100000000000000000000

kip7.balanceOf

kip7.balanceOf(address)

주어진 계정 주소의 잔액을 반환합니다.

Parameters

NameTypeDescription

address

string

The address of the account to be checked for its balance.

Return Value

Promise returns BigNumber: The account balance.

Example

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

kip7.allowance

kip7.allowance(owner, spender)

spenderowner의 잔액에서 인출하도록 허락받은 토큰 수량을 반환합니다.

Parameters

NameTypeDescription

owner

string

토큰 소유자 계정의 주소입니다.

spender

string

토큰 소유자를 대신해 토큰을 사용하는 계정 주소입니다.

Return Value

프로미스BigNumber를 반환: 토큰 소유자를 대신해 토큰 사용자가 사용할 수 있도록 남아있는 토큰 수량입니다.

Example

> kip7.allowance('0x{address in hex}', '0x{address in hex}').then(console.log)
0

> kip7.allowance('0x{address in hex}', '0x{address in hex}').then(console.log)
10

kip7.isMinter

kip7.isMinter(address)

주어진 계정이 새 KIP-7 토큰을 발행할 수 있는 minter라면 true를 반환합니다.

Parameters

NameTypeDescription

address

string

The address of the account to be checked for having the minting right.

Return Value

프로미스Boolean을 반환: 계정이 발행자라면 true를 반환합니다.

Example

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

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

kip7.isPauser

kip7.isPauser(address)

주어진 계정이 토큰 전송을 멈출 수 있는 pauser라면 true를 반환합니다.

Parameters

NameTypeDescription

address

string

The address of the account to be checked for having the right to suspend transferring tokens.

Return Value

프로미스Boolean을 반환: 이 계정이 중지 권한을 가진 계정이라면 true를 반환합니다.

Example

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

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

kip7.paused

kip7.paused()

컨트랙트가 작동을 멈추었다면 true를 반환하고, 그렇지 않으면 false를 반환합니다.

Parameters

None

Return Value

프로미스Boolean을 반환: 이 컨트랙트가 중지되었다면 true를 반환합니다.

Example

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

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

kip7.approve

kip7.approve(spender, amount [, sendParam])

토큰 소유자의 토큰을 spenderamount만큼 사용하도록 허락합니다.

이 메서드는 토큰 소유자가 트랜잭션 발신자로서 Klaytn 네트워크에 트랜잭션을 전송하며, 트랜잭션 수수료가 트랜잭션 발신자에게 부과됩니다.

Parameters

NameTypeDescription

spender

string

The address of the account who spends tokens in place of the owner.

amount

BigNumber | string | number

토큰 spender가 사용을 허락받은 토큰 수량입니다.

sendParam

object

(optional) An object holding parameters that are required for sending a transaction.

참고 amount 파라미터는 Number 타입 값을 받지만, 입력된 값이 Number.MAX_SAFE_INTEGER 범위를 초과하면 예상치 못한 결과 또는 오류를 발생시킬 수 있습니다. 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:

NameTypeDescription

from

string

(optional) The address from which the transaction should be sent. 미입력 시 kip7.options.from에 의해 지정됩니다. sendParam객체의 from 또는 this.options.from가 주어지지 않으면 오류가 발생합니다.

gas

number | string

(optional) The maximum number of gas provided for this transaction (gas limit). 미입력 시 caver-js가 kip7.methods.approve(spender, amount).estimateGas({from})를 호출하여 이 값을 지정합니다.

gasPrice

number | string

(optional) The gas price in peb for this transaction. If omitted, it will be set by caver-js via calling caver.klay.getGasPrice.

value

number | string | BN | BigNumber

(optional) The value to be transferred in peb.

feeDelegation

boolean

(optional, default false) Whether to use fee delegation transaction. 미입력 시 kip7.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. 미입력 시 kip7.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. 미입력 시 kip7.options.feeRatio를 사용합니다.

NOTE feeDelegation, feePayer and feeRatio are supported since caver-js v1.6.1.

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. KIP7 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.

Example

// 주어진 필드에서 sendParam 객체를 통해 전송
> kip7.approve('0x{address in hex}', 10, { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0xf010a98f66b6b36943175cd5b249da54e84abed551cfa02846a2900ddab968c7',
    blocknumber: 2098,
    contractAddress: null,
    from: '0x2f7dc98bd93a0544b03d6ff428a6f4ae04b32676',
    ...
    status: true,
    to: '0x8ca777e464a83b939ae131ca037f0d8728c6929e',
    ...
    events: {
        Approval: {
            address: '0x8CA777e464a83b939AE131CA037F0d8728C6929e',
            blocknumber: 2098,
            transactionHash: '0xf7469c0420cb5ebb0fbf64a314bd0c9ee7517ea64dd72eefa59bc8005bbc0f99',
            transactionIndex: 0,
            blockHash: '0xf010a98f66b6b36943175cd5b249da54e84abed551cfa02846a2900ddab968c7',
            logIndex: 0,
            id: 'log_c6ec61aa',
            returnValues: {
                '0': '0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676',
                '1': '0xe36ffD7bc4D588c480B5925B9622881F9d85ea30',
                '2': '10',
                owner: '0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676',
                spender: '0xe36ffD7bc4D588c480B5925B9622881F9d85ea30',
                value: '10'
            },
            event: 'Approval',
            signature: '0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925',
            raw: {
                data: '0x000000000000000000000000000000000000000000000000000000000000000a',
                topics: [ '0x8c5be...', '0x00...676', '0x00...a30' ]
            },
        },
    },
}

//스마트 컨트랙트 실행에 수수료 대납 트랜잭션 사용
> kip7.approve('0x{address in hex}', 10, {
    from: '0x{address in hex}'
    feeDelegation: true,
    feePayer: '0x{address in hex}'
}).then(console.log)

// kip7.options.from 사용
// kip7 인스턴스로 트랜잭션을 보낼 때 kip7.options.from 값이 정해져 있는 경우, 
// sendParam 객체에 `from`를 명시하지 않는 이상 kip7 인스턴스로 트랜잭션을 보낼 때 그 값을 사용
> kip7.options.from = '0x{address in hex}'
> kip7.approve('0x{address in hex}', 10).then(console.log)

kip7.transfer

kip7.transfer(recipient, amount [, sendParam])

주어진 amount만큼의 토큰을 토큰 소유자 잔액에서 recipient에게 보냅니다. 토큰 소유자는 이 토큰 전송을 직접 실행해야 합니다. 따라서 토큰 소유자는 이 트랜잭션 발신자이어야 하며, 토큰 소유자의 주소는 반드시 sendParam.from 또는 kip7.options.from에 주어져야 합니다. sendParam.from 또는 kip7.options.from가 주어지지 않는다면 에러가 발생합니다.

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

Parameters

NameTypeDescription

recipient

string

The address of the account to receive the token.

amount

BigNumber | string | number

전송될 토큰 수량입니다.

sendParam

object

(optional) An object with defined parameters for sending a transaction. sendParam에 관한 자세한 정보는 approve의 파라미터 설명을 참고하십시오.

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

Example

// 주어진 필드에서 sendParam 객체를 통해 전송
> kip7.transfer('0x{address in hex}', 10, { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x8a078c3a73d678cdd85d471eb21e9ed7d695f8b96fc7315cfa59c1f68be3d2bf',
    blocknumber: 1353,
    contractAddress: null,
    from: '0x2f7dc98bd93a0544b03d6ff428a6f4ae04b32676',
    ...
    status: true,
    to: '0x05871c21664e18b2906545f8831695650a8f4056',
    ...
    events: {
        Transfer: {
            address: '0x05871c21664E18b2906545f8831695650a8f4056',
            blocknumber: 1353,
            transactionHash: '0x8bd2b21a06241e4cfc0af1ec40e7b15444f730c7529440648aa4ed6b697f08f4',
            transactionIndex: 0,
            blockHash: '0x8a078c3a73d678cdd85d471eb21e9ed7d695f8b96fc7315cfa59c1f68be3d2bf',
            logIndex: 0,
            id: 'log_82ef7705',
            returnValues: {
                '0': '0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676',
                '1': '0xE411cb0B61FDcC06497794fE3f49F65D5dE41f59',
                '2': '10',
                from: '0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676',
                to: '0xE411cb0B61FDcC06497794fE3f49F65D5dE41f59',
                value: '10'
            },
            event: 'Transfer',
            signature: '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
            raw: {
                data: '0x000000000000000000000000000000000000000000000000000000000000000a',
                topics: [ '0xddf25...', '0x00...676', '0x00...f59' ]
            },
        },
    },
}

//스마트 컨트랙트 실행에 수수료 대납 트랜잭션 사용
> kip7.transfer('0x{address in hex}', 10, {
    from: '0x{address in hex}'
    feeDelegation: true,
    feePayer: '0x{address in hex}'
}).then(console.log)

// kip7.options.from 사용
// kip7 인스턴스로 트랜잭션을 보낼 때 kip7.options.from 값이 정해져 있는 경우, 
// sendParam 객체에 `from`를 명시하지 않는 이상 kip7 인스턴스로 트랜잭션을 보낼 때 그 값을 사용
> kip7.options.from = '0x{address in hex}'
> kip7.transfer('0x{address in hex}', 10).then(console.log)

kip7.safeTransfer

kip7.safeTransfer(recipient, amount [, data] [, sendParam])

주어진 amount만큼의 토큰을 토큰 소유자 잔액에서 recipient에게 안전하게 보냅니다. The token owner should execute this token transfer with its own hands. Thus, the token owner should be the sender of this transaction whose address must be given at sendParam.from or kip7.options.from. Without sendParam.from nor kip7.options.from being provided, an error would occur.

If the recipient was a contract address, it should implement IKIP7Receiver.onKIP7Received. Otherwise, the transfer is reverted.

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

Parameters

NameTypeDescription

recipient

string

The address of the account to receive the token.

amount

BigNumber | string | number

The amount of token you want to transfer.

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 approve.

NOTE The amount 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. KIP7 인스턴스의 영수증은 'logs' 속성 대신에 ABI로 파싱된 'events' 속성을 가지고 있습니다.

Example

// 주어진 필드에서 sendParam 객체를 통해 전송 (데이터 없이)
> kip7.safeTransfer('0x{address in hex}', 10, { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x208cd64b95bbd91420fc6b1a7b514a8d3051d09333d79244b6b74ff2f7f3eee4',
    blocknumber: 2384,
    contractAddress: null,
    from: '0xc2c84328845a36fe0c4dcef370d24ec80cf85221',
    ...
    status: true,
    to: '0xe4aeba6306b0df023aa4b765960fa59dbe925950',
    ...
    events: {
            Transfer: {
                    address: '0xe4AeBa6306b0Df023AA4b765960fA59dbE925950',
                    blocknumber: 2384,
                    transactionHash: '0x47bb085947c282722c1ceab1f4f0380d911ce464a47a19f1e7bddfe08a13563d',
                    transactionIndex: 0,
                    blockHash: '0x208cd64b95bbd91420fc6b1a7b514a8d3051d09333d79244b6b74ff2f7f3eee4',
                    logIndex: 0,
                    id: 'log_58e5e06d',
                    returnValues: {
                            '0': '0xC2C84328845A36Fe0c4DcEf370d24ec80cF85221',
                            '1': '0x67B092d09B5e94fed58609777cc7Ac9193553B73',
                            '2': '10',
                            from: '0xC2C84328845A36Fe0c4DcEf370d24ec80cF85221',
                            to: '0x67B092d09B5e94fed58609777cc7Ac9193553B73',
                            value: '10',
                    },
                    event: 'Transfer',
                    signature: '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
                    raw: {
                            data: '0x000000000000000000000000000000000000000000000000000000000000000a',
                            topics: [ '0xddf25...', '0x00...221', '0x00...b73' ],
                    },
            },
    },
}

//스마트 컨트랙트 실행에 수수료 대납 트랜잭션 사용
> kip7.safeTransfer('0x{address in hex}', 10, {
    from: '0x{address in hex}'
    feeDelegation: true,
    feePayer: '0x{address in hex}'
}).then(console.log)

// 주어진 from 필드에서 sendParam 객체를 통해 전송(데이터와 함께)
> kip7.safeTransfer('0x{address in hex}', 11, '0x1234', { from: '0x{address in hex}' }).then(console.log)

// kip7.options.from 사용
// kip7 인스턴스로 트랜잭션을 보낼 때 kip7.options.from 값이 정해져 있는 경우, 
// sendParam 객체에 `from`를 명시하지 않는 이상 kip7 인스턴스로 트랜잭션을 보낼 때 그 값을 사용
> kip7.options.from = '0x{address in hex}'
> kip7.safeTransfer('0x{address in hex}', 11).then(console.log)

kip7.transferFrom

kip7.transferFrom(sender, recipient, amount [, sendParam])

Transfers the given amount of the token from the token owner's balance to the recipient. 토큰 소유자의 토큰을 보내도록 허락받은 주소가 이 토큰 전송 트랜잭션을 실행할 수 있습니다. 따라서 토큰을 보내도록 허락받은 계정이 이 트랜잭션 발신자이어야 하며, 허락받은 계정의 주소는 반드시 sendParam.from 또는 kip7.options.from에 주어져야 합니다. Without sendParam.from nor kip7.options.from being provided, an error would occur.

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

Parameters

NameTypeDescription

sender

string

The address of the account that owns the token to be sent with allowance mechanism.

recipient

string

The address of the account to receive the token.

amount

BigNumber | string | number

The amount of token you want to transfer.

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

Example

// 주어진 필드에서 sendParam 객체를 통해 전송
> kip7.transferFrom('0x{address in hex}', '0x{address in hex}', 10000, { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x3adec238e06a9e8d5fa09fc1e1d7c8748b64d07e89678d27e8a379a12a34974f',
    blocknumber: 2331,
    contractAddress: null,
    from: '0x01958c62ab4aec7fc282bec9491da0ef7f830ac2',
    ...
    status: true,
    to: '0x3d5eb40665d25aaa4160023c4278fa6a94ba4acb',
    ...
    events: {
        Transfer: {
            address: '0x3D5EB40665D25aAa4160023C4278FA6A94BA4aCb',
            blocknumber: 2331,
            transactionHash: '0x5b2232b68681f19d9b6fcd6fb03964ef105912fecb772c11c8ec9fc906be4cbf',
            transactionIndex: 0,
            blockHash: '0x3adec238e06a9e8d5fa09fc1e1d7c8748b64d07e89678d27e8a379a12a34974f',
            logIndex: 0,
            id: 'log_ae57b7a0',
            returnValues: {
                '0': '0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676',
                '1': '0x49ff9cb8BB8CA10D7f6E1094b2Ba56c3C2DBA231',
                '2': '10000',
                from: '0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676',
                to: '0x49ff9cb8BB8CA10D7f6E1094b2Ba56c3C2DBA231',
                value: '10000'
            },
            event: 'Transfer',
            signature: '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
            raw: {
                data: '0x0000000000000000000000000000000000000000000000000000000000002710',
                topics: [ '0xddf25...', '0x00...676', '0x00...231' ]
            },
        },
        Approval: {
            address: '0x3D5EB40665D25aAa4160023C4278FA6A94BA4aCb',
            blocknumber: 2331,
            transactionHash: '0x5b2232b68681f19d9b6fcd6fb03964ef105912fecb772c11c8ec9fc906be4cbf',
            transactionIndex: 0,
            blockHash: '0x3adec238e06a9e8d5fa09fc1e1d7c8748b64d07e89678d27e8a379a12a34974f',
            logIndex: 1,
            id: 'log_cee37d26',
            returnValues: {
                '0': '0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676',
                '1': '0x01958c62aB4aEC7fC282bEc9491dA0EF7F830AC2',
                '2': '0',
                owner: '0x2f7Dc98Bd93A0544B03d6ff428a6f4ae04b32676',
                spender: '0x01958c62aB4aEC7fC282bEc9491dA0EF7F830AC2',
                value: '0'
            },
            event: 'Approval',
            signature: '0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925',
            raw: {
                data: '0x0000000000000000000000000000000000000000000000000000000000000000',
                topics: [ '0x8c5be...', '0x00...676', '0x00...ac2' ]
            },
        },
    },
}

//스마트 컨트랙트 실행에 수수료 대납 트랜잭션 사용
> kip7.transferFrom('0x{address in hex}', '0x{address in hex}', 10000, {
    from: '0x{address in hex}'
    feeDelegation: true,
    feePayer: '0x{address in hex}'
}).then(console.log)

// kip7.options.from 사용
// kip7 인스턴스로 트랜잭션을 보낼 때 kip7.options.from 값이 정해져 있는 경우, 
// sendParam 객체에 `from`를 명시하지 않는 이상 kip7 인스턴스로 트랜잭션을 보낼 때 그 값을 사용
> kip7.options.from = '0x{address in hex}'
> kip7.transferFrom('0x{address in hex}', '0x{address in hex}', 10000).then(console.log)

kip7.safeTransferFrom

kip7.safeTransferFrom(sender, recipient, amount [, data] [, sendParam])

Safely transfers the given amount of the token from the token owner's balance to the recipient. The address who was approved to send the token owner's tokens is expected to execute this token transferring transaction. Thus, the approved one should be the sender of this transaction whose address must be given at sendParam.from or kip7.options.from. Without sendParam.from nor kip7.options.from being provided, an error would occur.

If the recipient was a contract address, it should implement IKIP7Receiver.onKIP7Received. Otherwise, the transfer is reverted.

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

Parameters

NameTypeDescription

sender

string

The address of the account that owns the token to be sent with allowance mechanism.

recipient

string

The address of the account to receive the token.

amount

BigNumber | string | number

The amount of token you want to transfer.

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 approve.

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

Example

// 주어진 필드에서 sendParam 객체를 통해 전송 (데이터 없이)
> kip7.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 10000, { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x0d641b9cebb032f10348288623898f8aa319faa0845c5b3b7a59ac397a6a218b',
    blocknumber: 2404,
    contractAddress: null,
    from: '0x090937f5c9b83d961da29149a3c37104bc5e71b3',
    ...
    status: true,
    to: '0xe4aeba6306b0df023aa4b765960fa59dbe925950',
    ...
    events: {
            Transfer: {
                    address: '0xe4AeBa6306b0Df023AA4b765960fA59dbE925950',
                    blocknumber: 2404,
                    transactionHash: '0xed8c33facaea963f57c268134aaab48fa765e7298fd70d4bc796b1e93c12ad45',
                    transactionIndex: 0,
                    blockHash: '0x0d641b9cebb032f10348288623898f8aa319faa0845c5b3b7a59ac397a6a218b',
                    logIndex: 0,
                    id: 'log_5eaef2c3',
                    returnValues: {
                            '0': '0xC2C84328845A36Fe0c4DcEf370d24ec80cF85221',
                            '1': '0x67B092d09B5e94fed58609777cc7Ac9193553B73',
                            '2': '10000',
                            from: '0xC2C84328845A36Fe0c4DcEf370d24ec80cF85221',
                            to: '0x67B092d09B5e94fed58609777cc7Ac9193553B73',
                            value: '10000',
                    },
                    event: 'Transfer',
                    signature: '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
                    raw: {
                            data: '0x0000000000000000000000000000000000000000000000000000000000002710',
                            topics: [ '0xddf25...', '0x00...221', '0x00...b73' ],
                    },
            },
            Approval: {
                    address: '0xe4AeBa6306b0Df023AA4b765960fA59dbE925950',
                    blocknumber: 2404,
                    transactionHash: '0xed8c33facaea963f57c268134aaab48fa765e7298fd70d4bc796b1e93c12ad45',
                    transactionIndex: 0,
                    blockHash: '0x0d641b9cebb032f10348288623898f8aa319faa0845c5b3b7a59ac397a6a218b',
                    logIndex: 1,
                    id: 'log_3f3aedf8',
                    returnValues: {
                            '0': '0xC2C84328845A36Fe0c4DcEf370d24ec80cF85221',
                            '1': '0x090937f5C9B83d961da29149a3C37104Bc5e71B3',
                            '2': '0',
                            owner: '0xC2C84328845A36Fe0c4DcEf370d24ec80cF85221',
                            spender: '0x090937f5C9B83d961da29149a3C37104Bc5e71B3',
                            value: '0',
                    },
                    event: 'Approval',
                    signature: '0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925',
                    raw: {
                            data: '0x0000000000000000000000000000000000000000000000000000000000000000',
                            topics: [ '0x8c5be...', '0x00...221', '0x00...1b3' ],
                    },
            },
    },
}

//스마트 컨트랙트 실행에 수수료 대납 트랜잭션 사용
> kip7.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 10000, {
    from: '0x{address in hex}'
    feeDelegation: true,
    feePayer: '0x{address in hex}'
}).then(console.log)

// 주어진 from 필드에서 sendParam 객체를 통해 전송(데이터와 함께)
> kip7.safeTransfer('0x{address in hex}', 11, '0x1234', { from: '0x{address in hex}' }).then(console.log)

// kip7.options.from 사용
// kip7 인스턴스로 트랜잭션을 보낼 때 kip7.options.from 값이 정해져 있는 경우, 
// sendParam 객체에 `from`를 명시하지 않는 이상 kip7 인스턴스로 트랜잭션을 보낼 때 그 값을 사용
> kip7.options.from = '0x{address in hex}'
> kip7.safeTransferFrom('0x{address in hex}', '0x{address in hex}', 11).then(console.log)

kip7.mint

kip7.mint(account, amount [, sendParam])

amount만큼의 토큰을 만들어 account에게 발행합니다. 이 함수는 토큰 총 공급량을 증가시킵니다.

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

Parameters

NameTypeDescription

account

string

The address of the account to which the minted token will be issued.

amount

BigNumber | string | number

The amount of 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 amount 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.

참고 만약 sendParam.from 또는 kip7.options.from이 주어졌다면, 이 주소는 반드시 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 KIP7 instances have an 'events' attribute parsed via ABI instead of a 'logs' attribute.

Example

// 주어진 필드에서 sendParam 객체를 통해 전송
> kip7.mint('0x{address in hex}', 10000, { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x71e1c7c9de471ed9eb9ec2aca09beb63a654e21514b2b8d25ec93f34b810a709',
    blocknumber: 8466,
    contractAddress: null,
    from: '0x2f7dc98bd93a0544b03d6ff428a6f4ae04b32676',
    ...
    status: true,
    to: '0x54e9ad10ffcbcc2384863157c851a75a31c1e925',
    ...
    events: {
        Transfer: {
            address: '0x54e9Ad10FFcBCc2384863157c851A75a31C1E925',
            blocknumber: 8466,
            transactionHash: '0xef1db1544d0ba70aa06b77599a8421cee2270703cff7d0233bd09ab3561ab49a',
            transactionIndex: 0,
            blockHash: '0x71e1c7c9de471ed9eb9ec2aca09beb63a654e21514b2b8d25ec93f34b810a709',
            logIndex: 0,
            id: 'log_151f8e90',
            returnValues: {
                '0': '0x0000000000000000000000000000000000000000',
                '1': '0x4756D3c2A3DC61450D949BD9bF702b4209Fc15a0',
                '2': '10000',
                from: '0x0000000000000000000000000000000000000000',
                to: '0x4756D3c2A3DC61450D949BD9bF702b4209Fc15a0',
                value: '10000',
            },
            event: 'Transfer',
            signature: '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
            raw: {
                data: '0x0000000000000000000000000000000000000000000000000000000000002710',
                topics: [ '0xddf25...', '0x00...000', '0x00...5a0' ],
            },
        },
    },
}

//스마트 컨트랙트 실행에 수수료 대납 트랜잭션 사용
> kip7.mint('0x{address in hex}', 10000, {
    from: '0x{address in hex}'
    feeDelegation: true,
    feePayer: '0x{address in hex}'
}).then(console.log)

// kip7.options.from 사용
// kip7 인스턴스로 트랜잭션을 보낼 때 kip7.options.from 값이 정해져 있는 경우, 
// sendParam 객체에 `from`를 명시하지 않는 이상 kip7 인스턴스로 트랜잭션을 보낼 때 그 값을 사용
> kip7.options.from = '0x{address in hex}'
> kip7.mint('0x{address in hex}', 10000).then(console.log)

kip7.addMinter

kip7.addMinter(account [, sendParam])

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

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

Parameters

NameTypeDescription

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.

참고 만약 sendParam.from 또는 kip7.options.from이 주어졌다면, 이 주소는 반드시 발행자이어야 합니다.

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

Example

// 주어진 필드에서 sendParam 객체를 통해 전송
> kip7.addMinter('0x{address in hex}', { from: '0x{address in hex}' }).then(console.log)
{
    blockHash: '0x169db7e80c954f7d95bbb6a5ef3065190e842d515485e1679f8f3027d1b2975f',
    blocknumber: 9593,
    contractAddress: null,
    from: '0x2f7dc98bd93a0544b03d6ff428a6f4ae04b32676',
    ...
    status: true,
    to: '0x9e2851aff794e69c58e112a3beacbf0de6587f6b',
    ...