Commit Graph

26 Commits

Author SHA1 Message Date
adityapk00
a61cfb952e docs: Fix broken links (#1418) 2023-09-23 10:23:23 -05:00
adityapk00
aa6553b196 [wip] feat: Enable HTTP API Server (#1405) 2023-09-22 08:09:11 -05:00
Varun Srinivasan
dca4dc20b5 docs: update hubble documentation (#1144)
* docs(hubble): update README

* docs: update README
2023-07-14 23:05:35 -07:00
Varun Srinivasan
e53b38b9c5 docs(hubble): add pm2 logrotate, exponential backoff to address common failures (#913) 2023-04-24 15:28:38 -07:00
Paul Fletcher-Hill
9e3ca99b19 minor fix to root readme (#842) 2023-04-07 15:05:00 -04:00
Varun Srinivasan
dbc230c173 docs: update to reflect hub-monorepo name change (#779) 2023-03-28 19:30:06 -07:00
Varun Srinivasan
a74ecb2097 refactor(farcaster/hub-nodejs): rename farcaster/js to farcaster/hub-nodejs (#658)
* refactor: rename farcaster/js to farcaster/hub-nodejs

* chore: add changeset
2023-03-16 13:08:05 -07:00
Varun Srinivasan
ad4dfcfa1d docs: update READMEs to match latest behavior (#601) 2023-02-22 20:36:52 -08:00
Varun Srinivasan
ed7ef3ca0f chore: rename hub to hubble (#482)
* chore: rename hub to hubble

* chore: rename files
2023-01-30 17:30:39 -05:00
Paul Fletcher-Hill
d49fd11944 chore: rename protohub to hub (#480)
* rename protohub folder to hub

* rename @farcaster/protohub to hub
2023-01-30 15:06:53 -05:00
Chu Ka-cheong
b01d031b1d chore: update README (#427)
- fix broken link in project README
- update starting command arguments in hub's README
2023-01-15 11:36:26 -08:00
Paul Fletcher-Hill
7a97936596 add readme to all packages and update @farcaster/js docs with comments (#414) 2023-01-11 14:14:59 -05:00
Paul Fletcher-Hill
d3583ba7d5 chore: rename packages and move app to apps/hub (#399)
* add js package readme

* change name to @farcaster/js

* intermediate commit

* update package names and build scripts

* delete renamed files

* revert eslint package upgrades and remove changelog

* move root dependencies to devDependencies

* v0.1.1

* v0.1.1

* v0.1.1

* v0.1.2

* build with tsup

* regenerate yarn.lock

* remove unused package-lock.json file

* reset yarn.lock
2023-01-09 22:51:54 -05:00
Varun Srinivasan
e7b09965c1 docs: update READMEs (#343) 2022-12-31 18:03:26 -08:00
Varun Srinivasan
6d49f673fc docs: README for starting the Hub correctly, warnings for incorrect configs (#305) 2022-12-19 10:55:56 -08:00
Kyle Mathews
c935cac11a Add space (#254) 2022-12-02 00:50:16 -05:00
Sagar
e768460b7f chore(readme): document identity creation step (#225) 2022-11-09 16:58:13 -05:00
Varun Srinivasan
bdd742e51f refactor: code organization (#149)
* docs: update README to reflect new design

* refactor: rename MerkleSync to SyncEngine

* refactor: move db, engine, sets, providers into storage

* refactor: move factories, bench, client into test/

* refactor: combine typeguards

* refactor: move utils into folder

* refactor: cleanup docs in hub.ts

* refactor: package.json scripts

* refactor: rename server to cli

* chore: add stricter type checks, disable currently violated rules

* chore: type check for unreachable code

* chore: require explicit overrides when type checking

* chore: do not allow unused params while typechecking

* chore: enforce no unused locals when typechecking, remove unused code

* chore: enforce typechecking of exactOptionalPropertyTypes

* docs: add comments to commented out checks in tsconfig

* refactor(network): reorganize network folder

* docs: update README.md

* docs: update CONTRIBUTING.md

* chore: update comments to blocks

* chore: address PR comments
2022-10-10 12:06:53 -07:00
Paul Fletcher-Hill
9b1491f7ce [feature] Add SignerSet implementation (#38)
* initial commit

* Add questions

* add varun chat notes

* Add initial spec

* refactor to only do SignerAddition for adding a delegate

* add testing logic

* test happy path

* fix return type of numSigners

* org dir structure

* addDelegate works

* add removeDelegate code

* remove yarn lock

* revert yarn lock

* revert package lock

* add Saturday plan

* add cleanup work task

* cleanup unit tests

* Handle for more edge cases

* not dry but all tests run and use secp256k1 eth package now

* remove package

* remove @types/secp256k1 import

* add msg property to SignerNode

* change to SignerAdd

* refactor to use graph design

* remove redundant comment

* Add logic to remove subtree in edge case of addDelegate

* refactor addSigner -> addCustody

* fix tests wrt addCustody name change

* change rootKey to custodySigner in tests

* remove happy path label

* change to Result type

* remove 'new code' comment

* change comment to be more descriptive of the case we're handling for

* change test label

* remove comment

* change naming

* change from this.revoked to this.removed

* recursively delete entire delegate subtree

* ensure number of removed is correct for unit test

* change to parent,child params

* no need for _numRemoved

* add idempotency behavior for addCustody

* remove comment

* new design

* fix test

* Add leftover tasks section

* add second concurrent edge case

* fix bug and add todo for handling a variant of conflicting rem-add concurrent edge case

* do not remove edges

* got concurrent test case 2 passing

* reorder

* no-op

* add pseudocode missing gap section

* add other edge case pseudocode

* deterministically always pass unit tests

* fix label

* add line item

* add line item

* add line item

* add sub task in 7

* Refactor signerSet and tests

* SignerSet tests pass

* Clean up SignerSet

* Remove signerSet README

* Remove signerSet subdirectory

* Fix signerSet linting problems

* Cleanup signerSet declarations

* Add comments to types/index and add SignerAdd and SignerRemove factory transient params types

* Update custody signer tests to use secp256k1 utils

* Check for cycles on SignerSet.add

* Clean up private method names

* Use SignatureAlgorithm enum and add test for removing all parent edges of vertex being removed

* Clean up signer set methods and error messages

* Remove TODO

* Move private getters to bottom and add explanatory comment at top of signer set

* Add comments to signerset methods and fix custody as child test

* Handle Ethereum signers or Eddsa signers in signer set

* Add _signers to engine and add engine.signer.test

* Fix linter warnings

* Update engine.signer tests to use signer instead of privateKey

* Add signatureType to messages

* Remove comment in types

* Cleanup SignerAdd factory and comments

* Fix engine.signer tests

* Use signer set instead of signer changes

* Use lowercased address as signerKey for EthereumSigner and add utils tests

* Use lowercased address as signerKey for EthereumSigner and add utils tests

* Remove commented code

* Use lowercased address as signerKey for EthereumSigner and add utils tests

* Expand signerSet test suite

* Cleanup signer set tests and add test where addCustody fails if delegate already present

* Only generate Eddsa signers in engine tests

* Remove unused imports

* Remove unused imports

* Add explanatory comments about generateEd25519Signer and generateEthereumSigner

* Do not use SignatureAlgorithm.EthereumPersonalSign in factories

* Expand remove subtree test in signer set

* Add removeCustody method to signer set

* Wrap toLowerCase calls with sanitizeKey method and add more comments

* Starting to completely remove roots and signer changes

* Initial simplify commit

* Add tests

* Cleanup signer set and add comments about conflict resolution

* Make SignerSet extend event emitter and check events in tests

* Remove signers directly and emit removeSigner events instead of revokeMessage

* Improve comments in signer set

* Add engine.revoke test case

* Remove simulator and update readme

* Add revokeSigner tests for sets

* Update SignerAdd interface

* Rename params in factories

* Rename signerset addCustody method

* Add re-adding custody test case and improve comments

* Improve comments in signerset and fix bug with dropping custody remove messages

* Add extra tests to improve signer set coverage

* Unexpected state error to signerset

* Add extra params to SignerSet events

Co-authored-by: Shreyas Jaganmohan <shreyas.jaganmohan@gmail.com>
2022-08-16 17:46:19 -04:00
Cameron Armstrong
9c5747bd48 Update README.md (#40) 2022-07-27 00:51:43 -04:00
Varun Srinivasan
db9509e28b v2.1 Refactor (#19)
* refactor: update system to the new v2 design specification

* refactor: cleanup minor issues
2022-04-27 21:26:34 -07:00
danromero
a004ab4866 Fix link (#10)
Fixed Notion link for Farcaster v2 design doc
2022-03-24 16:00:13 -07:00
Varun Srinivasan
e2aae0da3d Types: Support Recast, Reactions and Follows (#9)
* feat: add types for recast

* feat: add types for follows, reactions. refactor and document

* fix: respond to comments

* feat: support attachments and deletable text in casts

* feat: add chainType to root

* feat: change attachments to extensible object

* docs: update readme

* refactor: rename sequence to index

* refactor: merge the notion of type and schema into a single body field
2022-03-24 11:14:56 -07:00
Varun Srinivasan
579cd226d0 feat: network viz makes it easy to visualize if sync is complete (#7)
* feat: network viz makes it easy to visualize if sync is complete

* feat: add colors to mark latest chain

* docs: update
2022-03-21 19:16:41 -07:00
Varun Srinivasan
732953d779 docs: initial readme and roadmap (#6) 2022-03-21 15:37:14 -07:00
Varun Srinivasan
e2407d2a11 Initial commit 2022-03-16 16:28:13 -07:00