Skip to content

retire

The opposite for create action, if all validations succeed, it debits the stat table supply amount.

  • Parameters
FieldsTypeDescription
quantityeosio::assetThe quantity of tokens to retire
memostringThe memo string to accompany the transaction

Required Permissions: issuer

  • cleos Example
shell
cleos push action eosio.token retire '["100.00000000 UOS", "burn"]' -p eosio
  • eos-js Example
typescript
(async () => {
    const result = await api.transact(
        {
            actions: [
                {
                    account: 'eosio.token',
                    name: 'retire',
                    authorization: [
                        {
                            actor: 'eosio',
                            permission: 'active',
                        },
                    ],
                    data: {
                        quantity: '100.00000000 UOS',
                        memo: 'burn',
                    },
                },
            ],
        },
        {
            blocksBehind: 3,
            expireSeconds: 30,
        }
    );
})();