buidljs

KO | EN

gitlite — search

#javascript #python #ai #typescript #go #android #linux #macos #awesome #awesome-list #vue #security #openai #open-source

(★ 47)

A wrapper for bitcoinjs-lib

buidljs Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Buidl.js

Buidl.js was built from the bitcoinjs-lib library.

Want to use in your project? All you need to do is include buidl.js in your HTML and you are ready to start creating bitcoin keys, and build and sign transactions offline.

Buidl.js can be used to create browser-based client-side bitcoin wallets and tools.

Buidl.js is a simplified approach to bitcoin javascript development for beginners without having to learn the bitcoinjs-lib library. The intent is to expand the amount of developers that can develop bitcoin wallets and hopefully will lead to new, unique or otherwise novel wallet UIs.

USE AT YOUR OWN RISK.

# Usage

## 0. Save a copy of buidl.js or clone the repo

*  `git clone https://github.com/coinables/buidljs.git`
 
NOTE: If you cloned the repository the create.js file is the pre-browserify source to buidl.js.
 
## 1. Include `buidl.js` in your HTML

*  `<script src="path/to/buidl.js"></script>`

## 2. Create a random key pair

<head>
		<script src="buidl.js"></script>
		</head>
		<body>
		<script>
		let newPair = buidl.createP2PKH();
		let address = newPair.addr;
		let privateKey = newPair.pk;
		console.log(address, privateKey);
		</script>
		</body>

## 3. Create key pair from sha256 hash of an input aka brainwallet

<head>
		<script src="buidl.js"></script>
		</head>
		<body>
		<script>
		let newPair = buidl.createFrom("satoshi");
		let address = newPair.p2pkh;
		let privateKey = newPair.pk;
		console.log(address, privateKey);
		</script>
		</body>

## 4. Get details of a private key

<head>
		<script src="buidl.js"></script>
		</head>
		<body>
		<script>
		let WIF = "L4tm7p16LZ7e3EwydFTNFBDdknKrU7E1e6iXxkbFSF4FDFxcnyXG";
		let details = buidl.getDetails(WIF);
		console.log(details);
		</script>
		</body>

## 5. HD Wallets, generate new mnemonic, convert to seed, extended public key, and address

<head>
		<script src="buidl.js"></script>
		</head>
		<body>
		<script>
		var a = buidl.newMnemonic();
        //words: "strong daring visa offer ten document bird shoulder mule dry wink laugh"
        
        //or create from entropy source
        //var a = buidl.entropy2Mnemonic("somestrongentropysource123456789sss");
        
        var b = buidl.mnemonic2SeedHex(a.words);
        //seedHex: "413fbecd04dfdac08e8bc9a6f3c99790f1b2fa98b65b9ef74e67aa663e36679160dc4a613f381c1a9cbc4a99a87f2f5f08a18e2a8209f36ea58f8ea6750c54ce"
        
        var c = buidl.seedToXpub(b.seedHex,84,0);
        //xpub: "zpub6sCAx5BGhzosvmBsLyj8P1xjQHmuwHMoFm4ykHMmeP16Zn6iKpxy4BBDsHPRj4RsU5YvXigGvnYRYo4n5sA4QH2kgZUoTgQVTmzt5XuC6qD"
        
        var d = buidl.fromXpub(c.xpub,0,0);
        //addr: "bc1qzsg5xf3kmdrd8629p29vtvj39ep82rhjwx58dh"

</script>
		</body>
        
              
		
## 6. Build and sign a transaction

