{"id":20987414,"url":"https://github.com/stacks-network/key-encoder-js","last_synced_at":"2025-03-26T11:08:23.497Z","repository":{"id":39001838,"uuid":"41569246","full_name":"stacks-network/key-encoder-js","owner":"stacks-network","description":"Library for encoding and decoding ecdsa private keys and converting between formats","archived":false,"fork":false,"pushed_at":"2025-03-11T20:21:18.000Z","size":231,"stargazers_count":46,"open_issues_count":13,"forks_count":27,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-16T16:11:29.630Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stacks-network.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-08-28T21:08:09.000Z","updated_at":"2025-03-03T10:22:30.000Z","dependencies_parsed_at":"2025-02-17T01:45:09.007Z","dependency_job_id":null,"html_url":"https://github.com/stacks-network/key-encoder-js","commit_stats":{"total_commits":73,"total_committers":5,"mean_commits":14.6,"dds":"0.36986301369863017","last_synced_commit":"2ff866fb5a2f79b93cc762e1efbe7d9869403905"},"previous_names":["blockstack/key-encoder-js"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacks-network%2Fkey-encoder-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacks-network%2Fkey-encoder-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacks-network%2Fkey-encoder-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacks-network%2Fkey-encoder-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stacks-network","download_url":"https://codeload.github.com/stacks-network/key-encoder-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245641437,"owners_count":20648642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T06:16:53.043Z","updated_at":"2025-03-26T11:08:23.472Z","avatar_url":"https://github.com/stacks-network.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Key Encoder JS\n\n[![CircleCI](https://img.shields.io/circleci/project/blockstack/key-encoder-js/master.svg)](https://circleci.com/gh/blockstack/key-encoder-js/tree/master)\n[![npm](https://img.shields.io/npm/l/key-encoder.svg)](https://www.npmjs.com/package/key-encoder)\n[![npm](https://img.shields.io/npm/v/key-encoder.svg)](https://www.npmjs.com/package/key-encoder)\n[![npm](https://img.shields.io/npm/dm/key-encoder.svg)](https://www.npmjs.com/package/key-encoder)\n[![Slack](http://slack.blockstack.org/badge.svg)](http://slack.blockstack.org/)\n\n### Installation\n\n```\n$ npm install key-encoder\n```\n\n### Getting Started\n\nTo get started, first define your key encoder and raw private/public keys.\n\n#### SECP256k1 Key Encoders\n\n```js\nvar KeyEncoder = require('key-encoder'),\n    keyEncoder = new KeyEncoder('secp256k1')\n```\n\nAs shown above, there is built in support for SECP256k1 (the curve Bitcoin uses), but you can pass in your own curve parameters for any curve you'd like.\n\n#### Key Encoders w/ Custom Curves\n\n```js\nvar EC = require('elliptic').ec\nvar encoderOptions = {\n    curveParameters: [1, 3, 132, 0, 10],\n    privatePEMOptions: {label: 'EC PRIVATE KEY'},\n    publicPEMOptions: {label: 'PUBLIC KEY'},\n    curve: new EC('secp256k1')\n}\nvar keyEncoder = new KeyEncoder(encoderOptions)\n```\n\n#### Declaring Raw Keys\n\n```js\nvar rawPrivateKey = '844055cca13efd78ce79a4c3a4c5aba5db0ebeb7ae9d56906c03d333c5668d5b',\n    rawPublicKey = '04147b79e9e1dd3324ceea115ff4037b6c877c73777131418bfb2b713effd0f502327b923861581bd5535eeae006765269f404f5f5c52214e9721b04aa7d040a75'\n```\n\n### Encoding Private Keys\n\nEncode to and from raw, PEM (encode to 'pkcs8' and 'pkcs1'), and DER formats.\n\n#### Encoding Private Keys as PEMs\n\n```js\nvar pemPrivateKey = keyEncoder.encodePrivate(rawPrivateKey, 'raw', 'pem', 'pkcs8') //default is 'pkcs1'\n```\n\nExample output:\n\n```\n-----BEGIN PRIVATE KEY-----\nMIGNAgEAMBAGByqGSM49AgEGBSuBBAAKBHYwdAIBAQQghEBVzKE+/XjOeaTDpMWr\npdsOvreunVaQbAPTM8VmjVugBwYFK4EEAAqhRANCAAQUe3np4d0zJM7qEV/0A3ts\nh3xzd3ExQYv7K3E+/9D1AjJ7kjhhWBvVU17q4AZ2Umn0BPX1xSIU6XIbBKp9BAp1\n-----END PRIVATE KEY-----\n```\n\n#### Encoding Private Keys to DER Format\n\n```js\nvar derPrivateKey = keyEncoder.encodePrivate(rawPrivateKey, 'raw', 'der')\n```\n\nExample output:\n\n```\n30740201010420844055cca13efd78ce79a4c3a4c5aba5db0ebeb7ae9d56906c03d333c5668d5ba00706052b8104000aa14403420004147b79e9e1dd3324ceea115ff4037b6c877c73777131418bfb2b713effd0f502327b923861581bd5535eeae006765269f404f5f5c52214e9721b04aa7d040a75\n```\n\n### Encoding Public Keys\n\nEncode to and from raw, PEM, and DER formats.\n\n#### Encoding Public Keys as PEMs\n\n```js\nvar pemPublicKey = keyEncoder.encodePublic(rawPublicKey, 'raw', 'pem')\n```\n\nExample output:\n\n```\n-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEFHt56eHdMyTO6hFf9AN7bId8c3dxMUGL\n+ytxPv/Q9QIye5I4YVgb1VNe6uAGdlJp9AT19cUiFOlyGwSqfQQKdQ==\n-----END PUBLIC KEY-----\n```\n\n#### Encoding Public Keys to DER Format\n\n```js\nvar derPublicKey = keyEncoder.encodePublic(rawPublicKey, 'raw', 'der')\n```\n\nExample output:\n\n```\n3056301006072a8648ce3d020106052b8104000a03420004147b79e9e1dd3324ceea115ff4037b6c877c73777131418bfb2b713effd0f502327b923861581bd5535eeae006765269f404f5f5c52214e9721b04aa7d040a75\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstacks-network%2Fkey-encoder-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstacks-network%2Fkey-encoder-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstacks-network%2Fkey-encoder-js/lists"}