Solidity String Concatenation: A How-To Guide

• Introduction
• Step-by-Step Guide
• Code Example
• Additional Notes
• Summary
• Conclusion
• References

Before Solidity 0.8.12, concatenating strings was not straightforward. Developers had to use workarounds like abi.encodePacked, which is designed for data encoding and can produce unexpected outcomes when used with strings. This changed with Solidity 0.8.12.

Prior to Solidity version 0.8.12, string concatenation wasn't directly supported. Developers often resorted to using abi.encodePacked, which is primarily for encoding data and can lead to unexpected results with strings.

However, from Solidity 0.8.12 onwards, you can directly concatenate strings using the string.concat() function.

string memory str1 = "Hello";
string memory str2 = "World";
string memory combined = string.concat(str1, ", ", str2, "!");
// combined will be "Hello, World!"

This function takes any number of string arguments and combines them into a new string.

This Solidity code demonstrates two methods of string concatenation: the older abi.encodePacked method and the newer string.concat method introduced in Solidity 0.8.12. The code provides examples of using both methods and highlights the benefits of using string.concat for its readability, efficiency, and ability to handle multiple string arguments. The code emphasizes that string.concat is the preferred method for string concatenation in Solidity 0.8.12 and above.

This example demonstrates the different approaches to string concatenation in Solidity, highlighting the improvements introduced in version 0.8.12.

pragma solidity ^0.8.12;

contract StringConcatenation {

    // String concatenation using abi.encodePacked (pre-0.8.12)
    function concatenateWithEncodePacked(string memory str1, string memory str2) public pure returns (string memory) {
        return string(abi.encodePacked(str1, ", ", str2));
    }

    // String concatenation using string.concat (from 0.8.12 onwards)
    function concatenateWithStringConcat(string memory str1, string memory str2) public pure returns (string memory) {
        return string.concat(str1, ", ", str2);
    }

    // Demonstrating the flexibility of string.concat with multiple arguments
    function concatenateMultipleStrings(string memory str1, string memory str2, string memory str3) public pure returns (string memory) {
        return string.concat(str1, " ", str2, " ", str3);
    }
}

Explanation:

1. concatenateWithEncodePacked: This function demonstrates the older approach using abi.encodePacked. While it achieves concatenation, it's not ideal due to potential issues with string encoding.

2. concatenateWithStringConcat: This function showcases the recommended approach using string.concat introduced in Solidity 0.8.12. It's more readable and specifically designed for string concatenation.

3. concatenateMultipleStrings: This function highlights the flexibility of string.concat by taking multiple string arguments and combining them seamlessly.

Key Takeaways:

• Always use string.concat for string concatenation in Solidity 0.8.12 and above.
• Avoid using abi.encodePacked for strings as it can lead to unexpected results.
• string.concat provides a clear and efficient way to combine multiple strings.

• Gas Efficiency: While abi.encodePacked might seem like a solution for older Solidity versions, it can be less gas-efficient than string.concat for strings, especially for multiple concatenations.
• Readability and Maintainability: Using string.concat significantly improves the readability of your code, making it easier for others (and your future self) to understand and maintain.
• Error Handling: Neither abi.encodePacked nor string.concat inherently handle potential errors like exceeding string length limits. Consider implementing checks or using libraries for safer string manipulation in production environments.
• Alternatives for Older Versions: Before Solidity 0.8.12, consider using assembly code or external libraries for more efficient and reliable string concatenation if abi.encodePacked is not suitable.
• Best Practices: Always strive to use the latest Solidity version to leverage the newest features and security improvements. When working with older versions, be aware of limitations and explore alternative solutions for optimal results.
• Security Considerations: When concatenating strings, especially those received from external sources, be mindful of potential security vulnerabilities like injection attacks. Sanitize and validate external inputs before using them in string operations.

Key takeaway: Upgrade to Solidity 0.8.12 or later and use string.concat() for safe and reliable string concatenation.

In conclusion, Solidity's evolution has provided a much-needed improvement for string concatenation. While earlier versions required workarounds like abi.encodePacked, potentially leading to unexpected results, Solidity 0.8.12 introduced string.concat(). This function offers a dedicated, readable, and efficient method for combining strings. Developers should prioritize using string.concat() in Solidity 0.8.12 and later for its clarity and reliability. When working with older versions, explore alternative solutions and be mindful of potential limitations. Regardless of the Solidity version, always prioritize security considerations and best practices when handling strings, especially those from external sources.

• How to Concatenate two strings using Solidity | by ... | String manipulation
• blockchain - String concatenation in solidity? - Stack Overflow | Aug 22, 2015 ... You can't concatenate strings. You also can not check equals ( str0 == str1 ) yet. The string type was just recently added back to the language so it will ...
• How to perform string concatenation in Solidity | Contributor: Fatima Tajammul FAST NU LHR
• How to Concatenate the Strings in Solidity? - | Solidity, we have different built-in functions that offer string concatenation functionality: abi.encodePacked and string.concat functions.
• Simple way to concatenate strings in Solidity | SolidityTips.com | In this quick tip I explain how to concatenate strings in Solidity and why it's done this way.
• Types — Solidity 0.8.29 documentation | You can concatenate an arbitrary number of string values using string.concat . The function returns a single string memory array that contains the contents of ...
• Add support for ERC721 token URI concatenation of base token URI ... | Current ERC721 minting with token URI requires specifying the URI per token. To reduce gas cost, the OpenSea example uses concatenation of a base token URI and the tokenID. (https://github.com/ProjectOpenSea/opensea-creatures/blob/master/contracts/TradeableERC721Token.sol) I used this concatenation on BlockHorses. https://github.com/blockhorses/BlockHorses/blob/master/contracts/BlockHorses.sol https://github.com/blockhorses/BlockHorses/blob/master/contracts/Strings.sol function tokenURI(u...
• Concatenate Strings in Solidity - Blockchain Academy | The following topic explains how you can concatenate strings in Solidity.
• Cheatsheet — Solidity 0.8.28 documentation | string.concat(...) returns (string memory) : Concatenates variable number of arguments to one string array. Members of address. .balance ( uint256 ): ...