OverviewFilesCommitsIssuesDocsReleasesPeers

holepunchto-kb / skills / keet-identity-key / api-extract.json

69 lines · json ref:
{
  "repo": "keet-identity-key",
  "timestamp": "2026-01-16T23:39:49.447Z",
  "entryPoint": "index.js",
  "exports": {
    "packageJson": {
      "main": "index.js"
    }
  },
  "api": {
    "file": "index.js",
    "exports": [
      {
        "type": "default",
        "name": "class"
      }
    ],
    "classes": [
      {
        "name": "IdentityKey"
      }
    ],
    "functions": [
      {
        "name": "validateProof"
      },
      {
        "name": "validateAttestedData"
      },
      {
        "name": "getLastKey"
      },
      {
        "name": "keyPath"
      },
      {
        "name": "identityKeyPath"
      },
      {
        "name": "discoveryCorePath"
      },
      {
        "name": "symmetricPath"
      },
      {
        "name": "encryptionKeyPath"
      }
    ]
  },
  "readme": {
    "content": "# keet-identity-key\n\nHierarchical keychains that derives deterministic Ed25519 keypairs\n\n```\nnpm install keet-identity-key\n```\n\n## Usage\n\n``` js\nconst IdentityKey = require('keet-identity-key')\n\nconst mnemonic = IdentityKey.generateMnemonic()\nconst id = await IdentityKey.from({ mnemonic })\n\nconst proof0 = id.bootstrap(mainDevice.publicKey)\nconst proof = IdentityKey.attest(auxillaryDevice.publicKey, mainDevice, proof0)\n\nconst info = IdentityKey.verify(proof)\n\nif (info === null) {\n  // verification failed\n} else {\n  console.log(b4a.equals(info.identityPublicKey, id.identityPublicKey)) // true\n  console.log(b4a.equals(info.publicKey, auxillaryDevice.publicKey)) // true\n}\n```\n\n## API\n\n#### `mnemonic = IdentityKey.generateMnemonic()`\n\nGenerate a new `mnemonic`\n\n#### `seed = IdentityKey.generateSeed(mnemonic)`\n\nReturns a 32-byte buffer with entropy derived from `mnemonic`\n\n#### `const identity = new IdentityKeyPair(keyChain)`\n\nInstantiate a new `IdentityKey`\n\n#### `identity.identityPublicKey",
    "sections": [
      "intro",
      "usage",
      "api",
      "license"
    ],
    "hasApi": true,
    "hasExamples": true,
    "exampleCount": 1,
    "examples": [
      "npm install keet-identity-key"
    ]
  },
  "patterns": [
    "binary-encoding",
    "cryptography"
  ]
}