varanda

Monorepo npm da fase 0 de uma rede social ponto a ponto no Holepunch (Hypercore, Hyperswarm e HyperDHT): o programa de terminal (varanda, varanda-serve), o aplicativo iOS, Android e web (apps/app), o site estático (apps/site) e as bibliotecas compartilhadas (packages/*). A referência normativa dos formatos é docs/protocol.md. O guia de desenvolvimento está em docs/development.md.

Estrutura do repositório

É um monorepo npm (workspaces packages/* e apps/*, um só package-lock.json na raiz).

• apps/cli: o programa de linha de comando (varanda, varanda-serve), o semeador e a demo. README.
• apps/app: aplicativo iOS, Android e web, com o worklet Bare que roda o nó no celular e a interface de membro. README.
• apps/site: o site estático do Varanda (página de apresentação, logotipo e as fontes dos ícones do app). README, docs/site.md.
• packages/core: o núcleo do protocolo e a sessão do nó, usados pelo CLI e pelo app (Node e Bare). README.
• packages/rpc: o contrato JSON entre a interface e o nó. README.
• deploy/seeder: imagem Docker, Compose e unidade systemd do semeador. Ver Operar o semeador.
• docs/: protocol.md (referência normativa dos formatos), rpc.md (contrato da interface), design.md (documento de design), development.md, app.md, ios-gate.md, verification.md (verificação ponta a ponta do monorepo) e site.md (site estático). O índice está em docs/README.md.

O que é

Cada pessoa tem um diário assinado no próprio dispositivo. Seguidores e semeadores guardam cópias. O semeador só guarda um diário cujo bloco 0 traz um certificado de membro válido da associação em que ele confia. A identidade é a chave pública desse diário: 64 dígitos hexadecimais (32 bytes).

Quem acompanha outra pessoa pede o diário dela aos pares e ao semeador. Com o processo de sincronização da autora já encerrado, o semeador continua servindo a cópia que admitiu.

O semeador também tem certificado da mesma associação. Só um semeador verificado por esse certificado conta como admissão (admitted).

Requisitos

• Node.js 20 ou mais novo (engines.node é >=20)
• npm

O programa de terminal roda no Node e não tem etapa de compilação. O núcleo (packages/core) também roda no runtime Bare, dentro do aplicativo (apps/app; veja docs/development.md para compilar o app). Esta fase não usa o runtime Pear.

Contribuir

Guia completo em CONTRIBUTING.md.

• Faça fork do repositório e abra um pull request contra main.
• Comente na issue antes de começar, para alinhar escopo e evitar trabalho duplicado.
• Use branch no formato <tipo>/<slug> (por exemplo fix/nome-curto).
• No PR, referencie a issue com Closes #n.
• Vulnerabilidades: siga SECURITY.md; não abra issue pública com detalhes sensíveis.

Licença

O código deste repositório é distribuído sob a PolyForm Noncommercial 1.0.0 (SPDX PolyForm-Noncommercial-1.0.0); o licenciante é Rodrigo Serviuc Pavezi. Usar, copiar e modificar o código é permitido para fins não comerciais, nos termos da licença. Usos comerciais não abrangidos pela licença dependem de autorização prévia do licenciante. É código-fonte disponível, não código aberto segundo a definição da Open Source Initiative (OSI). Ao abrir um PR, quem contribui concede ao licenciante uma licença para distribuir a contribuição sob quaisquer termos, sem CLA. Os detalhes, e os trechos de terceiros que continuam sob a MIT, estão na seção Licença de CONTRIBUTING.md.

Instalação

Na raiz deste repositório:

npm install

Os executáveis em bin/ na raiz são atalhos para apps/cli/bin/ (por exemplo bin/varanda.js).

O programa é node bin/varanda.js. A ajuda:

node bin/varanda.js help

--help e -h imprimem o mesmo texto. Os valores vão em separado: --flag valor. A forma --flag=valor é uma opção desconhecida (código 2).

Conceitos

Ajuda

node bin/varanda.js help imprime exatamente:

This is the beginning of the README. Read the rest at the original. Read the full README ↗