Drain an account

This section shows how to transfer all tokens from one account (implicit or originated) to another so that the source account balance is zero.

Draining implicit accounts (tz1, tz2, tz3)

We want to "empty" an implicit account by sending all of its tokens to another account. It can be tricky to empty a tezos account because the system must subtract the gas fee from the account balance.

To do so, we first need to estimate the fees related to this operation. The estimate property of the TezosToolkit provides access to operation estimation utilities. Calling the transfer method will return an instance of the Estimate class and its suggestedFeeMutez property will allow us to know the fee associated with the operation.

Once we know the associated fees, we can calculate the maximum amount that needs to send to drain the account by subtracting these fees from the account balance.

Finally, we can do the transfer operation and use the maximum amount we just calculated as the amount parameter of the transfer function.

note

In the following example, we have not revealed the account that we want to empty. We need to keep in mind that there are fees related to a reveal operation. We are subtracting 374 mutez from the balance to cover reveal fees.

If the account to drain has already been revealed, you must not subtract the reveal fee from the balance.

Live Editor

// const Tezos = new TezosToolkit('https://ghostnet.ecadinfra.com'); // import { getRevealFee } from "@taquito/taquito"; Tezos.signer .publicKeyHash() .then((address) => { Tezos.tz.getBalance(address).then((balance) => { console.log( `The account we want to drain is ${address}.\nIts initial balance is ${ balance.toNumber() / 1000000 } ꜩ.` ); return Tezos.estimate .transfer({ to: 'tz1PgQt52JMirBUhhkq1eanX8hVd1Fsg71Lr', amount: balance.toNumber() - getRevealFee(address), // Remove default reveal fee mutez: true }) .then((estimate) => { const maxAmount = balance.minus( estimate.suggestedFeeMutez + getRevealFee(address) ).toNumber(); console.log( `The estimated fees related to the emptying operation are ${ estimate.suggestedFeeMutez } mutez.\nThe fees related to the reveal operation are ${ getRevealFee(address) } mutez.\nConsidering those fees, the amount we need to send to empty the account is ${ maxAmount / 1000000 } ꜩ.` ); return Tezos.contract.transfer({ to: 'tz1PgQt52JMirBUhhkq1eanX8hVd1Fsg71Lr', mutez: true, amount: maxAmount, fee: estimate.suggestedFeeMutez, gasLimit: estimate.gasLimit, storageLimit: 0 }); }) .then((op) => { console.log(`Waiting for confirmation of the draining operation...`); return op.confirmation(1).then(() => op.hash); }) .then((hash) => { console.log(`The account has been emptied.`); return Tezos.tz.getBalance(address); }) .then((finalBalance) => { console.log(`The balance is now ${finalBalance.toNumber() / 1000000} ꜩ.`); }); }); }) .catch((error) => console.log(`Error: ${JSON.stringify(error, null, 2)}`));

// const Tezos = new TezosToolkit('https://ghostnet.ecadinfra.com');
// import { getRevealFee } from "@taquito/taquito";

Tezos.signer
    .publicKeyHash()
    .then((address) => {
        Tezos.tz.getBalance(address).then((balance) => {
            console.log(
                `The account we want to drain is ${address}.\nIts initial balance is ${
                  balance.toNumber() / 1000000
                  } ꜩ.`
            );
            return Tezos.estimate
                .transfer({
                    to: 'tz1PgQt52JMirBUhhkq1eanX8hVd1Fsg71Lr',
                    amount: balance.toNumber() - getRevealFee(address), // Remove default reveal fee
                    mutez: true
                })
                .then((estimate) => {
                    const maxAmount = balance.minus(
                      estimate.suggestedFeeMutez + getRevealFee(address)
                    ).toNumber();
                    console.log(
                        `The estimated fees related to the emptying operation are ${
                          estimate.suggestedFeeMutez
                        } mutez.\nThe fees related to the reveal operation are ${
                          getRevealFee(address)
                        } mutez.\nConsidering those fees, the amount we need to send to empty the account is ${
                          maxAmount / 1000000
                        } ꜩ.`
                    );
                    return Tezos.contract.transfer({
                        to: 'tz1PgQt52JMirBUhhkq1eanX8hVd1Fsg71Lr',
                        mutez: true,
                        amount: maxAmount,
                        fee: estimate.suggestedFeeMutez,
                        gasLimit: estimate.gasLimit,
                        storageLimit: 0
                    });
                })
                .then((op) => {
                    console.log(`Waiting for confirmation of the draining operation...`);
                    return op.confirmation(1).then(() => op.hash);
                })
                .then((hash) => {
                    console.log(`The account has been emptied.`);
                    return Tezos.tz.getBalance(address);
                })
                .then((finalBalance) => {
                    console.log(`The balance is now ${finalBalance.toNumber() / 1000000} ꜩ.`);
                });
        });
    })
    .catch((error) => console.log(`Error: ${JSON.stringify(error, null, 2)}`));

Result

Draining originated accounts (KT1)

In the following example, we first originate a contract with a starting balance of 8 ꜩ. Then, we transfer all of its tokens to an implicit account.

