Fantastico modulo community community

BitcoinJS (bitcoinjs-lib)

Stato di costruzione NPM consiglio per il prossimo commit

js-standard-stile

La libreria Bitcoin JavaScript pura per node.js e browser, stimata per essere utilizzata da oltre 15 milioni di utenti di portafogli ed è la spina dorsale per quasi tutti i portafogli Web Bitcoin in produzione oggi.

Caratteristiche

  • Clean: JavaScript puro, codice conciso, di facile lettura.
  • Tested: Copertura > 90%, test di integrazione di terze parti.
  • Careful: processo di approvazione di due persone per richieste pull piccole e mirate.
  • Compatible: Funziona su Node.js e su tutti i browser moderni.
  • Powerful: Supporto per funzionalità avanzate, come multi-sig, portafogli HD.
  • Secure: Forte generazione di numeri casuali, rilasci firmati PGP, sviluppatori fidati.
  • Principled: Nessun supporto per i browser con crap RNG (IE <11)
  • Standardized: stile di codifica della comunità di nodi, Browserify, stdlib e buffer di Node.
  • Fast: codice ottimizzato, utilizza array digitati anziché array di byte per le prestazioni.
  • Amichevole per gli esperimenti: supporto Bitcoin Mainnet e Testnet.
  • Altcoin-ready: in grado di lavorare con criptovalute derivate da bitcoin (come Dogecoin).

Dovrei usarlo in produzione?

Se stai pensando di utilizzare il ramo master di questa libreria in produzione, interrompi .Master non è stabile; è il nostro ramo di sviluppo e solo le versioni contrassegnate possono essere classificate come stabili .

Installazione

1
npm install bitcoinjs-lib

Impostare

Node.js

1
var bitcoin = require('bitcoinjs-lib')

Browser

Se hai familiarità con l'uso di browserify, ignoralo e procedi normalmente.Questi passaggi sono solo consultivi e potrebbero non essere adatti alla tua applicazione.

Si presume che Browserify sia installato per questi passaggi.

Per il tuo progetto, crea un index.jsfile

1 2 3 4 5 6 7 8 9 10
let bitcoin = require('bitcoinjs-lib') // your code here function myFunction () { return bitcoin.ECPair.makeRandom().toWIF() } module.exports = { myFunction }

Ora, per compilare per il browser:

1
browserify index.js --standalone foo > app.js

Ora puoi inserire <script src="app.js" />nella tua pagina web, usando foo.myFunctionper creare una nuova chiave privata Bitcoin.

NOTA : Il codice JavaScript uglify il Se, è necessario I seguenti nomi di variabili dal escludere l'essere straziati: BigInteger, ECPair, Pointquesto a causa della funzione-nome è usato a Duck-Typing. Typeforce .

Esempio:

1
uglifyjs ... --mangle reserved=['BigInteger','ECPair','Point']

NOTA : questa libreria tiene traccia delle funzionalità del nodo LTS, se hai bisogno di ES5 stretto, usalo --transform babelifyinsieme al tuo browserifypassaggio (usando un es2015preset).

NOTA : se prevedi che questa libreria venga eseguita su un dispositivo iOS 10, assicurati di utilizzare buffer@5.0.5 o versione successiva.

Typescript or VSCode users

Le dichiarazioni di tipo per Typescript sono disponibili per la versione ^3.0.0della libreria.

1
npm install @types/bitcoinjs-lib

Ora puoi usare bitcoinjs-libcome libreria compatibile con i dattiloscritti.

1
import { HDNode, Transaction } from 'bitcoinjs-lib'

Per VSCode (e altri editor), si consiglia agli utenti di installare le dichiarazioni di tipo, poiché Intellisense utilizza tali informazioni per facilitare la codifica (completamento automatico, analisi statica).

Segnala eventuali bug relativi al dattiloscritto a @dlebrecht DefinitelyTyped fork , invia PR a DefinitelyTyped

Flow

Le definizioni per Flow typechecker sono disponibili nel repository di tipo flow.

Puoi scaricarli direttamente dal repository o con il CLI . digitato a flusso

1 2
# npm install -g flow-typed $ flow-typed install -f 0.27 bitcoinjs-lib@2.2.0 # 0.27 for flow version, 2.2.0 for bitcoinjs-lib version

Le definizioni sono complete e aggiornate con la versione 2.2.0 Le definizioni sono mantenute da @runn1ng .

Esempi

Gli esempi seguenti sono implementati come test di integrazione, dovrebbero essere molto facili da capire.In caso contrario, le richieste pull sono apprezzate.Alcuni esempi interagiscono (tramite HTTPS) con un provider Blockchain di terze parti (3PBP).

Se hai un caso d'uso che ritieni possa essere elencato qui, per favore chiedilo !

Progetti che utilizzano BitcoinJS

Contribuire

Accettiamo sempre richieste pull, ma aderiamo a standard specifici per quanto riguarda lo stile di codifica, lo sviluppo guidato dai test e i messaggi di commit.

Si prega di fare del proprio meglio per attenersi a questi quando si contribuisce a risparmiare su correzioni banali.

Running the test suite

1 2
npm test npm run-script coverage

Biblioteche complementari

  • BIP21 -Una libreria di codifica URL compatibile con BIP21
  • BIP38 -Chiavi private protette da passphrase
  • BIP39 -Generazione mnemonica per chiavi deterministiche
  • BIP32-Utils -Un insieme di utilità per lavorare con BIP32
  • BIP66 - Decodifica rigorosa della firma DER
  • BIP68 -Libreria di codifica del tempo di blocco relativo
  • BIP69 -Indicizzazione lessicografica degli input e degli output delle transazioni
  • Base58 -Codifica/decodifica Base58
  • Base58 Check -Controllo Base58 codifica/decodifica
  • Bech32 -Una libreria di codifica Bech32 compatibile con BIP173
  • coinselect -Un modulo di selezione dell'input delle transazioni per l'ottimizzazione delle commissioni per bitcoinjs-lib.
  • merkle-lib -Una libreria attenta alle prestazioni per i calcoli di radice e albero di merkle.
  • minimaldata -Un modulo per controllare la politica bitcoin: SCRIPT_VERIFY_MINIMALDATA

alternative

LICENZA MIT