Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

conditionally formats cli transactions output #3708

Merged
merged 3 commits into from
Mar 30, 2023
Merged

conditionally formats cli transactions output #3708

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
decbb0a
conditionally formats cli transactions output
hughy Mar 28, 2023
68cb2b5
removes default formatted value in getTransactionRows
hughy Mar 29, 2023
2e3902a
defines enum for oclif table format
hughy Mar 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 62 additions & 47 deletions ironfish-cli/src/commands/wallet/transactions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ export class TransactionsCommand extends IronfishCommand {
const { flags, args } = await this.parse(TransactionsCommand)
const account = args.account as string | undefined

const formatted = flags.csv !== true && flags.output === undefined

const client = await this.sdk.connectRpc()
const response = client.getAccountTransactionsStream({
account,
Expand All @@ -57,12 +59,12 @@ export class TransactionsCommand extends IronfishCommand {
confirmations: flags.confirmations,
})

const columns = this.getColumns(flags.extended)
const columns = this.getColumns(flags.extended, formatted)

let showHeader = !flags['no-header']

for await (const transaction of response.contentStream()) {
const transactionRows = this.getTransactionRows(transaction)
const transactionRows = this.getTransactionRows(transaction, formatted)

CliUx.ux.table(transactionRows, columns, {
printLine: this.log.bind(this),
Expand All @@ -76,78 +78,65 @@ export class TransactionsCommand extends IronfishCommand {

getTransactionRows(
transaction: GetAccountTransactionsResponse,
formatted = true,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't look like we use this default value

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True! I'll remove the default

): PartialRecursive<TransactionRow>[] {
const nativeAssetId = Asset.nativeId().toString('hex')

const nativeAssetBalanceDelta = transaction.assetBalanceDeltas.find(
(d) => d.assetId === nativeAssetId,
const assetBalanceDeltas = transaction.assetBalanceDeltas.sort((d) =>
d.assetId === nativeAssetId ? -1 : 1,
)

let amount = BigInt(nativeAssetBalanceDelta?.delta ?? '0')

let feePaid = BigInt(transaction.fee)

if (transaction.type !== TransactionType.SEND) {
feePaid = 0n
} else {
amount += feePaid
}
const feePaid = transaction.type === TransactionType.SEND ? BigInt(transaction.fee) : 0n

const transactionRows = []

const assetCount = transaction.assetBalanceDeltas.length
const isGroup = assetCount > 1

// $IRON should appear first if it is the only asset in the transaction or the net amount was non-zero
if (!isGroup || amount !== 0n) {
transactionRows.push({
...transaction,
group: isGroup ? '┏' : '',
assetId: nativeAssetId,
assetName: Buffer.from('$IRON').toString('hex'),
amount,
feePaid,
})
}
let assetCount = assetBalanceDeltas.length

for (const [index, { assetId, assetName, delta }] of assetBalanceDeltas.entries()) {
let amount = BigInt(delta)

for (const [
index,
{ assetId, assetName, delta },
] of transaction.assetBalanceDeltas.entries()) {
// skip the native asset, added above
if (assetId === Asset.nativeId().toString('hex')) {
continue
if (transaction.type === TransactionType.SEND) {
amount += feePaid
}

// exclude the native asset in formatted output if no amount was sent/received
if (formatted && amount === 0n) {
assetCount -= 1
continue
}
}

if (transactionRows.length === 0) {
// include full transaction details if the native asset had no net change
const group = this.getRowGroup(index, assetCount, transactionRows.length)

// include full transaction details in first row or non-formatted output
if (transactionRows.length === 0 || !formatted) {
transactionRows.push({
...transaction,
group: assetCount === 2 ? '' : '┏',
group,
assetId,
assetName,
amount: BigInt(delta),
amount,
feePaid,
})
} else {
transactionRows.push({
group: index === assetCount - 1 ? '┗' : '┣',
group,
assetId,
assetName,
amount: BigInt(delta),
amount,
})
}
}

return transactionRows
}

getColumns(extended: boolean): CliUx.Table.table.Columns<PartialRecursive<TransactionRow>> {
return {
group: {
header: '',
minWidth: 3,
},
getColumns(
extended: boolean,
formatted: boolean,
): CliUx.Table.table.Columns<PartialRecursive<TransactionRow>> {
const columns: CliUx.Table.table.Columns<PartialRecursive<TransactionRow>> = {
timestamp: TableCols.timestamp({
streaming: true,
}),
Expand Down Expand Up @@ -191,7 +180,7 @@ export class TransactionsCommand extends IronfishCommand {
get: (row) =>
row.feePaid && row.feePaid !== 0n ? CurrencyUtils.renderIron(row.feePaid) : '',
},
...TableCols.asset({ extended }),
...TableCols.asset({ extended, formatted }),
amount: {
header: 'Net Amount',
get: (row) => {
Expand All @@ -201,11 +190,37 @@ export class TransactionsCommand extends IronfishCommand {
minWidth: 16,
},
}

if (formatted) {
return {
group: {
header: '',
minWidth: 3,
},
...columns,
}
}

return columns
}

getRowGroup(index: number, assetCount: number, assetRowCount: number): string {
if (assetCount > 1) {
if (assetRowCount === 0) {
return '┏'
} else if (assetRowCount > 0 && index < assetCount - 1) {
return '┣'
} else if (assetRowCount > 0 && index === assetCount - 1) {
return '┗'
}
}

return ''
}
}

type TransactionRow = {
group: string
group?: string
timestamp: number
status: string
type: string
Expand Down
7 changes: 4 additions & 3 deletions ironfish-cli/src/utils/table.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,15 @@ const timestamp = <T extends Record<string, unknown>>(options?: {

const asset = <T extends Record<string, unknown>>(options?: {
extended?: boolean
formatted?: boolean
}): Partial<Record<string, table.Column<T>>> => {
if (options?.extended) {
if (options?.extended || options?.formatted === false) {
return {
assetId: {
header: 'Asset ID',
get: (row) => row['assetId'],
minWidth: MAX_ASSET_NAME_COLUMN_WIDTH,
extended: true,
extended: options.formatted ?? true,
},
assetName: {
header: 'Asset Name',
Expand All @@ -78,7 +79,7 @@ const asset = <T extends Record<string, unknown>>(options?: {
return truncateCol(assetName, MAX_ASSET_NAME_COLUMN_WIDTH)
},
minWidth: MAX_ASSET_NAME_COLUMN_WIDTH,
extended: true,
extended: options.formatted ?? true,
},
}
} else {
Expand Down