The contract we originate is a manager contract. It has a do method taking a lambda function as a parameter. We call the smart contract by passing a function called transferImplicit to its do method to transfer its tokens to the implicit address. More information on transfers involving originated KT1 addresses can be found here.

In the example, we estimate the transfer operation before doing it. The associated fees are deducted from the manager's address when draining the account. Thus, for the operation to be successful, the manager's address for that account must contain funds to cover the gas.

Live Editor

// const Tezos = new TezosToolkit('https://ghostnet.ecadinfra.com'); function transferImplicit(key, mutez) { return [ { prim: 'DROP' }, { prim: 'NIL', args: [{ prim: 'operation' }] }, { prim: 'PUSH', args: [{ prim: 'key_hash' }, { string: key }], }, { prim: 'IMPLICIT_ACCOUNT' }, { prim: 'PUSH', args: [{ prim: 'mutez' }, { int: `${mutez}` }], }, { prim: 'UNIT' }, { prim: 'TRANSFER_TOKENS' }, { prim: 'CONS' }, ]; } Tezos.signer .publicKeyHash() .then((address) => { Tezos.contract .originate({ balance: '8', code: managerCode, init: { string: address }, }) .then((contractOrigination) => { console.log( `Waiting for confirmation of origination for ${contractOrigination.contractAddress}...` ); return contractOrigination.contract(); }) .then((contract) => { console.log(`Origination completed.`); Tezos.tz.getBalance(contract.address).then((balance) => { console.log(`The balance of the contract is ${balance.toNumber() / 1000000} ꜩ.`); const estimateOp = contract.methodsObject .do(transferImplicit('tz1PgQt52JMirBUhhkq1eanX8hVd1Fsg71Lr', balance.toNumber())) .toTransferParams({}); console.log(`Waiting for the estimation of the smart contract call...`); Tezos.estimate .transfer(estimateOp) .then((estimate) => { //Will be deducted from manager's address console.log( `The estimated fees related to the emptying operation are ${estimate.suggestedFeeMutez} mutez.` ); return contract.methodsObject .do(transferImplicit('tz1PgQt52JMirBUhhkq1eanX8hVd1Fsg71Lr', balance.toNumber())) .send({ amount: 0 }); }) .then((operation) => { console.log(`Waiting for confirmation of the draining operation...`); return operation.confirmation(1).then(() => operation.hash); }) .then((hash) => { console.log(`The account has been emptied.`); return Tezos.tz.getBalance(contract.address); }) .then((finalBalance) => { console.log(`The balance is now ${finalBalance.toNumber() / 1000000} ꜩ.`); }); }); }); }) .catch((error) => console.log(`Error: ${JSON.stringify(error, null, 2)}`));

// const Tezos = new TezosToolkit('https://ghostnet.ecadinfra.com');

function transferImplicit(key, mutez) {
  return [
    { prim: 'DROP' },
    { prim: 'NIL', args: [{ prim: 'operation' }] },
    {
      prim: 'PUSH',
      args: [{ prim: 'key_hash' }, { string: key }],
    },
    { prim: 'IMPLICIT_ACCOUNT' },
    {
      prim: 'PUSH',
      args: [{ prim: 'mutez' }, { int: `${mutez}` }],
    },
    { prim: 'UNIT' },
    { prim: 'TRANSFER_TOKENS' },
    { prim: 'CONS' },
  ];
}

Tezos.signer
  .publicKeyHash()
  .then((address) => {
    Tezos.contract
      .originate({
        balance: '8',
        code: managerCode,
        init: { string: address },
      })
      .then((contractOrigination) => {
        console.log(
          `Waiting for confirmation of origination for ${contractOrigination.contractAddress}...`
        );
        return contractOrigination.contract();
      })
      .then((contract) => {
        console.log(`Origination completed.`);
        Tezos.tz.getBalance(contract.address).then((balance) => {
          console.log(`The balance of the contract is ${balance.toNumber() / 1000000} ꜩ.`);
          const estimateOp = contract.methodsObject
            .do(transferImplicit('tz1PgQt52JMirBUhhkq1eanX8hVd1Fsg71Lr', balance.toNumber()))
            .toTransferParams({});
          console.log(`Waiting for the estimation of the smart contract call...`);
          Tezos.estimate
            .transfer(estimateOp)
            .then((estimate) => {
              //Will be deducted from manager's address
              console.log(
                `The estimated fees related to the emptying operation are ${estimate.suggestedFeeMutez} mutez.`
              );
              return contract.methodsObject
                .do(transferImplicit('tz1PgQt52JMirBUhhkq1eanX8hVd1Fsg71Lr', balance.toNumber()))
                .send({ amount: 0 });
            })
            .then((operation) => {
              console.log(`Waiting for confirmation of the draining operation...`);
              return operation.confirmation(1).then(() => operation.hash);
            })
            .then((hash) => {
              console.log(`The account has been emptied.`);
              return Tezos.tz.getBalance(contract.address);
            })
            .then((finalBalance) => {
              console.log(`The balance is now ${finalBalance.toNumber() / 1000000} ꜩ.`);
            });
        });
      });
  })
  .catch((error) => console.log(`Error: ${JSON.stringify(error, null, 2)}`));

Result