Skip to content

Seraphis Wallet Coding Conventions

René Brunner edited this page Nov 18, 2022 · 5 revisions

This is intended as a collection of conventions and guidelines for Seraphis wallet dev work that were discussed and (more or less) agreed on. Maybe this wiki is not yet the best place for it, but it should do for the time being.

Use the term enote, avoid output

enote was "invented" by @UkoeHB as a better and more expressive term to supersede output and used througout his Seraphis library. Use it in Seraphis wallet code.

How far this replacement will go, whether we will later e.g. rename CLI wallet commands to align with this, is at least in part another question of course.

Described in this issue, discussed and decided in workgroup meeting #1

Use the term id for transactions, avoid hash

In the existing Monero codebase the "thing" that uniquely identifies a transaction is sometimes called id, sometimes hash. It seems a good idea to standardize on one term. id was favored in a discussion.

Described in this issue, discussed and decided in workgroup meeting #1

Avoid the term transfer

wallet2 and other parts of the Monero codebase now use the term transfer, but it's used in relation to both transactions and enotes which easily leads to confusion. This convention is important mostly when naming types and variables; method names are probably less critical.

Described in this issue, discussed and decided in workgroup meeting #1

Clone this wiki locally