refactored jellyfish-address to use a much lighter design

[fuxingloh]

What kind of PR is this?:

/kind refactor

What this PR does / why we need it:

Refactoring of jellyfish-address code/logic to be lighter, currently, it's too complex. Dangerous technical debt.

Implemented an address parser with a simple interface and design, with just 2 main code branches and 4 sub-if branches. The previous implementation has been deprecated but not yet removed to make migration less forceful.

export interface DecodedAddress {
  type: AddressType
  address: string
  script: Script
  network: NetworkName
}

/**
 * Convert an address to a script, this operation requires the network to be known.
 * A script is network agnostic while the address is prefixed with the network's unique human readable part.
 *
 * @param {string} address to convert into Script
 * @param {NetworkName} network to prefix human readable part of the address
 * @return {DecodedAddress | undefined} DecodedAddress if is a recognizable, undefined if fail to parse
 */
export function fromAddress (address: string, network: NetworkName): DecodedAddress | undefined

Usage Example:

const decoded = fromAddress('df1qpe7q4vvtxpdunpazvmwqdh3xlnatfdt2xr8mpv', 'mainnet')

expect(decoded).toStrictEqual({
  type: AddressType.P2WPKH,
  address: 'df1qpe7q4vvtxpdunpazvmwqdh3xlnatfdt2xr8mpv',
  script: {
    stack: [
      OP_CODES.OP_0,
      OP_CODES.OP_PUSHDATA_HEX_LE('0e7c0ab18b305bc987a266dc06de26fcfab4b56a')
    ]
  },
  network: 'mainnet'
})

Which issue(s) does this PR fixes?:

Fixes #239

[codeclimate]

Code Climate has analyzed commit 7c70b6a and detected 10 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	2
Duplication	8

View more on Code Climate.

[github-actions]

size-limit report 📦

Path	Size	Loading time (3g)	Running time (snapdragon)	Total time
packages/jellyfish/dist/index.umd.js	23.5 KB (0%)	470 ms (0%)	116 ms (+118.74% 🔺)	586 ms

[codecov]

Codecov Report

Merging #674 (7c70b6a) into main (a09a251) will increase coverage by 0.02%.
The diff coverage is 97.75%.

@@            Coverage Diff             @@
##             main     #674      +/-   ##
==========================================
+ Coverage   97.57%   97.59%   +0.02%     
==========================================
  Files         140      140              
  Lines        4166     4245      +79     
  Branches      519      543      +24     
==========================================
+ Hits         4065     4143      +78     
- Misses        101      102       +1     

Impacted Files	Coverage Δ
packages/jellyfish-address/src/script/P2SH.ts	95.45% <87.50%> (-4.55%)	⬇️
...ckages/jellyfish-address/src/script/Base58Check.ts	95.00% <92.30%> (+5.00%)	⬆️
packages/jellyfish-address/src/address.ts	84.00% <100.00%> (ø)
packages/jellyfish-address/src/base58_address.ts	93.93% <100.00%> (ø)
packages/jellyfish-address/src/bech32_address.ts	100.00% <100.00%> (ø)
packages/jellyfish-address/src/index.ts	97.82% <100.00%> (ø)
packages/jellyfish-address/src/script/Bech32.ts	91.66% <100.00%> (+5.95%)	⬆️
packages/jellyfish-address/src/script/P2PKH.ts	100.00% <100.00%> (ø)
packages/jellyfish-address/src/script/P2WPKH.ts	100.00% <100.00%> (ø)
packages/jellyfish-address/src/script/P2WSH.ts	100.00% <100.00%> (ø)
... and 5 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a09a251...7c70b6a. Read the comment docs.

[netlify]

✔️ Deploy Preview for jellyfish-defi ready!

🔨 Explore the source changes: 7c70b6a

🔍 Inspect the deploy log: https://app.netlify.com/sites/jellyfish-defi/deploys/614cb057dd26ec00070c54b9

😎 Browse the preview: https://deploy-preview-674--jellyfish-defi.netlify.app