@ethersphere/swarm-cli/src/command/cheque/cashout.ts

CLI tool for Bee

import { BZZ } from '@ethersphere/bee-js'
import chalk from 'chalk'
import { LeafCommand, Option } from 'furious-commander'
import { createKeyValue } from '../../utils/text'
import { ChequeCommand } from './cheque-command'

export class Cashout extends ChequeCommand implements LeafCommand {
  public readonly name = 'cashout'
  public readonly alias = 'co'
  public readonly description = 'Cashout one or all pending cheques'

  @Option({ key: 'peer', alias: 'p', description: 'Peer address', required: true, conflicts: 'all' })
  public peer!: string | null

  @Option({
    key: 'all',
    alias: 'a',
    type: 'boolean',
    description: 'Cashout all cheques',
    required: true,
    conflicts: 'peer',
  })
  public all!: boolean

  @Option({
    key: 'minimum',
    alias: 'm',
    type: 'bigint',
    minimum: BigInt(1),
    description: 'Cashout cheques with balance above this value in PLUR',
    default: BigInt(1),
  })
  public minimum!: bigint

  @Option({
    key: 'gas-limit',
    type: 'bigint',
    minimum: BigInt(0),
    description: 'Gas limit of each transaction in wei',
  })
  public gasLimit!: bigint

  @Option({
    key: 'gas-price',
    type: 'bigint',
    minimum: BigInt(0),
    description: 'Gas price of each transaction in wei',
  })
  public gasPrice!: bigint

  public async run(): Promise<void> {
    super.init()

    if (this.all) {
      await this.cashoutAll()
    }

    if (this.peer) {
      const amount = await this.getUncashedAmount(this.peer)
      await this.cashoutOne(this.peer, amount)
    }
  }

  private async cashoutAll(): Promise<void> {
    this.console.info(`Collecting cheques with value at least ${this.minimum} PLUR...`)
    const cheques = await this.getFilteredCheques(this.minimum)
    this.console.info('Found ' + cheques.length + ' cheques.')
    for (const { amount, address } of cheques) {
      await this.cashoutOne(address, amount)
    }
  }

  private async cashoutOne(address: string, amount: BZZ): Promise<void> {
    try {
      this.console.log(chalk.green('Cashing out:'))
      this.printCheque({ address, amount })
      const transaction = await this.bee.cashoutLastCheque(address, {
        gasLimit: this.gasLimit,
        gasPrice: this.gasPrice,
      })
      this.console.log(createKeyValue('Tx', transaction.toHex()))
      this.console.quiet(transaction.toHex())
    } catch (error) {
      this.console.error('Could not cashout ' + address)
      this.console.printBeeError(error, { notFoundMessage: 'No peer found with that address.' })
    }
  }
}