Base64.sol 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. // SPDX-License-Identifier: MIT
  2. // OpenZeppelin Contracts (last updated v5.0.0) (utils/Base64.sol)
  3. pragma solidity ^0.8.20;
  4. /**
  5. * @dev Provides a set of functions to operate with Base64 strings.
  6. */
  7. library Base64 {
  8. /**
  9. * @dev Base64 Encoding/Decoding Table
  10. */
  11. string internal constant _TABLE = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  12. /**
  13. * @dev Converts a `bytes` to its Bytes64 `string` representation.
  14. */
  15. function encode(bytes memory data) internal pure returns (string memory) {
  16. /**
  17. * Inspired by Brecht Devos (Brechtpd) implementation - MIT licence
  18. * https://github.com/Brechtpd/base64/blob/e78d9fd951e7b0977ddca77d92dc85183770daf4/base64.sol
  19. */
  20. if (data.length == 0) return "";
  21. // Loads the table into memory
  22. string memory table = _TABLE;
  23. // Encoding takes 3 bytes chunks of binary data from `bytes` data parameter
  24. // and split into 4 numbers of 6 bits.
  25. // The final Base64 length should be `bytes` data length multiplied by 4/3 rounded up
  26. // - `data.length + 2` -> Round up
  27. // - `/ 3` -> Number of 3-bytes chunks
  28. // - `4 *` -> 4 characters for each chunk
  29. string memory result = new string(4 * ((data.length + 2) / 3));
  30. /// @solidity memory-safe-assembly
  31. assembly {
  32. // Prepare the lookup table (skip the first "length" byte)
  33. let tablePtr := add(table, 1)
  34. // Prepare result pointer, jump over length
  35. let resultPtr := add(result, 32)
  36. // Run over the input, 3 bytes at a time
  37. for {
  38. let dataPtr := data
  39. let endPtr := add(data, mload(data))
  40. } lt(dataPtr, endPtr) {
  41. } {
  42. // Advance 3 bytes
  43. dataPtr := add(dataPtr, 3)
  44. let input := mload(dataPtr)
  45. // To write each character, shift the 3 bytes (18 bits) chunk
  46. // 4 times in blocks of 6 bits for each character (18, 12, 6, 0)
  47. // and apply logical AND with 0x3F which is the number of
  48. // the previous character in the ASCII table prior to the Base64 Table
  49. // The result is then added to the table to get the character to write,
  50. // and finally write it in the result pointer but with a left shift
  51. // of 256 (1 byte) - 8 (1 ASCII char) = 248 bits
  52. mstore8(resultPtr, mload(add(tablePtr, and(shr(18, input), 0x3F))))
  53. resultPtr := add(resultPtr, 1) // Advance
  54. mstore8(resultPtr, mload(add(tablePtr, and(shr(12, input), 0x3F))))
  55. resultPtr := add(resultPtr, 1) // Advance
  56. mstore8(resultPtr, mload(add(tablePtr, and(shr(6, input), 0x3F))))
  57. resultPtr := add(resultPtr, 1) // Advance
  58. mstore8(resultPtr, mload(add(tablePtr, and(input, 0x3F))))
  59. resultPtr := add(resultPtr, 1) // Advance
  60. }
  61. // When data `bytes` is not exactly 3 bytes long
  62. // it is padded with `=` characters at the end
  63. switch mod(mload(data), 3)
  64. case 1 {
  65. mstore8(sub(resultPtr, 1), 0x3d)
  66. mstore8(sub(resultPtr, 2), 0x3d)
  67. }
  68. case 2 {
  69. mstore8(sub(resultPtr, 1), 0x3d)
  70. }
  71. }
  72. return result;
  73. }
  74. }