* createTransaction(typei, txidi, outni, outputi, amounti, wifi, changeout, changeamt, inputvalue)
 
 typei - string, indicate input type by using the first character of address type spending from      
 txidi - string, transaction id of unspent output being spent       
 outni - integer, nout value of the unspent output being spent      
 outputi - string, address of output "receiving" address      
 amounti - integer, amount to send to output in satoshis (100,000,000 satoshis = 1 BTC)        
 wifi - string, WIF private key of unspent output being spent      
 changeout - string, Optional, change address or 2nd output address      
 changeamt - integer, Optional, amount in satoshis to send to change address      
 inputvalue - integer, Only required when spending from segwit unspent outputs, this is the full value of the unspent output being spent       	
 
		createTransaction("1", "34eceJ...  > spends from p2pkh
		createTransaction("3", "34eceJ...  > spending from p2sh-p2wpkh
		createTransaction("b", "34eceJ...  > spending from p2wpk(bech32)

createTransaction("3", "34eceJ..", 0, "1P5Ef7FsaD1KsJNSTUcACceEWN9vsUe3eN", 350000, "L1RLQhjuGoQ37QP4jfaEFTHMuEUeh4JdUDkx32xeafhnpzRMDMXD", null, null, 4000000)
		
		//returns {"signedtx":"894291f54d..."}

This function will return an object with the key "signedtx" which will contain the raw hex signed transaction that can now be broadcast to any node or API.		
		
See test.html for an example of using the `createTransaction()` function.

## Available Functions

If you pass the string "testnet" as the last parameter to any function you can enable testnet mode.

`createP2PKH` - Creates a random legacy Pay-to-Public-Key-Hash key pair     
		`{pk: "L3yB7BjTxZxGgncDRJjo8b8dRfohkyCg483hyXtPjHybCMB455hq", addr: "1D8rBAjwoNYNNMaLGep5QE9LzZCib5zgPW"}`  
	
`createP2WPKH` - Creates a random native (bech32) segwit key pair   
		`{pk: "L55gBvUQx3Z792DDqz4BfYmMKVh6LA6itcnR7dqoaYCfPnuvZzrW", addr: "bc1q27cl6u8s98xwvskrqwpefd5wyhd2ddmcceh7lt"}`  
	
`createP2SHP2WPKH` - Creates a random p2sh wrapped segwit key pair   
		`{pk: "KwXXRZUaMaGCHMbbd3kB6N3vmyqK48s2Ha9Ymw9yvzAoWyn59vFS", addr: "3DbnaQaajcLHcBphyDZ1AdikuAJ8r2VugX"}`     
	
`getNewAddress` - Creates a random key pair and outputs all 3 address types (P2PKH, P2WPKH, P2SH-P2WPKH)  
 
		{pk: "KwnP8HN5rPahxnPvrBX2vpHcYyJ5TtaoEsfkBvvdAbX4Q3Yy8DjH", 
		p2pkh: "1N75qvRHxCMjPNjLUHtmdTFJrVCmjo8TQQ", 
		p2wpkh: "bc1qu7qju2u8q5nnmwf2kjr8jla7n6jqjzvhyqjx76", 
		p2shp2wpkh: "3LLhaQgC5KZ5TETmTUHA6BgeLQPMJ4ePV7", 
		redeemScript: "0014e7812e2b8705273db92ab486797fbe9ea4090997"}     
		
	
`createFrom("molly aqua jump tuba ratchet while")` - 1 parameter (string). Creates a key pair from a sha256 of an arbitrary string a.k.a. brain wallet.   
    
		{pk:"L5h92N3b6djz45sr5Qx8KTkm7cQNgz7boanZQDJ5dBRHgo3eQr9L",
		p2pkh:"14KAfpWgxnSaVSqBeTTmem8sJozfpBYUeB",
		p2shp2wpkh:"3JT1WjLkzovMBkwirCWqjuLs7h4UGtjecm",
		p2wpkh:"bc1qy3t7l2wcjmveqlp8gd7x34drkc77fgddupyhzj",
		publicKey:"020feae0933265694cf7d19e60e47a417bf6802162982ca2ef338983d74de24567",
		redeemScript:"00142457efa9d896d9907c27437c68d5a3b63de4a1ad"}      
		
	 
`getDetails("L1RLQhj...")` - 1 parameter (string). Takes a WIF private key and outputs all 3 address types, redeem script and public key   
  
		{pk:"L5h92N3b6djz45sr5Qx8KTkm7cQNgz7boanZQDJ5dBRHgo3eQr9L",
		p2pkh:"14KAfpWgxnSaVSqBeTTmem8sJozfpBYUeB",
		p2shp2wpkh:"3JT1WjLkzovMBkwirCWqjuLs7h4UGtjecm",
		p2wpkh:"bc1qy3t7l2wcjmveqlp8gd7x34drkc77fgddupyhzj",
		publicKey:"020feae0933265694cf7d19e60e47a417bf6802162982ca2ef338983d74de24567",
		redeemScript:"00142457efa9d896d9907c27437c68d5a3b63de4a1ad"}	
		
	 
`validateAddress("bc1hq...")` - 1 parameter (string). Returns true if input is a valid bitcoin address    
		`true`

`pubToAddress("03bcdd5e6e06ee2b9864cae3ab0df5f70b36ec9c40764b610848368acd20e2518a")` - 1 parameter (string). Decodes public key and outputs all address types.    
	
		{p2pkh: "1MbrKq1aYb5npy3yiStifk28JAkW5hSbi3"
		p2shp2wpkh: "3R21MeWpfEgMU1bNeqM3gMbuoYpgaFf3sJ"
		p2wpkh: "bc1qa73gekj7nk6yfcs8x2w82u6xfnpadgvrmgxqy9"
		redeemScript: "0014e1f9d51e3e95f2156abb35ddcb1858c0d74dd5a6"} 
	
	
`createTransaction` - 9 Parameters see Section 5 above. Builds and signs a raw transaction

`bip38Encrypt("L1RLqh...","satoshi")` - 2 parameters (string, string). Takes a WIF private key and a passphrase to encrypt the private key using BIP38.    
     
		{pk: "6PYUfFSV3gQhBEPHqeEWBYKiAkfL8EZUWNMJw56ATddy7AnqPWTouju53k", 
		p2pkh: "14KAfpWgxnSaVSqBeTTmem8sJozfpBYUeB", 
		p2wpkh: "bc1qy3t7l2wcjmveqlp8gd7x34drkc77fgddupyhzj", 
		p2shp2wpkh: "3JT1WjLkzovMBkwirCWqjuLs7h4UGtjecm", 
		redeemScript: "00142457efa9d896d9907c27437c68d5a3b63de4a1ad"}	
		
	
`bip38Decrypt("6PYUz..","satoshi")` - 2 parameters (string, string). Takes a BIP38 encrypted key and a passphrase to reveal the decrypted WIF private key.

`multisig(pubkey1,pubkey2,pubkey3)` - 3 parameters (string, string, string). This function will take 3 public keys and creates a 2 of 3 multisig address.

`multisigRandom(m,n)` - 2 parameters (integer, integer). M must be less than N. Generates random private keys based on the inputs provided and outputs the multisig address, redeemscript and private keys needed to sign.     
	
`sha256("some string", n)` - 2 parameters (string, integer). This function takes an input string and performs a sha256 hash function `n` times to the input.

`newMnemonic()` - no parameters. Generates a new random BIP39 mnemonic phrase

{words: "today lazy october deliver sphere scatter torch jeans topic shoot ramp peace"}
    
    
`mnemonic2SeedHex("today lazy october deliver sphere scatter torch jeans topic shoot ramp peace")` - 1 parameter (string). Converts a mnemonic phrase to a hexidecimal seed.
    
    `seedHex: "816409492435b94d076308e3465ee497a216a7c084dffae9a0a32fb2da082f85fffb32d8e5e5f2f055ee6226f6f37626fa50e9e81607286d738aa724b838a207"`

`seedToXpub("816409492435b94d076308e3465ee497a216a7c084dffae9a0a32fb2da082f85fffb32d8e5e5f2f055ee6226f6f37626fa50e9e81607286d738aa724b838a207",44,0)` - 3 parameters (string, ,integer, integer). First parameter is a hex seed. Second is derivation path (valid 44, 49, 84). Third parameter is HD account.

xpub: "xpub6CEPuPkgcF8ikp6ciN1HYemgmeV3VfnuX3Y6Qy63bosaRs9gkk6TbkM4cLgJJVLDMXoQu5F9CeNcVuHwttE7zPoUPKQ1tWaRNCFswbr14s6"
    
    
`seedToXprv("816409492435b94d076308e3465ee497a216a7c084dffae9a0a32fb2da082f85fffb32d8e5e5f2f055ee6226f6f37626fa50e9e81607286d738aa724b838a207",44,0)` - 3 parameters (string, integer). First  parameter is a hex seed. Second is derivation path (valid 44, 49, 84). Third parameter is HD account.

xprv: "xprv9yF3VtDnmsaRYL29cLUHBWpxDceZ6D549pcVcagS3ULbZ4pYDCnD3x2am2H8TnsZUzLquGEWxWrZRCV6Ded9SnGDwjcu583TThfdugrkgHa"

`fromXpub("xpub6CEPuPkgcF8ikp6ciN1HYemgmeV3VfnuX3Y6Qy63bosaRs9gkk6TbkM4cLgJJVLDMXoQu5F9CeNcVuHwttE7zPoUPKQ1tWaRNCFswbr14s6",0,0)` - 4 parameters (string, integer, integer, integer/string). First parameter is xpub (do not use ypub or zpub, that is for external use only. Use the last parameter in this function to select address type). Second is change address account. Third parameter is key index.

`{addr: "1LsASXW6Z69jeKW9JaAKnwpcNXfaKUYbQY"}`
    
    
`xprvToWIF("xprv9yF3VtDnmsaRYL29cLUHBWpxDceZ6D549pcVcagS3ULbZ4pYDCnD3x2am2H8TnsZUzLquGEWxWrZRCV6Ded9SnGDwjcu583TThfdugrkgHa",0,0)` - 3 parameters (string, integer, integer). First parameter is xprv. Second is change address account. Third parameter is key index.

{wif: "KwwpeWxAMmLpxLQrZrpC9V6ThE1bYaW42ScbxCKQw76qgCqAPtQt"}
    
    
`fromHDSeed("816409492435b94d076308e3465ee497a216a7c084dffae9a0a32fb2da082f85fffb32d8e5e5f2f055ee6226f6f37626fa50e9e81607286d738aa724b838a207",44,0,0,0)` - 5 parameters (string, integer, integer, integer, integer). First parameter is hex seed. Second is derivation path (valid 44, 49, 84). Third is HD account. Fourth is change address account. Fifth is key index.

`{
    addr: "1LsASXW6Z69jeKW9JaAKnwpcNXfaKUYbQY", 
    pk: "KwwpeWxAMmLpxLQrZrpC9V6ThE1bYaW42ScbxCKQw76qgCqAPtQt"
    }`

* The `createTransaction` function does not support multisig at this time *

## Projects that use buidl.js
* FastWallet.info
* SegWitAddress.org

If you have a project you would like listed, please create a pull request updating the README.md to include your project

=================================================

Please consider donating if you find this tool useful.

BTC:  3LnFQjs5HracJn5cakAmGQ8N1PZey65kyJ

buidljs

buidljs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

buidljs

buidljs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README