close

@atproto/identity

Library for decentralized identities in atproto using DIDs and handles

  • Types
  • ESM
License
MIT
Install Size
75.6 kB(8.4 MB)
Vulns
0
Published

Get started

$npm install @atproto/identity
$pnpm add @atproto/identity
$yarn add @atproto/identity
$bun add @atproto/identity
$deno add npm:@atproto/identity
$vlt install @atproto/identity
$vp add @atproto/identity

Readme

@atproto/identity

TypeScript library for decentralized identities in atproto using DIDs and handles

NPM Github CI Status

Example

Resolving a Handle and verifying against DID document:

const didres = new DidResolver({})
const hdlres = new HandleResolver({})

const handle = 'atproto.com'
const did = await hdlres.resolve(handle)

if (did == undefined) {
  throw new Error('expected handle to resolve')
}
console.log(did) // did:plc:ewvi7nxzyoun6zhxrhs64oiz

const doc = await didres.resolve(did)
console.log(doc)

// additional resolutions of same DID will be cached for some time, unless forceRefresh flag is used
const doc2 = await didres.resolve(did, true)

// helper methods use the same cache
const data = await didres.resolveAtprotoData(did)

if (data.handle != handle) {
  throw new Error('invalid handle (did not match DID document)')
}

License

This project is dual-licensed under MIT and Apache 2.0 terms:

Downstream projects and end users may chose either license individually, or both together, at their discretion. The motivation for this dual-licensing is the additional software patent assurance provided by Apache 2.0.