Padrão de Token Pagável ERC-1363

Introdução

O que é ERC-1363?

O ERC-1363 é uma interface de extensão para tokens ERC-20 que suporta a execução de lógica personalizada em um contrato receptor após transferências, ou em um contrato gastador após aprovações, tudo em uma única transação.

Diferenças do ERC-20

As operações padrão do ERC-20, como transfer, transferFrom e approve, não permitem a execução de código no contrato receptor ou gastador sem uma transação separada. Isso introduz complexidade no desenvolvimento de UI e atrito na adoção, porque os usuários devem esperar a primeira transação ser executada para então enviar a segunda. Eles também devem pagar GÁS duas vezes.

O ERC-1363 torna os tokens fungíveis capazes de realizar ações com mais facilidade e funcionar sem o uso de qualquer ouvinte off-chain. Ele permite fazer um callback em um contrato receptor ou gastador, após uma transferência ou aprovação, em uma única transação.

Pré-requisitos

Para entender melhor esta página, recomendamos que primeiro leia sobre:

Body

O ERC-1363 introduz uma API padrão para que os tokens ERC-20 interajam com contratos inteligentes após transfer, transferFrom ou approve.

Este padrão fornece a funcionalidade básica para transferir tokens, bem como permite que os tokens sejam aprovados para que possam ser gastos por um terceiro on-chain, e em seguida, fazer um callback no contrato receptor ou gastador.

Existem muitos usos propostos para contratos inteligentes que podem aceitar callbacks de ERC-20.

Alguns exemplos são:

Vendas coletivas: os tokens enviados acionam a alocação instantânea de recompensas.
Serviços: o pagamento ativa o acesso ao serviço em uma única etapa.
Faturas: os tokens liquidam faturas automaticamente.
Assinaturas: a aprovação da taxa anual ativa a assinatura com o pagamento do primeiro mês.

Por essas razões, ele foi originalmente nomeado "Payable Token".

O comportamento de callback expande ainda mais sua utilidade, permitindo interações perfeitas como:

Staking: os tokens transferidos acionam o bloqueio automático em um contrato de staking.
Votação: os tokens recebidos registram votos em um sistema de governança.
Troca: aprovações de token ativam a lógica de troca em uma única etapa.

Os tokens ERC-1363 podem ser usados para utilidades específicas em todos os casos que exigem a execução de um callback após o recebimento de uma transferência ou aprovação. O ERC-1363 também é útil para evitar a perda ou o bloqueio de tokens em contratos inteligentes, verificando a capacidade do destinatário de lidar com os tokens.

Diferentemente de outras propostas de extensão do ERC-20, o ERC-1363 não substitui os métodos transfer e transferFrom do ERC-20 e define os IDs das interfaces a serem implementadas, mantendo a retrocompatibilidade com o ERC-20.

De EIP-1363 (opens in a new tab):

Métodos

Os contratos inteligentes que implementam o padrão ERC-1363 DEVEM implementar todas as funções na interface ERC1363, bem como as interfaces ERC20 e ERC165.

pragma solidity ^0.8.0;

/**
 * @title ERC1363
 * @dev Uma interface de extensão para tokens ERC-20 que suporta a execução de código em um contrato receptor
 * após `transfer` ou `transferFrom`, ou código em um contrato gastador após `approve`, em uma única transação.
 */
interface ERC1363 is ERC20, ERC165 {
  /*
   * NOTA: o identificador ERC-165 para esta interface é 0xb0202a11.
   * 0xb0202a11 ===
   *   bytes4(keccak256('transferAndCall(address,uint256)')) ^
   *   bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^
   *   bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^
   *   bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^
   *   bytes4(keccak256('approveAndCall(address,uint256)')) ^
   *   bytes4(keccak256('approveAndCall(address,uint256,bytes)'))
   */

  /**
   * @dev Move uma quantidade de tokens de `value` da conta do chamador para `to`
   * e então chama `ERC1363Receiver::onTransferReceived` em `to`.
   * @param to O endereço para o qual os tokens estão sendo transferidos.
   * @param value A quantidade de tokens a serem transferidos.
   * @return Um valor booleano que indica que a operação foi bem-sucedida, a menos que uma exceção seja lançada.
   */
  function transferAndCall(address to, uint256 value) external returns (bool);

