Como criar robô/bot trader para PancakeSwap (V3) em Node.js - Parte 2

Recentemente escrevi um tutorial onde ensinei a primeira parte da construção de um bot cripto para a dex (exchange decentralizada) PancakeSwap. Na primeira parte eu ensinei como preparar o ambiente de desenvolvimento, como estruturar o projeto e a fazer o monitoramento do preço.

Nesta segunda parte a minha missão é lhe ajudar a implementar a compra e venda (swap) de tokens.

Então vamos lá!

#1 – Conectando na Blockchain

O primeiro passo é obter uma conexão do seu bot com a sua carteira de criptomoedas, sendo que neste exemplo estou usando a MetaMask. Quando você criou a sua MetaMask (o que fizemos no passo anterior) você recebeu um endereço público e por dentro da carteira (em Detalhes da Conta, imagem abaixo) você pegou sua chave privada, certo? Estas duas informações devem estar agora no seu arquivo .env, sob as variáveis WALLET e PRIVATE_KEY. Também incluímos no .env uma variável PROVIDER_URL, que indica a sua configuração do full node necessário para conexão com a blockchain.

Resumindo: usaremos o full node para conexão na blockchain e a carteira para realizar as transações.

Para que a comunicação com os contratos inteligentes através da carteira cripto ocorra com sucesso, precisamos da especificação formal deles carregada em nosso sistema, chamada de ABI (Application Binary Interface). Precisamos especificamente de dois ABIs: do ABI do swap router (que falei sobre nesse post aqui) e do ABI genérico de token ERC-20 (que falei extensivamente aqui), para que possamos nos comunicar com o contrato de roteamento da dex e dos tokens, respectivamente. Esses ABIs podem ser facilmente obtidos no block explorer da rede que estiver utilizando, no meu caso peguei os meus na testnet.bscscan.com buscando pelo endereço dos contratos (os mesmos que coloquei no .env) e indo na aba contract, onde ficam os códigos do contrato, como na imagem abaixo.

O ABI dos tokens ERC-20 está abaixo e você pode copiar livremente, pois ele é igual em todas redes compatíveis com EVM. Crie um arquivo abi.erc20.json na raiz do seu projeto e cole esse conteúdo nele.

Depois, crie um segundo arquivo na raiz do projeto chamado abi.pancakeswap.json e dentro dele cole o ABI do swap router da PancakeSwap V3. Acredito que em todas redes ele seja igual, então acho que pode copiar o meu sem problema, que peguei na rede BSC Testnet.

Agora voltando ao index.js, vamos carregar estes dois ABIs logo abaixo das variáveis que tínhamos definido anteriormente e antes das funções, eles serão necessários nos códigos logo à frente.

Com estes dois arquivos JSON carregados mais todas as variáveis e configs anteriores à eles, podemos fazer a instanciação dos objetos de full node, de carteira e de contratos, como abaixo.

O primeiro objeto é a conexão com o full node, que aqui estamos usando o nó público da BSC Testnet, com a URL definida no .env.

O segundo objeto (signer) é a config da nossa carteira, que será usada para assinar as transações. Ela é inicializada com nossa chave privada (definida no .env) e o provider recém configurado.

O terceiro objeto é o contrato swap router da PancakeSwap, inicializado com o endereço do contrato, com o ABI da PancakeSwap e com a carteira já configurada.

Já os dois últimos objetos são praticamente iguais, pois são objetos de contrato de token, mas cada um está apontado para um token diferente, pois ora precisaremos de um, ora de outro. Mas ambos usarão a mesma carteira e o mesmo ABI nas transações.

Agora estamos com tudo configurado para comunicação com a blockchain e podemos iniciar a implementação da lógica do robô.

#2 – Fazendo Swap de Tokens

Agora que já sabemos como fazer a conexão no full node com controle total da nossa carteira cripto, é hora de implementarmos a primeira etapa da função que faz o swap dos tokens. É importante salientar que todas transações na blockchain exigem o pagamento da taxa de gás, que deve ser paga sempre na moeda local, BNB no caso da BSC Testnet. Ou seja, apesar de não estar negociando BNBs neste bot, você deve ter BNB na carteira a fim de pagar as taxas, ok?

Volte ao seu arquivo index.js e na função executeCycle, vamos implementar uma lógica simples de compra e venda.

Com essa lógica acima, assim que o preço cair abaixo do parâmetro de gatilho e se o robô ainda não estiver com sua posição aberta (isOpened false) nós vamos fazer a compra acontecer, já sinalizando que a posição ficou aberta (isOpened true). Por outro lado, se a posição já estiver aberta (isOpened true) e o preço de venda foi superado, então a gente finge que vende, reiniciando a variável de controle para que seja possível o robô entrar em outro ciclo de compra.

Entendida essa lógica, e inclusive recomendo que você teste novamente o robô agora, para ver se ele vai se comportar conforme configurado e programado, é hora de fazermos o código para swap. Para isso, vamos criar uma nova função, no mesmo arquivo.

A função swap é possivelmente a mais complexa até aqui. Nela, começamos definindo os parâmetros do swap, a saber:

