BitcoinJS (bitcoinjs-lib)
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
1npm install bitcoinjs-lib
Impostare
Node.js
1var 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.js
file
1
2
3
4
5
6
7
8
9
10let bitcoin = require('bitcoinjs-lib')
// your code here
function myFunction () {
return bitcoin.ECPair.makeRandom().toWIF()
}
module.exports = {
myFunction
}
Ora, per compilare per il browser:
1browserify index.js --standalone foo > app.js
Ora puoi inserire <script src="app.js" />
nella tua pagina web, usando foo.myFunction
per 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
, Point
questo a causa della funzione-nome è usato a Duck-Typing. Typeforce .
Esempio:
1uglifyjs ... --mangle reserved=['BigInteger','ECPair','Point']
NOTA : questa libreria tiene traccia delle funzionalità del nodo LTS, se hai bisogno di ES5 stretto, usalo --transform babelify
insieme al tuo browserify
passaggio (usando un es2015
preset).
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.0
della libreria.
1npm install @types/bitcoinjs-lib
Ora puoi usare bitcoinjs-lib
come libreria compatibile con i dattiloscritti.
1import { 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).
- Genera un indirizzo casuale
- Genera un indirizzo da un hash SHA256
- Importa un indirizzo tramite WIF
- Genera un indirizzo multisig 2 di 3 P2SH
- Genera un indirizzo SegWit
- Genera un indirizzo SegWit P2SH
- Genera un indirizzo multisig SegWit 3-of-4
- Genera un indirizzo multisig SegWit 2-of-2 P2SH
- Supporta il recupero di transazioni per un indirizzo (blockchain di terze parti)
- Genera un indirizzo Testnet
- Genera un indirizzo Litecoin
- Crea una transazione 1 a 1
- Crea una transazione 2-a-2
- Creare (e trasmettere tramite 3PBP) una transazione tipica
- Creare (e trasmettere tramite 3PBP) una transazione con un output OP_RETURN
- Creare (e trasmettere tramite 3PBP) una transazione con un input 2-of-4 P2SH (multisig)
- Creare (e trasmettere tramite 3PBP) una transazione con un input SegWit P2SH(P2WPKH)
- Creare (e trasmettere tramite 3PBP) una transazione con un input SegWit 3-of-4 P2SH(P2WSH(multisig))
- Importa un xpriv testnet BIP32 ed esporta in WIF
- Esporta un xpriv BIP32, quindi importalo
- Esporta un xpub BIP32
- Crea un BIP32, bitcoin, account 0, indirizzo esterno
- Crea un BIP44, bitcoin, account 0, indirizzo esterno
- Crea un BIP49, bitcoin testnet, account 0, indirizzo esterno
- Usa BIP39 per generare indirizzi BIP32
- Creare (e trasmettere tramite 3PBP) una transazione in cui Alice può riscattare l'output dopo la scadenza
- Crea (e trasmetti tramite 3PBP) una transazione in cui Alice e Bob possono riscattare l'output in qualsiasi momento
- Creare (ma non trasmettere tramite 3PBP) una transazione in cui Alice tenta di riscattare prima della scadenza
- Recupera una chiave privata da valori R duplicati
- Recuperare una chiave privata padre BIP32 dalla chiave pubblica padre e una chiave privata figlio derivata non rafforzata
- Genera un indirizzo stealth a chiave singola
- Genera un indirizzo stealth a chiave singola (casualmente)
- Recuperare il destinatario principale.d, se viene trapelata una chiave privata derivata (e nonce è stato rivelato)
- Genera un indirizzo invisibile a doppia chiave
- Genera un indirizzo invisibile a doppia chiave (casualmente)
Se hai un caso d'uso che ritieni possa essere elencato qui, per favore chiedilo !
Progetti che utilizzano BitcoinJS
- BitAddress
- Blockchain.info
- Blocktrail
- Portafoglio scuro
- Banca centrale
- Portafoglio Dogechain
- Portafoglio EI8HT
- Indirizzo Verde
- Helperbit
- Portafoglio Melis
- Robocoin
- Skyhook ATM
- Strumento Coinbase Multisig
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
2npm 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 della radice e dell'albero di merkle.
- minimaldata -Un modulo per controllare la politica bitcoin: SCRIPT_VERIFY_MINIMALDATA