Cancel

sendTransaction (CANCEL)

caver.klay.sendTransaction(transactionObject [, callback])

Sends a Cancel transaction to the network.

Parameters

The parameters of sendTransaction are a transaction object and a callback function.

Name	Type	Description
transactionObject	Object	The transaction object to send.
callback	Function	(optional) Optional callback, returns an error object as the first parameter and the result as the second.

A transaction object of type CANCEL has the following structure:

Name	Type	Description
type	String	Transaction Type. "CANCEL"
from	String	Address of this transaction sender.
gas	Number	The maximum amount of gas willing to pay for the transaction (unused gas is refunded).
gasPrice	Number	(optional) Gas price provided by the sender in peb. The gasPrice must be the same as the unitPrice set in the Klaytn node.
nonce	Number	(optional) Integer of a nonce. This allows replacing your own pending transaction that has the same nonce. If omitted, it will be set by caver-js via calling caver.klay.getTransactionCount.

Return Value

The callback will return the 32-byte transaction hash.

PromiEvent: A promise combined event emitter. Will be resolved when the transaction receipt is available. Additionally the following events are available:

• "transactionHash" returns String: Is fired right after the transaction is sent and a transaction hash is available.

• "receipt" returns Object: Is fired when the transaction receipt is available.

• "error" returns Error: Is fired if an error occurs during sending. On an out-of-gas error, the second parameter is the receipt.

Example

const account = caver.klay.accounts.wallet.add('0x{private key}')

// using the promise
caver.klay.sendTransaction({
    type: 'CANCEL',
    from: account.address,
    nonce: 7, // It specifies target transaction having the same nonce to cancel.
    gas: '300000',
})
.then(function(receipt){
    ...
});

// using the event emitter
caver.klay.sendTransaction({
    type: 'CANCEL',
    from: account.address,
    nonce: 7, // It specifies target transaction having the same nonce to cancel.
    gas: '300000',
})
.on('transactionHash', function(hash){
    ...
})
.on('receipt', function(receipt){
    ...
})
.on('error', console.error); // If an out-of-gas error, the second parameter is the receipt.

sendTransaction (FEE_DELEGATED_CANCEL)

caver.klay.sendTransaction(transactionObject [, callback])

Sends a Fee Delegated Cancel transaction to the network.

Parameters

The parameters of sendTransaction are a transaction object and a callback function.

Name	Type	Description
transactionObject	Object	The transaction object to send.
callback	Function	(optional) Optional callback, returns an error object as the first parameter and the result as the second.

A transaction object of type FEE_DELEGATED_CANCEL has the following structure:

Name	Type	Description
type	String	Transaction Type. "FEE_DELEGATED_CANCEL"
from	String	Address of this transaction sender.
gas	Number	The maximum amount of gas willing to pay for the transaction (unused gas is refunded).
gasPrice	Number	(optional) Gas price provided by the sender in peb. The gasPrice must be the same as the unitPrice set in the Klaytn node.
nonce	Number	(optional) Integer of a nonce. This allows replacing your own pending transaction that has the same nonce. If omitted, it will be set by caver-js via calling caver.klay.getTransactionCount.

A transaction object of type FEE_DELEGATED_CANCEL with the above structure or an RLP-encoded transaction of type FEE_DELEGATED_CANCEL can be used as a parameters in caver.klay.accounts.signTransaction for sender and in caver.klay.accounts.feePayerSignTransaction for fee payer.

In order for the fee payer to sign an RLP encoded transaction signed by the sender and send it to the network, define an object with the following structure and call caver.klay.sendTransaction.

Name	Type	Description
feePayer	String	The fee payer address of the transaction.
senderRawTransaction	String	The RLP-encoded transaction signed by sender.

Return Value

The callback will return the 32-byte transaction hash.

PromiEvent: A promise combined event emitter. Will be resolved when the transaction receipt is available. Additionally the following events are available:

• "transactionHash" returns String: Is fired right after the transaction is sent and a transaction hash is available.

• "receipt" returns Object: Is fired when the transaction receipt is available.

• "error" returns Error: Is fired if an error occurs during sending. On an out-of-gas error, the second parameter is the receipt.

Example

const sender = caver.klay.accounts.wallet.add('0x{private key}')
const feePayer = caver.klay.accounts.wallet.add('0x{private key}')

// using the promise
const { rawTransaction: senderRawTransaction } = await caver.klay.accounts.signTransaction({
  type: 'FEE_DELEGATED_CANCEL',
  from: sender.address,
  nonce: 7, // It specifies target transaction having the same nonce to cancel.
  gas: '300000',
}, sender.privateKey)

