docs: update protocol-reference.md

.eslintrc.js

@@ -1,4 +1,5 @@
 module.exports = {
+  parser: 'babel-eslint',
   ignorePatterns: ['build/*'],
   env: {
     browser: true,
@@ -19,10 +20,17 @@ module.exports = {
   },
   plugins: ['react'],
   rules: {
+    'generator-star-spacing': [
+      'error',
+      {
+        before: false,
+        after: true
+      }
+    ],
     'space-before-function-paren': [
       'error',
       {
-        anonymous: 'never',
+        anonymous: 'always',
         named: 'never',
         asyncArrow: 'always'
       }

.gitignore

@@ -10,5 +10,8 @@ yarn-error.log
 
 # App specific
 #
-build/
+build/favicon.ico
+!build/*.html
+!build/sitemap.xml
+!build/**/*.html
 config.js

CONTRIBUTING.md

@@ -0,0 +1,127 @@
+Nano.Community aims to be a community run project and is grateful to all that step up to contribute. You don't need permission to work on anything, but it's always best to let others know what you're planning to do. You can do this by:
+
+- Commenting on an [issue or PR in GitHub](https://github.com/mistakia/nano-community/issues)
+- Messaging on the [Nano Discord server](https://chat.nano.org/) (dm: trashman#2397)
+- Starting a [discussion](https://github.com/mistakia/nano-community/discussions)
+
+Before contributing, make sure you're familiar with <a href="https://guides.github.com/introduction/flow/index.html" tagret="_blank">GitHub Flow</a>.
+
+### Contributing content
+
+All you need is a GitHub account to contribute. Every page is a MarkDown file, which is an <a href="https://guides.github.com/features/mastering-markdown/" target="_blank">easy to learn syntax</a>.
+
+#### Submitting Edits
+
+- Use the "edit page" button on the site to navigate to the document on the github repository
+- Make sure to sign in or create a GitHub account
+- Once logged in, start editing by clicking the "edit file" icon in the top right
+- Make changes, then click "propose changes". On the next page click "Create Pull Request" to submit.
+
+#### Responding to Change Requests
+
+Occasionally, changes will be requested for proposed changes. Navigate to your pull request to respond with any questions or comments. To make changes, navigate to the branch you used on your fork, make changes and commit them. The pull request will then be automatically updated with those changes.
+
+#### Rules
+
+1. [Write simply](http://www.paulgraham.com/simply.html)
+1. Keep content for users concise, while detailed for developers
+1. When possible, direct users to existing content on the [official Nano documentation](https://docs.nano.org/)
+1. Use an impartial tone and neutral point of view. Content should be as objective as possible.
+1. Pull requests are preferred to issues, especially for small changes such as typos.
+1. Issues should be used for reporting bugs, typos, or other specific content
+1. Discussions should be used for generic or broad-based changes or missing content (i.e. suggesting a faq, or content section)
+1. Smaller pull requests are preferred over a single large one.
+1. Limit mentioning or using content that changes over time, to prevent content from going stale and needing updates
+
+### Contributing code
+
+JavaScript & markdown are used to make the project as accessible as possible.
+
+```
+|-- api         node.js api server for posts, network stats
+|-- build       static html react entry points generated by react-snap
+|-- db          schema for mysql
+|-- docs        wiki & knowledge hub
+|-- scripts     data aggregation or processing
+|-- server      server configs
+|-- src         single page react app (deployed to IPFS)
+`-- tags        docs for each topic (content category)
+```
+
+#### Set up your local environment
+
+1. Install [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/)
+
+2. Clone your fork
+
+```
+git clone git@github.com:[your_github_handle]/nano-community.git && cd nano-community
+```
+
+3. Add upstream remote
+
+```
+git remote add upstream https://github.com/mistakia/nano-community.git
+```
+
+To sync your fork with the latest changes
+
+```
+git checkout main
+git fetch upstream
+git merge upstream/main
+```
+
+4. Install dependencies
+
+```
+yarn install
+```
+
+#### Start contributing
+
+1. Create a new branch for your changes
+
+```
+git checkout -b new_feature_name
+```
+
+2. Start developing
+
+```
+yarn dev
+```
+
+3. Before committing your changes, make sure to run prettier, lint, and build.
+
+```
+yarn prettier
+yarn lint
+yarn build
+```
+
+## Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+have the right to submit it under the open source license
+indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+of my knowledge, is covered under an appropriate open source
+license and I have the right under that license to submit that
+work with modifications, whether created in whole or in part
+by me, under the same open source license (unless I am
+permitted to submit under a different license), as indicated
+in the file; or
+
+(c) The contribution was provided directly to me by some other
+person who certified (a), (b) or (c) and I have not modified
+it.
+
+(d) I understand and agree that this project and the contribution
+are public and that a record of the contribution (including all
+personal information I submit with it, including my sign-off) is
+maintained indefinitely and may be redistributed consistent with
+this project or the open source license(s) involved.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 nano.community contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,49 +1,33 @@
-# Nano Wiki
+# Nano.Community
 
-## Vision / Purpose
+[Nano.Community](https://nano.community/) is a community run project thats improved over time through contributions from community members. If you're interested in helping improve [nano.community](https://nano.community/), start by reading the [contribution guidelines](https://github.com/mistakia/nano-community/blob/main/CONTRIBUTING.md).
 
-Nano Wiki aims to be the a portal to Nano's growing community, maintaining docs, guides, and conventions to improve community communication & onboarding.
+## Design
 
-**Primary Goals**
+### Markdown Documents
 
-- Help new members discover and understand existing ideas, discussions in an easily consumable manner
-- Help existing members point new members to old ideas, discussions, conclusions, etc
-- Help new member onboarding, especially for code contributions from developers
+A set of community maintained markdown documents
 
-**Secondary Goals**
+- landing pages
+- guides
+- onboarding
+- documentation
+- support
 
-- Serve as a chronicle of events, discussions, comments, ideas, etc. Documentating Nano culture & history
-- Keep the community at large informed — serve as a centralized place to easily and quickly track an open and distributed project
-- Measure community support for or against ideas by nano account based voting
+### Nano Based Accounts & Voting
 
-**Principles**
+Accounts are a generated key-pair where the public key is signed by the private key pertaining to a nano account. This will allow associating a user's actions and content to an account (representative) on the nano network. The signing process will take place within a wallet (or on the commandline) and will not increase the risk/attack surface for a nano private key. This feature can be used to automate moderation of contributions as well as measuring support for or against certain content (proposals, ideas, comments, etc).
 
-- Open
-- Distributed — operate indefinetly without reliance on centralized elements (servers, people, etc)
+### Content Aggregation
 
-**Project Components**
+Automatic content aggregation and indexing
 
-- Markdown Wiki Documents
-- Onboarding / Contribution Guides
-- Community Conventions
-- Nano Improvement Proposals (i.e. RFC)
-- Nano Based Accounts & Voting
-- Content Aggregator / Crawler (automatic content importing and chronicling)
-
-## Contribution Guides
-
-- Nano Docs
-- Nano Code
-- Nano Wiki
-
-## Community Conventions
-
-- Reddit
+- Reddit Subreddit
+- Reddit User
 - Forum
 - Discord
 - Github
 
-## Templates
+### Content Categorization
 
-- Wiki Document
-- Forum Post
+Content can be tagged to a topic to allow for members to easily explore past discussions around a certain topic. Each topic will have a neutral, concise, and high-level summary with links to notable comments. Topics exist to easily point new members to past conversations as new members will naturally think of things already discussed by past members.

api/cache.js

@@ -0,0 +1,4 @@
+const NodeCache = require('node-cache')
+const cache = new NodeCache({ stdTTL: 600, checkperiod: 120 })
+
+module.exports = cache

api/cron.js

@@ -0,0 +1,52 @@
+const cron = require('node-cron')
+
+const db = require('../db')
+
+const updateSources = async () => {
+  const sources = await db('sources')
+  const sids = sources.map((s) => s.id)
+  for (const sid of sids) {
+    await updateSourceScore(sid)
+  }
+}
+
+const updateSourceScore = async (sid) => {
+  const query = db('posts')
+  query.select(db.raw('avg(score) as score_avg'))
+  query.where('sid', sid)
+  query.where('score', '>', 1.0)
+  query.whereRaw('created_at >= (UNIX_TIMESTAMP() - (86400 * 14))')
+  const result = await query
+  // eslint-disable-next-line camelcase
+  const { score_avg } = result[0]
+  // eslint-disable-next-line camelcase
+  if (score_avg) {
+    await db('sources').update({ score_avg }).where('id', sid)
+  }
+}
+
+cron.schedule('*/15 * * * *', async () => {
+  if (process.env.NODE_ENV !== 'production') {
+    return
+  }
+
+  try {
+    await updateSources()
+  } catch (err) {
+    console.log(err)
+  }
+})
+
+if (!module.parent) {
+  const init = async () => {
+    await updateSources()
+    process.exit()
+  }
+
+  try {
+    init()
+  } catch (err) {
+    console.log(err)
+    process.exit()
+  }
+}

api/index.js

@@ -0,0 +1,3 @@
+// eslint-disable-next-line
+require = require('esm')(module /*, options*/)
+module.exports = require('./server.js')

api/routes/accounts/blocks.js

@@ -0,0 +1,52 @@
+const express = require('express')
+
+const { request } = require('../../../common')
+const { nanodbAPI } = require('../../../config')
+
+const router = express.Router({ mergeParams: true })
+
+router.get('/:type/summary', async (req, res) => {
+  const { logger, db } = req.app.locals
+  try {
+    const { address, type } = req.params
+
+    if (!address) {
+      return res.status(401).send({ error: 'missing address' })
+    }
+
+    const re = /^(nano|xrb)_[13]{1}[13456789abcdefghijkmnopqrstuwxyz]{59}$/gi
+    if (!re.test(address)) {
+      return res.status(401).send({ error: 'invalid address' })
+    }
+
+    if (!type) {
+      return res.status(401).send({ error: 'missing type' })
+    }
+
+    const types = ['send', 'receive', 'change']
+    if (!types.includes(type)) {
+      return res.status(401).send({ error: 'invalid type' })
+    }
+
+    const limit = Math.min(parseInt(req.query.limit || 100, 0), 100)
+    const offset = parseInt(req.query.offset, 0) || 0
+
+    const url = `${nanodbAPI}/accounts/${address}/blocks/${type}/summary?limit=${limit}&offset=${offset}`
+    const data = await request({ url })
+    const addresses = data.map((d) => d.destination_account)
+    const rows = await db('accounts')
+      .select('account', 'alias')
+      .whereIn('account', addresses)
+
+    for (let i = 0; i < data.length; i++) {
+      const item = rows.find((r) => r.account === data[i].destination_account)
+      data[i].destination_alias = item ? item.alias : null
+    }
+    res.status(200).send(data)
+  } catch (error) {
+    logger(error)
+    res.status(500).send({ error: error.toString() })
+  }
+})
+
+module.exports = router