• tokenIn: endereço do token ERC-20 que você vai dar no swap;
• tokenOut: endereço do token ERC-20 que você quer receber no swap;
• fee: a taxa a ser paga (da PancakeSwap, varia de acordo com o liquidity pool);
• recipient: quem vai receber os tokens;
• deadline: prazo para conclusão do swap (na blockchain o timestamp é em segundos, por isso o cálculo);
• amountIn: quantidade de tokens que você vai dar no swap (tokenIn, em wei);
• amountOutMinimum: o mínimo de tokenOut que você aceita receber (zero quer dizer qualquer quantia);
• sqrtPriceLimitX96: um parâmetro mais avançado para limitar o preço a ser pago pela moeda (zero quer dizer qualquer preço);

A maioria desses parâmetros é autoexplicativo, mas você encontra a referência técnica completa no site da Uniswap (lembrando que a Pancake é um fork da Uni). Com estes parâmetros, podemos chamar a função do objeto router (que está configurado para o contrato de swap routing) de nome exactInputSingle, que serve para fazer um swap simples/direto. Além dos parâmetros precisamos passar as configurações da transação com quem vai fazê-la (WALLET), qual o preço do gás a ser pago (10 gwei) e qual o limite de gás que estamos dispostos a pagar. Essas configurações adicionais são necessárias porque a lib Ethers não consegue calcular o custo de gás sozinha nos contratos da PancakeSwap, possivelmente por causa da arquitetura complexa do projeto, explicada aqui.

Com a transação enviada, a gente aguarda a sua conclusão (tx.wait) e depois pega nos logs do recibo a quantidade de TOKEN0 recebido no swap, para que possamos usar essa informação depois na venda.

A nossa função de swap está pronta para uso, mas calma, porque se usar ela assim, vai ter um erro de autorização, então precisamos escrever mais um pouco de código.

#3 – Aprovando a transferência

Experimente adicionar chamadas à função de swap no if de compra e de venda do executeCycle. Isso fará com que a transação seja corretamente gerada e enviada para a blockchain. Inclusive você vai receber um recibo da transação como retorno, como abaixo.

No entanto, você vai verificar que nada vai acontecer no saldo das moedas da sua carteira. Então experimente pegar o valor do campo hash e colocar no BSC Testnet Etherscan e verá um erro que indica que internamente o contrato da DEX tentou fazer uma operação transferFrom, nativa dos tokens ERC20 mas falhou.

Mas por que falhou, se o código estava todo correto?

Isso porque a função transferFrom, conforme especificação ERC-20, permite que um contrato faça transferência de fundos de uma conta para outra, no entanto isso requer uma aprovação prévia (allowance) do dono da carteira que terá seus fundos transferidos delegando essa permissão para o contrato que fará a transferência, a DEX neste caso.

Resumindo: a DEX não pode sair transferindo seus tokens sem a sua aprovação prévia e é isso o que aconteceu aqui. Tentamos fazer a transferência, mas mesmo com a chave privada em mãos, sem autorização prévia e específica para o contrato da DEX, não rola.

Para dar esta permissão vamos criar mais uma função em nosso index.js, que vou chamar de approve, já que este é o nome presente na especificação. Se olharmos olharmos a mesma veremos que a função approve do smart contract deve ter a seguinte assinatura (em Solidity).

O primeiro parâmetro é o endereço do contrato que vamos dar a permissão e o segundo parâmetro é a quantidade que vamos autorizar deste token. Esta função approve está presente em todos os contratos de token, e devemos chamá-la sempre antes de um transferFrom onde vamos gastar/enviar tokens daquele contrato em questão.

Assim, uma versão da função approve no index.js pode ser vista abaixo.

Recebemos por parâmetro o objeto do contrato do token e usamos ele para chamar a função approve, passando como primeiro parâmetro quem poderá gastar nosso token (o router da dex) e qual a quantia, aguardando até o final antes de avançar.

Com esta função pronta, agora voltamos ao executeCycle e vamos inserir a lógica de approve sempre antes de um swap.

Repare como programei a função approve e swap de forma que eu consigo usar elas tanto na compra quanto na venda, apenas mudando os endereços dos contratos. Na compra aprovamos o gasto de TOKEN1 e trocamos ele por TOKEN0. Já na venda aprovamos o gasto de TOKEN0 e trocamos ele por TOKEN1.

Não apenas isso, mas também usei da variável de controle isApproved para determinar se já fizemos a aprovação inicial (para compra), pois assim conseguimos deixar pré-aprovado antes da primeira compra acontecer, o que nos trará agilidade quando isso for necessário. O mesmo vale para a aprovação de venda, que eu já deixo pré-aprovada para a dex assim que compro as moedas, a fim de ganhar agilidade na venda.

Claro que por segurança você pode só aprovar imediatamente antes de fazer a transferência de fato, mas neste caso saiba que corre o risco de demorar demais a sua compra e venda, pois serão duas transações para concluir a negociação ao invés de uma.

Dica Bônus: uma dica para que consiga testar melhor o bot é rodar um fork da BSC Mainnet na sua máquina. Você pode simular isso facilmente usando a HardHat Network que ensinei como neste tutorial. Uma vez com ela forkando a BSC, você terá muito BNB para os testes (10k), bastando converter parte deles para WBNB, o que pode ser feito usando a função deposit do contrato WBNB (não esqueça de copiar o ABI do contrato WBNB pois o ERC20 padrão não tem função deposit). Assim, com WBNB e um fork da BSC Mainnet, você conseguirá testar o swap em cima de qualquer pool pareado com WBNB.

Está tendo erros? Consulte no meu guia de erros comuns de integração com PancakeSwap, neste link.

E com isso finalizamos o nosso bot trader de criptomoedas na dex PancakeSwap. Quer aprender outro, desta vez para UniSwap? Confira este tutorial.