  /**
   * @dev Move uma quantidade de tokens de `value` da conta do chamador para `to`
   * e então chama `ERC1363Receiver::onTransferReceived` em `to`.
   * @param to O endereço para o qual os tokens estão sendo transferidos.
   * @param value A quantidade de tokens a serem transferidos.
   * @param data Dados adicionais sem formato especificado, enviados na chamada para `to`.
   * @return Um valor booleano que indica que a operação foi bem-sucedida, a menos que uma exceção seja lançada.
   */
  function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool);

  /**
   * @dev Move uma quantidade de tokens de `value` de `from` para `to` usando o mecanismo de permissão (allowance)
   * e então chama `ERC1363Receiver::onTransferReceived` em `to`.
   * @param from O endereço do qual os tokens são enviados.
   * @param to O endereço para o qual os tokens estão sendo transferidos.
   * @param value A quantidade de tokens a serem transferidos.
   * @return Um valor booleano que indica que a operação foi bem-sucedida, a menos que uma exceção seja lançada.
   */
  function transferFromAndCall(address from, address to, uint256 value) external returns (bool);

  /**
   * @dev Move uma quantidade de tokens de `value` de `from` para `to` usando o mecanismo de permissão (allowance)
   * e então chama `ERC1363Receiver::onTransferReceived` em `to`.
   * @param from O endereço do qual os tokens são enviados.
   * @param to O endereço para o qual os tokens estão sendo transferidos.
   * @param value A quantidade de tokens a serem transferidos.
   * @param data Dados adicionais sem formato especificado, enviados na chamada para `to`.
   * @return Um valor booleano que indica que a operação foi bem-sucedida, a menos que uma exceção seja lançada.
   */
  function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool);

  /**
   * @dev Define uma quantidade de tokens de `value` como a permissão (allowance) de `spender` sobre os tokens do chamador
   * e então chama `ERC1363Spender::onApprovalReceived` em `spender`.
   * @param spender O endereço que gastará os fundos.
   * @param value A quantidade de tokens a serem gastos.
   * @return Um valor booleano que indica que a operação foi bem-sucedida, a menos que uma exceção seja lançada.
   */
  function approveAndCall(address spender, uint256 value) external returns (bool);

  /**
   * @dev Define uma quantidade de tokens de `value` como a permissão (allowance) de `spender` sobre os tokens do chamador
   * e então chama `ERC1363Spender::onApprovalReceived` em `spender`.
   * @param spender O endereço que gastará os fundos.
   * @param value A quantidade de tokens a serem gastos.
   * @param data Dados adicionais sem formato especificado, enviados na chamada para `spender`.
   * @return Um valor booleano que indica que a operação foi bem-sucedida, a menos que uma exceção seja lançada.
   */
  function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool);
}

interface ERC20 {
  event Transfer(address indexed from, address indexed to, uint256 value);
  event Approval(address indexed owner, address indexed spender, uint256 value);
  function transfer(address to, uint256 value) external returns (bool);
  function transferFrom(address from, address to, uint256 value) external returns (bool);
  function approve(address spender, uint256 value) external returns (bool);
  function totalSupply() external view returns (uint256);
  function balanceOf(address account) external view returns (uint256);
  function allowance(address owner, address spender) external view returns (uint256);
}

interface ERC165 {
  function supportsInterface(bytes4 interfaceId) external view returns (bool);
}

Um contrato inteligente que queira aceitar tokens ERC-1363 via transferAndCall ou transferFromAndCall DEVE implementar a interface ERC1363Receiver:

/**
 * @title ERC1363Receiver
 * @dev Interface para qualquer contrato que queira suportar `transferAndCall` ou `transferFromAndCall` de contratos de token ERC-1363.
 */
interface ERC1363Receiver {
  /**
   * @dev Sempre que tokens ERC-1363 são transferidos para este contrato via `ERC1363::transferAndCall` ou `ERC1363::transferFromAndCall`
   * por `operator` de `from`, esta função é chamada.
   *
   * NOTA: Para aceitar a transferência, esta função deve retornar
   * `bytes4(keccak256("onTransferReceived(address,address,uint256,bytes)"))`
   * (ou seja, 0x88a7ca5c, ou seu próprio seletor de função).
   *
   * @param operator O endereço que chamou a função `transferAndCall` ou `transferFromAndCall`.
   * @param from O endereço do qual os tokens são transferidos.
   * @param value A quantidade de tokens transferidos.
   * @param data Dados adicionais sem formato especificado.
   * @return `bytes4(keccak256("onTransferReceived(address,address,uint256,bytes)"))` se a transferência for permitida, a menos que uma exceção seja lançada.
   */
  function onTransferReceived(address operator, address from, uint256 value, bytes calldata data) external returns (bytes4);
}

Um contrato inteligente que queira aceitar tokens ERC-1363 via approveAndCall DEVE implementar a interface ERC1363Spender:

/**
 * @title ERC1363Spender
 * @dev Interface para qualquer contrato que queira dar suporte a `approveAndCall` de contratos de token ERC-1363.
 */
interface ERC1363Spender {
  /**
   * @dev Sempre que o `owner` (dono) de um token ERC-1363 aprova este contrato via `ERC1363::approveAndCall`
   * para gastar seus tokens, esta função é chamada.
   *
   * NOTA: Para aceitar a aprovação, esta função deve retornar
   * `bytes4(keccak256("onApprovalReceived(address,uint256,bytes)"))`
   * (ou seja, 0x7b04a2d0, ou seu próprio seletor de função).
   *
   * @param owner O endereço que chamou a função `approveAndCall` e que anteriormente possuía os tokens.
   * @param value A quantidade de tokens a ser gasta.
   * @param data Dados adicionais sem formato especificado.
   * @return `bytes4(keccak256("onApprovalReceived(address,uint256,bytes)"))` se a aprovação for permitida, a menos que uma exceção seja lançada.
   */
  function onApprovalReceived(address owner, uint256 value, bytes calldata data) external returns (bytes4);
}