diff --git a/.gitignore b/.gitignore index cd8575c..f31cb8f 100644 --- a/.gitignore +++ b/.gitignore @@ -22,8 +22,19 @@ # Environment variables .env +# Rendered outputs +/tmp + # AGENTS.md file /AGENTS.md # References directory /references + +# assets/fonts is ignored by default. +assets/fonts/**/* +assets/fonts/**/* +!assets/fonts/**/LICENSE +!assets/fonts/**/*.ttf + + diff --git a/.prettierignore b/.prettierignore index c4a4161..bc7806c 100644 --- a/.prettierignore +++ b/.prettierignore @@ -6,3 +6,5 @@ node_modules .env pnpm-lock.yaml references +tmp +assets/fonts/**/*.subset.chunks.json diff --git a/assets/fonts/caveat/Caveat-Bold.ttf b/assets/fonts/caveat/Caveat-Bold.ttf new file mode 100644 index 0000000..c67a646 Binary files /dev/null and b/assets/fonts/caveat/Caveat-Bold.ttf differ diff --git a/assets/fonts/caveat/LICENSE b/assets/fonts/caveat/LICENSE new file mode 100644 index 0000000..6e5220c --- /dev/null +++ b/assets/fonts/caveat/LICENSE @@ -0,0 +1,93 @@ +Copyright 2014 The Caveat Project Authors (https://github.com/googlefonts/caveat) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/assets/fonts/inter/Inter.ttf b/assets/fonts/inter/Inter.ttf new file mode 100644 index 0000000..047c92f Binary files /dev/null and b/assets/fonts/inter/Inter.ttf differ diff --git a/assets/fonts/inter/LICENSE b/assets/fonts/inter/LICENSE new file mode 100644 index 0000000..21f6aff --- /dev/null +++ b/assets/fonts/inter/LICENSE @@ -0,0 +1,93 @@ +Copyright 2020 The Inter Project Authors (https://github.com/rsms/inter) + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +https://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/contracts/BiscuitBuilder.sol b/contracts/BiscuitBuilder.sol index e455a18..ad02335 100644 --- a/contracts/BiscuitBuilder.sol +++ b/contracts/BiscuitBuilder.sol @@ -5,6 +5,7 @@ import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol"; import {IBiscuitBuilder} from "./interfaces/IBiscuitBuilder.sol"; import {IBiscuitFont} from "./interfaces/IBiscuitFont.sol"; import {IMnemonic} from "./interfaces/IMnemonic.sol"; +import {Base64} from "@openzeppelin/contracts/utils/Base64.sol"; import {BiscuitMetadata} from "./libs/BiscuitMetadata.sol"; import {BiscuitRenderer} from "./libs/BiscuitRenderer.sol"; import {Utils} from "./libs/Utils.sol"; @@ -121,8 +122,8 @@ contract BiscuitBuilder is Ownable, IBiscuitBuilder { ) internal view returns (BiscuitRenderer.SVGParams memory) { return BiscuitRenderer.SVGParams({ - letters: font.letters(), - digits: font.digits(), + letters: bytes(Base64.encode(font.letters())), + digits: bytes(Base64.encode(font.digits())), mnemonic: mnemonic.generateMnemonic(seed.mnemonicStrength, seed.mnemonicSeed) }); } diff --git a/contracts/BiscuitFont.sol b/contracts/BiscuitFont.sol index 56b110d..f14ff13 100644 --- a/contracts/BiscuitFont.sol +++ b/contracts/BiscuitFont.sol @@ -34,21 +34,21 @@ contract BiscuitFont is IBiscuitFont, Ownable { } /** - * @notice Return the concatenated letters binary payload. + * @notice Return the concatenated letters raw woff2 payload. */ function letters() public view override returns (bytes memory) { return _concatenate(_letters); } /** - * @notice Return the concatenated digits binary payload. + * @notice Return the concatenated digits raw woff2 payload. */ function digits() public view override returns (bytes memory) { return _concatenate(_digits); } /** - * @notice Add a batch of Letters images. + * @notice Add a batch of Letters font data. * @dev This function can only be called by the owner. * Uses the “Caveat” typeface by Impallari Type for creating this letters. * License: https://fonts.google.com/specimen/Caveat/license @@ -59,7 +59,7 @@ contract BiscuitFont is IBiscuitFont, Ownable { } /** - * @notice Add a batch of Digits images. + * @notice Add a batch of Digits font data. * @dev This function can only be called by the owner. * Uses the “Inter” typeface by Impallari Type for creating this letters. * License: https://fonts.google.com/specimen/Inter/license diff --git a/contracts/libs/BiscuitRenderer.sol b/contracts/libs/BiscuitRenderer.sol index a41361b..da86640 100644 --- a/contracts/libs/BiscuitRenderer.sol +++ b/contracts/libs/BiscuitRenderer.sol @@ -42,17 +42,17 @@ library BiscuitRenderer { '