https://github.com/keybase/merkle-stellar
Library to read the Keybase Merkle root out of the Stellar blockchain
https://github.com/keybase/merkle-stellar
Last synced: 16 days ago
JSON representation
Library to read the Keybase Merkle root out of the Stellar blockchain
- Host: GitHub
- URL: https://github.com/keybase/merkle-stellar
- Owner: keybase
- License: bsd-3-clause
- Archived: true
- Created: 2020-01-24T17:47:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T20:44:09.000Z (almost 2 years ago)
- Last Synced: 2025-03-13T18:51:59.722Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 4.4 MB
- Stars: 12
- Watchers: 5
- Forks: 13
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# merkle-stellar
[](https://travis-ci.org/keybase/merkle-stellar)
Library to read Merkle root out of Stellar blockchain.
## Install
```
$ npm i -g keybase-merkle-stellar
```
## Demo
```
$ keybase-merkle-stellar-check max
✔ 1. fetch latest root from stellar: returned #27980338, closed at 2020-01-29T13:00:06Z
✔ 2. fetch keybase path from root for max: got back seqno #14406067
✔ 3. check hash equality for 070202749f229c2b6a99bac9fd8fe8a0e429dc266c2e9dff2dbc51e0fe190a09: match
✔ 4. extract UID for max: map to dbb165b7879fe7b1174df73bed0b9500 via legacy tree
✔ 5. walk path to leaf for dbb165b7879fe7b1174df73bed0b9500: tail hash is 913358757a2e1c36cb17e70b4bc51496829e97179509f854f18641d80e57637f
✔ 6. fetch sigchain from keybase for dbb165b7879fe7b1174df73bed0b9500: got back 691 links
```
## The Code
The main operations can be found in the [Checker](./src/check.ts) class:
```TypeScript
// checkUsername traverses the stellar root down to the given username, and returns the
// full sigchain of the user. This function is kept simple for the basis
// of site documentation.
async checkUsername(username: string): Promise {
const groveHash = await this.fetchLatestGroveHashFromStellar()
const pathAndSigs = await this.fetchPathAndSigsForUsername(groveHash, username)
const treeRoots = await this.checkSigAgainstStellar(pathAndSigs, groveHash)
const uid = this.extractUid(username, pathAndSigs, treeRoots.body.legacy_uid_root)
const chainTail = this.walkPathToLeaf(pathAndSigs, treeRoots.body.root, uid)
const chain = await this.fetchSigChain(chainTail, uid)
return chain
}
```