Merge pull request #181 from Bitcoin-com/stage

3.3.0

Author: cgcardona

README.md

@@ -20,17 +20,15 @@ Paid downloads, streaming media, in-app purchases, tokens and more ways for you
 
 ## Install / develop
 
-Make sure that you have the Gatsby CLI program installed:
-
 ```sh
-  npm install
-  npm start
+  yarn install
+  yarn start
 ```
 
 ## Build / deploy
 
 ```sh
-  npm run  build
+  yarn run build
   > deploy `/public` folder somewhere.
 ```
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "developer.bitcoin.com",
   "description": "Bitcoin.com developer resources and documentation",
-  "version": "3.2.7",
+  "version": "3.3.0",
   "author": "Peter <peter@bitcoin.com> and Gabriel Cardona <gabriel@bitcoin.com>",
   "dependencies": {
     "badger-components-react": "^0.1.3",

src/data/docs/badger/badger-components-react.md

@@ -36,12 +36,13 @@ Simple Badger Button to display the price in local currency, satoshi amount, and
 - `currency: string` - Default `USD` - [ISO Country Code](https://en.wikipedia.org/wiki/ISO_4217) to charge in
 - `showSatoshis: boolean` Default `true` - Show the value in BCH Satoshis below the button
 - `border: boolean` - Default `true` - Border around button and text
+- `opReturn: string[]` - Optional - OP_RETURN message
 - `text: string` - Optional - Text between the button and border
 - `successFn: Function` - Optional -Callback function when payment is successful
 - `failFn: Function` - Optional - Callback function when payment fails or is cancelled
 
 <spacer></spacer>
-<badger-button to="bitcoincash:pp8skudq3x5hzw8ew7vzsw8tn4k8wxsqsv0lt0mf3g" price="0.01" currency="CAD" text="Badger Button"></badger-button>
+<badger-button to="bitcoincash:pp8skudq3x5hzw8ew7vzsw8tn4k8wxsqsv0lt0mf3g" price="0.001" currency="CAD" text="Badger Button"></badger-button>
 
 #### Badger Badge
 
@@ -56,11 +57,12 @@ Supports the following props.
 - `border: boolean` - Default `true` - Border around button and text
 - `text: string` - Default `Payment Total` - Text between the button and border
 - `tag: string` - Default `Badger Pay` - Text on the button
+- `opReturn: string[]` - Optional - OP_RETURN message
 - `successFn: Function` - Optional - Callback function when payment is successful
 - `failFn: Function` - Optional - Callback function when payment fails or is cancelled
 
 <spacer></spacer>
-<badger-badge to="bitcoincash:pp8skudq3x5hzw8ew7vzsw8tn4k8wxsqsv0lt0mf3g" price="0.01" currency="CAD" text="Badger Badger"></badger-button>
+<badger-badge to="bitcoincash:pp8skudq3x5hzw8ew7vzsw8tn4k8wxsqsv0lt0mf3g" price="0.001" currency="USD" text="Badger Badger"></badger-button>
 
 #### Code Examples
 
@@ -83,6 +85,7 @@ const Example = props => {
         price={0.01} // Price in currency
         currency={'CAD'} // Currency to convert from
         to={'bitcoincash:pp8skudq3x5hzw8ew7vzsw8tn4k8wxsqsv0lt0mf3g'} // Payment address
+        opReturn={['0x6d02', 'Hello BadgerBadge!']}
         tag={'Badger Pay'} // Text on button
         text={'Payment Total'} // Text at top of badge
         showBrand={true} // Show link to badger website
@@ -95,6 +98,7 @@ const Example = props => {
         price={0.003}
         currency={'USD'}
         to={'bitcoincash:pp8skudq3x5hzw8ew7vzsw8tn4k8wxsqsv0lt0mf3g'}
+        opReturn={['0x6d02', 'Donated with Badger']}
         text={'Badger Pay'}
         showSatoshis={true}
         border={true}
@@ -110,13 +114,14 @@ export default Example
 
 ### Creating Custom Badger Integrations
 
-The library contains a Higher Order Component (HOC) `BadgerBase` which contains all of the required Badger interaction logic. This allows for any component to integrate with Badger easily.
+The library contains a Higher Order Component (HOC) `BadgerBase` which contains all of the required Badger interaction logic. This allows the creation of custom Badger integrations and components easily.
 
 Components wrapped in `BadgerBase` support the following props
 
 - `to: BCH Address` - Required - Bitcoin Cash address to send BCH to
 - `price: number` - Required - Price in chosen currency, will be turned into satoshis
 - `currency: string` - Default `USD` - [ISO Country Code](https://en.wikipedia.org/wiki/ISO_4217) to charge in
+- `opReturn: string[]` - Optional - OP_RETURN message to send with transaction
 
 And get the following props added to them for use in custom integration component
 

src/data/docs/bitbox/address.md

@@ -484,7 +484,8 @@ Detect an addess from an OutputScript.
 
 #### Arguments
 
-1.  scriptPubKey`Buffer`: scriptPubKey
+1.  scriptPubKey `Buffer`: scriptPubKey
+2.  network `String` **optional**: defaults to "mainnet"
 
 #### Result
 

src/data/docs/bitbox/hdnode.md

@@ -10,8 +10,8 @@ Create HDNode from Seed Buffer
 
 #### Arguments
 
-1.  rootSeed `Buffer` root seed buffer
-2.  network `string` optional network. default: 'bitcoin'
+1.  rootSeed `Buffer`: root seed buffer
+2.  network `String` **optional**: network. default: 'mainnet'
 
 #### Result
 

src/data/docs/bitbox/transactionBuilder.md

@@ -10,7 +10,7 @@ Create new Transaction Builder.
 
 #### Arguments
 
-1.  network `String`: Defaults to "bitcoincash"
+1.  network `String`: Defaults to "mainnet"
 
 #### Result
 
@@ -19,7 +19,7 @@ TransactionBuilder `TransactionBuilder`
 #### Examples
 
       // instance of transaction builder
-      let transactionBuilder = new BITBOX.TransactionBuilder('bitcoincash');
+      let transactionBuilder = new BITBOX.TransactionBuilder('mainnet');
 
 ### `hashTypes`