caver.klay.sendTransaction({
  senderRawTransaction: senderRawTransaction,
  feePayer: feePayer.address,
})
.then(function(receipt){
    ...
});

// using the event emitter
const { rawTransaction: senderRawTransaction } = await caver.klay.accounts.signTransaction({
  type: 'FEE_DELEGATED_CANCEL',
  from: sender.address,
  nonce: 7, // It specifies target transaction having the same nonce to cancel.
  gas: '300000',
}, sender.privateKey)

caver.klay.sendTransaction({
  senderRawTransaction: senderRawTransaction,
  feePayer: feePayer.address,
})
.on('transactionHash', function(hash){
    ...
})
.on('receipt', function(receipt){
    ...
})
.on('error', console.error); // If an out-of-gas error, the second parameter is the receipt.

sendTransaction (FEE_DELEGATED_CANCEL_WITH_RATIO)

caver.klay.sendTransaction(transactionObject [, callback])

Sends a Fee Delegated Cancel With Ratio transaction to the network.

Parameters

The parameters of sendTransaction are a transaction object and a callback function.

Name	Type	Description
transactionObject	Object	The transaction object to send.
callback	Function	(optional) Optional callback, returns an error object as the first parameter and the result as the second.

A transaction object of type FEE_DELEGATED_CANCEL_WITH_RATIO has the following structure:

Name	Type	Description
type	String	Transaction Type. "FEE_DELEGATED_CANCEL_WITH_RATIO"
from	String	Address of this transaction sender.
gas	Number	The maximum amount of gas willing to pay for the transaction (unused gas is refunded).
gasPrice	Number	(optional) Gas price provided by the sender in peb. The gasPrice must be the same as the unitPrice set in the Klaytn node.
nonce	Number	(optional) Integer of a nonce. This allows replacing your own pending transaction that has the same nonce. If omitted, it will be set by caver-js via calling caver.klay.getTransactionCount.
feeRatio	Number	Fee ratio of the fee payer. If it is 30, 30% of the fee will be paid by the fee payer. 70% will be paid by the sender. The range of fee ratio is 1 ~ 99, if it is out of range, the transaction will not be accepted.

A transaction object of type FEE_DELEGATED_CANCEL_WITH_RATIO with the above structure or an RLP-encoded transaction of type FEE_DELEGATED_CANCEL_WITH_RATIO can be used as a parameter in caver.klay.accounts.signTransaction for sender and in caver.klay.accounts.feePayerSignTransaction for fee payer.

In order for the fee payer to sign an RLP encoded transaction signed by the sender and send it to the network, define an object with the following structure and call caver.klay.sendTransaction.

Name	Type	Description
feePayer	String	The fee payer address of the transaction.
senderRawTransaction	String	The RLP-encoded transaction signed by sender.

Return Value

The callback will return the 32-byte transaction hash.

PromiEvent: A promise combined event emitter. Will be resolved when the transaction receipt is available. Additionally the following events are available:

• "transactionHash" returns String: Is fired right after the transaction is sent and a transaction hash is available.

• "receipt" returns Object: Is fired when the transaction receipt is available.

• "error" returns Error: Is fired if an error occurs during sending. On an out-of-gas error, the second parameter is the receipt.

Example

const sender = caver.klay.accounts.wallet.add('0x{private key}')
const feePayer = caver.klay.accounts.wallet.add('0x{private key}')

// using the promise
const { rawTransaction: senderRawTransaction } = await caver.klay.accounts.signTransaction({
  type: 'FEE_DELEGATED_CANCEL_WITH_RATIO',
  from: sender.address,
  nonce: 7, // It specifies target transaction having the same nonce to cancel.
  gas: '300000',
  feeRatio: 30,
}, sender.privateKey)

caver.klay.sendTransaction({
  senderRawTransaction: senderRawTransaction,
  feePayer: feePayer.address,
})
.then(function(receipt){
    ...
});

// using the event emitter
const { rawTransaction: senderRawTransaction } = await caver.klay.accounts.signTransaction({
  type: 'FEE_DELEGATED_CANCEL_WITH_RATIO',
  from: sender.address,
  nonce: 7, // It specifies target transaction having the same nonce to cancel.
  gas: '300000',
  feeRatio: 30,
}, sender.privateKey)

caver.klay.sendTransaction({
  senderRawTransaction: senderRawTransaction,
  feePayer: feePayer.address,
})
.on('transactionHash', function(hash){
    ...
})
.on('receipt', function(receipt){
    ...
})
.on('error', console.error); // If an out-of-gas error, the second parameter is the receipt.