Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kentbull/saidify
A library generating self-addressing identifiers (SAIDs).
https://github.com/kentbull/saidify
content-addressable-identifiers self-addressing-identifiers
Last synced: 2 months ago
JSON representation
A library generating self-addressing identifiers (SAIDs).
- Host: GitHub
- URL: https://github.com/kentbull/saidify
- Owner: kentbull
- License: apache-2.0
- Created: 2024-08-14T22:22:32.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T01:09:26.000Z (5 months ago)
- Last Synced: 2024-09-28T23:04:11.122Z (3 months ago)
- Topics: content-addressable-identifiers, self-addressing-identifiers
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/saidify
- Size: 334 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# SAIDify - (sēdəˌfī)
[](https://github.com/kentbull/saidify/actions/workflows/trunk.yaml) [](https://codecov.io/github/kentbull/saidify) [](https://badge.fury.io/js/saidify)
Generate self-addressing identifiers on arbitrary data.
## Usage
### Typescript
Install the package via NPM/PNPM:
```bash
npm install saidify
```
Import 'saidify' and SAIDify your data:
```typescript
import { saidify, verify } from 'saidify'
// create data to become self-addressing
const myData = {
a: 1,
b: 2,
d: '',
}
const label = 'd'
const [said, sad] = saidify(myData, label)
// said is self-addressing identifier
// sad is self-addressing data
console.log(said)
// ...Vitest test assertion
expect(said).toEqual('ELLbizIr2FJLHexNkiLZpsTWfhwUmZUicuhmoZ9049Hz')
// verify self addressing identifier
const computedSAID = 'ELLbizIr2FJLHexNkiLZpsTWfhwUmZUicuhmoZ9049Hz'
const doesVerify = verify(sad, computedSAID, label) // can verify with original myData or sad
// ...Vitest test assertion
expect(doesVerify).toEqual(true)
```
You may find a full example Typescript project at [saidify-example](https://github.com/kentbull/saidify-example/blob/master/index.ts).
## Description
A self-addressing identifier (SAID) is a kind of content-addressable identifier that uses a two-pass approach to enable
embedding of the identifier in the content itself, thus the name self-addressing rather than content addressing.
A number of different specifications describe SAIDs.
- [ToIP CESR spec section: Self-addressing identifier (SAID)](https://trustoverip.github.io/tswg-cesr-specification/#self-addressing-identifier-said) - current
- [ToIP spec (archived) Self-Addressing IDentifier (SAID)](https://trustoverip.github.io/tswg-said-specification/draft-ssmith-said.html) - old
## Sources and References
- [signify-ts](https://github.com/WebOfTrust/signify-ts)
- Most of the code in this repository is lifted from the SignifyTS project.
- [keripy](https://github.com/WebOfTrust/keripy)
- Some of the code in this repository is inspired by KERIpy, the Python implementation of KERI.
## Development Statistics
