Mercy Boma Naps Nkari's Blog
A Practical Guide in Choosing Between ABDK Math 64.64 and Custom Fixed Point Library for Solidity

A Practical Guide in Choosing Between ABDK Math 64.64 and Custom Fixed Point Library for Solidity

Mercy Boma Naps Nkari's photo
Mercy Boma Naps Nkari
·

5 min read

Introduction

When working on smart contract development in Solidity, one of the crucial aspects to consider is the choice of libraries to handle fixed-point arithmetic. Fixed-point arithmetic is essential in financial applications, as it allows precise calculations for values such as currency, interest rates, and more. In this article, we will explore the decision-making process between two libraries, ABDK Math 64.64 and a custom fixed-point library, for handling fixed-point operations in your Solidity smart contracts.

ABDK Math 64.64 Library:

The ABDK Math 64.64 library is a well-known and widely used smart contract library for performing mathematical operations on signed 64.64-bit fixed point numbers. It provides a range of functions to perform basic mathematical operations, such as addition, subtraction, multiplication, division, and more.

Technical details:

  1. Data Types:

    • The library uses the int128 data type to represent signed 64.64 fixed-point numbers. It defines constants for the minimum and maximum values that can be represented.

  2. Functions:

    • fromInt(int256 x): Converts a signed 256-bit integer to a signed 64.64 fixed-point number. It checks for overflow.

    • toInt(int128 x): Converts a signed 64.64 fixed-point number to a signed 64-bit integer, rounding down.

    • fromUInt(uint256 x): Converts an unsigned 256-bit integer to a signed 64.64 fixed-point number. It checks for overflow.

    • toUInt(int128 x): Converts a signed 64.64 fixed-point number to an unsigned 64-bit integer, rounding down.

    • Various mathematical operations, such as add, sub, mul, div, pow, sqrt, log\_2, ln, and exp\_2, among others, are provided to work with these fixed-point numbers.

  3. Error Handling:

    • The library handles underflow, overflow, and division by zero conditions to ensure the safe execution of mathematical operations.

key features of ABDK Math 64.64 include:

  1. Range Validation: ABDK Math 64.64 ensures that the results of operations remain within the valid range for signed 64.64-bit fixed point numbers. This prevents overflows and underflows, making it a safe choice for financial applications.

  2. Standardized Functions: The library provides a comprehensive set of functions that cover common mathematical operations, making it convenient for developers to work with fixed-point numbers without needing to implement their own operations.

  3. Error Handling: ABDK Math 64.64 includes error handling mechanisms to detect and handle exceptional cases, such as division by zero or invalid operations, making it suitable for critical financial applications where accuracy is paramount.

  4. Ease of Use: The library is easy to use and well-documented, making it accessible for developers, even those new to fixed-point arithmetic.

Custom Fixed-Point Library

The Simplified Fixed Point Operations library provides functionality for basic fixed-point arithmetic, such as multiplication and division. The library is implemented using inline assembly for gas efficiency.

In some cases, developers may opt to create a custom fixed-point library tailored to their specific application's needs.

key features of Custom Fixed-Point Library include:

  1. Optimization: Custom libraries can be optimized for specific use cases, potentially offering performance improvements over generic libraries like ABDK Math 64.64.

  2. Functionality: A custom library allows developers to implement only the functions they need, reducing the contract's bytecode size and gas costs.

  3. Unique Requirements: If your project has unique requirements that aren't adequately addressed by existing libraries, creating a custom library may be the best approach.

  4. Code Transparency: With a custom library, developers have full control over the codebase, allowing them to audit and modify it as necessary for their application's security and functionality.

Technical details:

  1. Data Types:

    • The library defines a constant, WAD, as 1e18, which serves as the fixed-point denominator.

  2. Functions:

    • mulWad(uint256 x, uint256 y): This function computes (x \* y) / WAD and rounds the result down. It checks for potential overflow.

    • mulWadUp(uint256 x, uint256 y): Similar to mulWad but rounds the result up.

    • divWad(uint256 x, uint256 y): This function computes (x \* WAD) / y and rounds the result down while ensuring division by zero or overflow conditions are not met.

    • divWadUp(uint256 x, uint256 y): Similar to divWad but rounds the result up.

  3. Assembly Code:

    • The library uses Solidity's inline assembly to optimize these operations and handle potential errors, ensuring safe execution.

Factors to Consider When Selecting a Library for Fixed-Point Arithmetic

When deciding between ABDK Math 64.64 and a custom fixed-point library, it's important to take the following considerations into account:

  1. Scope of Functionality: Assess the requirements of your smart contract. If you need a wide range of fixed-point arithmetic operations, ABDK Math 64.64 may be a more convenient choice. For specialized needs, a custom library might be preferable.

  2. Gas Costs: Consider the gas costs associated with using each library. While custom libraries can be optimized, they also require extensive testing to ensure they don't introduce vulnerabilities.

  3. Development Time: Creating a custom library can be time-consuming. Evaluate whether the time investment is justified by the specific needs of your project.

  4. Security: Existing libraries like ABDK Math 64.64 have undergone extensive scrutiny and testing. If security is a top priority, using a well-established library may be the safer option.

Conclusion

The choice between ABDK Math 64.64 and a custom fixed-point library in your Solidity smart contracts ultimately depends on the specific requirements of your project. ABDK Math 64.64 offers a convenient and secure solution for general fixed-point arithmetic, while a custom library may be beneficial if you have unique optimization or functionality needs. Whichever library you choose, thorough testing and auditing are crucial to ensure the security and accuracy of your financial smart contracts.

In the end, both libraries have their advantages, and the decision should be based on the specific needs and constraints of your project.

I'd love to connect with you on Linkedln | Twitter | Github.

Looking forward to catching up with you in my next blog article! Take care and have a great day! 😊

Blockchainblockchain securityWeb3software development