Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

readme <3 #16

Merged
merged 2 commits into from
Apr 12, 2016
Merged

readme <3 #16

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9fdc0a
applies readme love
hackergrrl Apr 11, 2016
dab90bd
other bundlers
hackergrrl Apr 12, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 100 additions & 41 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,43 @@
peer-id JavaScript implementation
=================================
# peer-id

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![Build Status](https://travis-ci.org/diasdavid/js-peer-id.svg?style=flat-square)](https://travis-ci.org/diasdavid/js-peer-id)
![](https://img.shields.io/badge/coverage-95%25-yellow.svg?style=flat-square)
[![Dependency Status](https://david-dm.org/diasdavid/js-peer-id.svg?style=flat-square)](https://david-dm.org/diasdavid/js-peer-id)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
> IPFS Peer Id implementation in JavaScript

> [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.

# Description

An IPFS Peer Id is based on a sha256 hash of the peer public key, using [multihash](https://github.com/jbenet/multihash)
Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).

*A Peer ID is the SHA-256 [multihash](https://github.com/jbenet/multihash) of a
public key.*

*The public key is a base64 encoded string of a protobuf containing an RSA DER
buffer. This uses a node buffer to pass the base64 encoded public key protobuf
to the multihash for ID generation.*

# Example

```js
var PeerId = require('peer-id')
var bs58 = require('bs58')

var id = PeerId.create({ bits: 32 })

console.log('id ', id.toB58String())
console.log('priv key ', bs58.encode(id.privKey))
console.log('pub key ', bs58.encode(id.pubKey))
```

The public key is a base64 encoded string of a protobuf containing an RSA DER buffer. This uses a node buffer to pass the base64 encoded public key protobuf to the multihash for ID generation.
```
id QmeeLFb92nkZJGj3gXLqXrEMzCMYs6uBgQLVNbrcXEvYXk
priv key 6ibrcPAbevzvPpkq6EA6XmLyuhmUrJrEvUfgQDtEiSEPzGnGU8Ejwf6b11DVm6opnFGo
pub key 2BeBZVKJ9RQs4i4LbGv4ReEeuBA5dck2Gje3wt67e44XuyyPq5jE
```

# Installation

Expand All @@ -23,76 +47,111 @@ The public key is a base64 encoded string of a protobuf containing an RSA DER bu
> npm i peer-id
```

## Use in Node.js
# Setup

## Node.js

```JavaScript
var PeerId = require('peer-id')
```

## Use in a browser with browserify, webpack or any other bundler
## Browser: Browserify or Webpack
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other bundlers can be used as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.


The code published to npm that gets loaded on require is in fact a ES5 transpiled version with the right shims added. This means that you can require it and use with your favourite bundler without having to adjust asset management process.
The code published to npm that gets loaded on require is in fact a ES5
transpiled version with the right shims added. This means that you can require
it and use with your favourite bundler without having to adjust asset management
process.

```JavaScript
var PeerId = require('peer-id')
```

## Use in a browser Using a script tag
## Browser: `<script>` Tag

Loading this module through a script tag will make the `PeerId` obj available in the global namespace.
Loading this module through a script tag will make the `PeerId` obj available in
the global namespace.

```html
<script src="https://npmcdn.com/peer-id/dist/index.min.js"></script>
<!-- OR -->
<script src="https://npmcdn.com/peer-id/dist/index.js"></script>
```

# Usage

### Creating a new Id
# API

```js
const PeerId = require('peer-id')
```
const PeerId = require('ipfs-peer')

// Create a new Id
const id = PeerId.create()
## Create

// Recreate an Id from Hex string
const id = PeerId.createFromHexString(str)
### PeerId.create()

// Recreate an Id from a Buffer
const id = PeerId.createFromBytes(buf)
Generates a new Peer ID, complete with public/private keypair. A Peer ID has the
following properties:

// Recreate an B58 String
const id = PeerId.createFromB58String(str)
- `pubKey` - Buffer containing the public key bytes
- `privKey` - Buffer containing the private key bytes
- `id` - Buffer containing the multihash bytes

// Recreate from a Public Key
const id = PeerId.createFromPubKey(pubKey)
## Import

// Recreate from a Private Key
const id = PeerId.createFromPrivKey(privKey)
```
### PeerId.createFromHexString(str)

### Exporting an Id
Creates a Peer ID from hex string representing the key's multihash.

```
// Print friendly format
id.toPrint() // returns an object with id, privKey and pubKey in hex format
### PeerId.createFromBytes(buf)

Creates a Peer ID from a buffer representing the key's multihash.

// Export to an hex string
id.toHexString()
### PeerId.createFromB58String(str)
Creates a Peer ID from a Base58 string representing the key's multihash.

// Export to Buffer
id.toBytes() (same as id.id)
### PeerId.createFromPubKey(pubKey)

// Export to a B58 string
id.toB58String()
Creates a Peer ID from a buffer containing a public key.

### PeerId.createFromPrivKey(privKey)

Creates a Peer ID from a buffer containing a private key.

## Export

### id.toPrint()

Returns an object with the ID's properties in hex format:
```js
{
id: 'QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi',
privKey: '080012a609308204a20201000282010100a608889914da08959d3a3db0734cee812c96...',
pubKey: '080012a60230820122300d06092a864886f70d01010105000382010f003082010a0282010...'
}
```

### Id format
### id.toHexString()

Returns the Peer ID's `id` as a hex string.

```js
1220d6243998f2fc56343ad7ed0342ab7886a4eb18d736f1b67d44b37fcc81e0f39f```

### id.toBytes()

Returns the Peer ID's `id` as a buffer.


```js
<Buffer 12 20 d6 24 39 98 f2 fc 56 34 3a d7 ed 03 42 ab 78 86 a4 eb 18 d7 36 f1 b6 7d 44 b3 7f cc 81 e0 f3 9f>
```
id.pubKey // Buffer containing the Public Key
id.privKey // Buffer containing the Private Key
id.id // Buffer containing the multihash

### id.toB58String()

Returns the Peer ID's `id` as a base58 string.

```js
QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi
```

# License

MIT