Notepad Example (spruceid#6)

* Draft quickstart section for README

* Remove lowerCase from lib

* Notepad Example

* Fix WalletConnect

* Fix build command

* Remove alert from disconnect

* Add .env to README

* Fix dev npm script

* fixed up example readme

* Make .env optional and add warning when not present

* Fix clock

* updated readme and added brand assets

* fixup: license location

* fixup: license name

* fixup: license capitalization

* Block selection of clock text and sets cursor to default

* README improvements

- Update text in notepad README.md
- Add run examples to main README.md

* Persists connection, add extension to files

* Save button

* Unsaved message update

* Increase min-width

Co-authored-by: Gregório Granado Magalhães <[email protected]>
Co-authored-by: Gregory Rocco <[email protected]>

.npmignore

@@ -0,0 +1,3 @@
+examples/
+favicon.svg
+jest.config.js

README.md

@@ -9,6 +9,23 @@ Ethereum-based authentication, and provide wallet vendors a consistent
 machine-readable message format to achieve improved user experiences and 
 consent management.
 
+## [Quickstart Example](./examples/notepad)
+To try it out locally, there is an example that uses Sign-In With Ethereum to
+create a notepad that persists to a server after a user authenticates with
+their Ethereum address.
+
+![Sign-In with Ethereum Notepad](./examples/notepad/notepad.png "Sign-In with Ethereum Notepad")
+
+To use the example, run the following commands:
+```bash
+git clone https://github.com/spruceid/siwe
+cd siwe/examples/notepad
+npm install
+npm run dev
+```
+
+See the example README.md for more details.
+
 ## Motivation
 When signing in to popular non-blockchain services today, users will typically 
 use identity providers (IdPs) that are centralized entities with ultimate 
@@ -31,4 +48,5 @@ user interviews with a focus on currently-in-production uses, related prior
 EIPs, and fits within product roadmaps.
 
 ## Specification
-Specification can be found at the [EIP-4361 GitHub page](https://github.com/ethereum/EIPs/blob/9a9c5d0abdaf5ce5c5dd6dc88c6d8db1b130e95b/EIPS/eip-4361.md).
+Specification can be found at the [EIP-4361 GitHub page](https://github.com/ethereum/EIPs/blob/9a9c5d0abdaf5ce5c5dd6dc88c6d8db1b130e95b/EIPS/eip-4361.md).
+

assets/License.md

@@ -0,0 +1,41 @@
+# Creative Commons CC0 1.0 Universal
+
+CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER.
+
+### Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. __Copyright and Related Rights.__ A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following:
+
+    i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work;
+
+    ii. moral rights retained by the original author(s) and/or performer(s);
+
+    iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work;
+
+    iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below;
+
+    v. rights protecting the extraction, dissemination, use and reuse of data in a Work;
+
+    vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and
+
+    vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof.
+
+2. __Waiver.__ To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. __Public License Fallback.__ Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose.
+
+4. __Limitations and Disclaimers.__
+
+    a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document.
+
+    b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law.
+
+    c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work.
+
+    d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work.

assets/README.md

@@ -0,0 +1,9 @@
+# Sign-In with Ethereum Brand Assets
+The Sign-In with Ethereum brand assets include the logo, logomark, and icons associated with the project. 
+
+All of the assets in this directory are being released under a CC0 1.0 license (see: [license.md](License.md) in this directory) for the public to use and incorporate them where they wish to. 
+
+## Sign-In with Ethereum Buttons
+For those incorporating Sign-In with Ethereum into their project and require a button for users, one design has been included in the set of included assets, but some additional designs have been provided by `Cousin Eddie#5625` in the Spruce Discord server with confirmation of a CC0 waiver.
+
+Those examples can be found [here](https://www.figma.com/file/UUqhgK03wwVxiKjzw90Nuh/Sign-In-With-Ethereum---Button-Designs?node-id=0%3A1).

examples/notepad/.env.example

@@ -0,0 +1,3 @@
+ENVIRONMENT=development
+SECRET=siwe
+SESSION_COOKIE_NAME=siwe-notepad-session

examples/notepad/.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: "module",
+    ecmaFeatures: {
+      jsx: true
+    }
+  },
+  extends: [
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended"
+  ],
+};

examples/notepad/.gitignore

@@ -0,0 +1,5 @@
+node_modules
+.env
+build
+public/*bundle*js*
+db/

examples/notepad/.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+    semi: true,
+    trailingComma: "all",
+    singleQuote: true,
+    printWidth: 100,
+    tabWidth: 4,
+};

examples/notepad/README.md

@@ -0,0 +1,26 @@
+# Sign-In with Ethereum Notepad Example
+Example usage of the Sign-In with Ethereum (SIWE) library.
+
+![Sign-In with Ethereum Notepad](./notepad.png "Sign-In with Ethereum Notepad")
+
+## Quickstart
+From this directory,
+```bash
+npm install
+npm run dev
+```
+
+## Try the example
+Open your browser at `http://localhost:4361` and have fun!
+
+Select one of the providers available (Metamask, WalletConnect) to begin a SIWE-based
+session. Write anything you want and hit the "Save" button (you can also use
+Cmd+s/Ctrl+s to save). You can refresh the page or close your tab -  just don't
+delete your session cookie and your text will continue to be there until you
+decide to delete the folder `/db`, where sessions are stored.
+
+### Note on port selection
+At the top of the `src/index.ts` file there is a variable that is the default port
+used. If you want to use the provided Infura ID, select one of the following ports: 
+`3000`,`3010`,`4000`,`4010`,`4361`,`9080`. Otherwise you'll be unable to connect 
+to Infura.