Skip to content

Commit 6856375

Browse files
authored
rename ocean to whale as they are 2 separate and different project (#151)
* rename ocean project to whale as they are 2 separate and different project * added 1 second delay after bash script to reduce test flakiness * renamed ci.yml to ci-size.yml * separated standard in CI to another job * updated coverage option * "jest" coverage should be in jest.config.js * refactor testcontainers to separate masternode
1 parent f04eb19 commit 6856375

File tree

27 files changed

+198
-190
lines changed

27 files changed

+198
-190
lines changed

.github/CODEOWNERS

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@
1212
/packages/jellyfish/ @fuxingloh
1313
/packages/jellyfish-api-core/ @fuxingloh @canonbrother
1414
/packages/jellyfish-api-jsonrpc/ @fuxingloh
15-
/packages/jellyfish-api-ocean/ @fuxingloh @canonbrother
15+
/packages/jellyfish-api-whale/ @fuxingloh @canonbrother
1616
/packages/jellyfish-crypto/ @fuxingloh
1717
/packages/jellyfish-json/ @fuxingloh @canonbrother
1818
/packages/jellyfish-network/ @fuxingloh
1919
/packages/jellyfish-transaction/ @fuxingloh
2020
/packages/jellyfish-wallet/ @fuxingloh
2121
/packages/jellyfish-wallet-mnemonic/ @fuxingloh
22-
/packages/jellyfish-wallet-ocean/ @fuxingloh
22+
/packages/jellyfish-wallet-whale/ @fuxingloh
2323
/packages/testcontainers/ @fuxingloh
2424

2525
lerna.json @fuxingloh

.github/ISSUE_TEMPLATE/1-bug-report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug report
3-
about: Report a bug encountered with using jellyfish
3+
about: Report a bug encountered with using DeFi Jellyfish
44
labels: kind/bug
55
---
66

.github/ISSUE_TEMPLATE/2-enhancement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Enhancement request
3-
about: Suggest an enhancement for jellyfish
3+
about: Suggest an enhancement for DeFi Jellyfish
44
labels: kind/feature
55
---
66

.github/ISSUE_TEMPLATE/3-general.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: General question
3-
about: General question about using jellyfish
3+
about: General question about using DeFi Jellyfish
44
labels: kind/question
55
---
66

.github/governance.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ issue:
3636
- jellyfish
3737
- jellyfish-api-core
3838
- jellyfish-api-jsonrpc
39-
- jellyfish-api-ocean
39+
- jellyfish-api-whale
4040
- jellyfish-crypto
4141
- jellyfish-json
4242
- jellyfish-network
4343
- jellyfish-transaction
4444
- jellyfish-wallet
4545
- jellyfish-wallet-mnemonic
46-
- jellyfish-wallet-ocean
46+
- jellyfish-wallet-whale
4747
- testcontainers
4848
multiple: true
4949
needs:

.github/labeler.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ labels:
2626
matcher:
2727
files: "packages/jellyfish-api-jsonrpc/**"
2828

29-
- label: area/jellyfish-api-ocean
29+
- label: area/jellyfish-api-whale
3030
sync: true
3131
matcher:
32-
files: "packages/jellyfish-api-ocean/**"
32+
files: "packages/jellyfish-api-whale/**"
3333

3434
- label: area/jellyfish-crypto
3535
sync: true
@@ -61,10 +61,10 @@ labels:
6161
matcher:
6262
files: "packages/jellyfish-wallet-mnemonic/**"
6363

64-
- label: area/jellyfish-wallet-ocean
64+
- label: area/jellyfish-wallet-whale
6565
sync: true
6666
matcher:
67-
files: "packages/jellyfish-wallet-ocean/**"
67+
files: "packages/jellyfish-wallet-whale/**"
6868

6969
- label: area/testcontainers
7070
sync: true

.github/labels.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
- color: fbca04
6464
name: area/jellyfish-api-jsonrpc
6565
- color: fbca04
66-
name: area/jellyfish-api-ocean
66+
name: area/jellyfish-api-whale
6767
- color: fbca04
6868
name: area/jellyfish-crypto
6969
- color: fbca04
@@ -75,7 +75,7 @@
7575
- color: fbca04
7676
name: area/jellyfish-wallet
7777
- color: fbca04
78-
name: area/jellyfish-wallet-ocean
78+
name: area/jellyfish-wallet-whale
7979
- color: fbca04
8080
name: area/jellyfish-wallet-mnemonic
8181
- color: fbca04

.github/workflows/ci-size-limit.yml renamed to .github/workflows/ci-size.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: CI
1+
name: CI Size
22

33
on:
44
pull_request:

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ jobs:
2020
- run: npm run build
2121
- run: npm run standard
2222

23-
- run: npx --no-install jest --ci --coverage --forceExit
23+
- run: npm run test:ci
2424
- run: npx codecov

.idea/jellyfish.iml

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
A collection of TypeScript + JavaScript tools and libraries for DeFi Blockchain developers to build decentralized
1010
finance on Bitcoin.
1111

12-
> 🚧 Work in progress, `10/193` rpc completed.
12+
> 🚧 Work in progress.
1313
1414
## Installation
1515

@@ -77,7 +77,8 @@ Documentation can be found at `https://jellyfish.defichain.com`?
7777
7878
### Packages
7979
80-
Jellyfish follows a monorepo methodology, all maintained packages are in the same repo and published with the same version tag.
80+
DeFi Jellyfish follows a monorepo methodology, all maintained packages are in the same repo and published with the same
81+
version tag.
8182
8283
[![npm](https://img.shields.io/npm/v/@defichain/jellyfish)](https://www.npmjs.com/package/@defichain/jellyfish/v/latest)
8384
[![npm@next](https://img.shields.io/npm/v/@defichain/jellyfish/next)](https://www.npmjs.com/package/@defichain/jellyfish/v/next)
@@ -87,9 +88,14 @@ Package | Description
8788
`@defichain/jellyfish` | Library bundled usage entrypoint with conventional defaults for 4 bundles: umd, esm, cjs and d.ts
8889
`@defichain/jellyfish-api-core` | A protocol agnostic DeFi Blockchain client interfaces, with a "foreign function interface" design.
8990
`@defichain/jellyfish-api-jsonrpc` | Implements the [JSON-RPC 1.0](https://www.jsonrpc.org/specification_v1) specification for api-core.
91+
`@defichain/jellyfish-api-whale` | Implements the DeFi Whale service communication specification for api-core.
92+
`@defichain/jellyfish-crypto` | Cryptography operations for jellyfish, includes a simple 'secp256k1' EllipticPair.
9093
`@defichain/jellyfish-json` | Allows parsing of JSON with 'lossless', 'bignumber' and 'number' numeric precision.
9194
`@defichain/jellyfish-network` | Contains DeFi blockchain various network configuration for mainnet, testnet and regtest.
9295
`@defichain/jellyfish-transaction` | Dead simple modern stateless raw transaction builder for DeFi.
96+
`@defichain/jellyfish-wallet` | Jellyfish wallet is a managed wallet, where account can get discovered from an HD seed.
97+
`@defichain/jellyfish-wallet-mnemonic` | MnemonicHdNode implements the WalletHdNode from jellyfish-wallet; a CoinType-agnostic HD Wallet for noncustodial DeFi.
98+
`@defichain/jellyfish-wallet-whale` | WhaleWalletAccount implements the WalletAccount from jellyfish-wallet; a stateless account service for DeFi.
9399
`@defichain/testcontainers` | Provides a lightweight, throw away instances for DeFiD node provisioned automatically in a Docker container.
94100
95101
## Developing & Contributing

package-lock.json

Lines changed: 9 additions & 18 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,9 @@
2525
"publish:latest": "lerna run publish:latest",
2626
"standard": "ts-standard --fix",
2727
"test": "jest",
28+
"test:ci": "jest --ci --coverage --forceExit",
2829
"all": "npm run build && npm run standard && npm run test"
2930
},
30-
"jest": {
31-
"collectCoverageFrom": [
32-
"**/*.{ts,js}",
33-
"!**/__tests__/**",
34-
"!**/coverage/**",
35-
"!**/node_modules/**",
36-
"!**/babel.config.js",
37-
"!**/jest.setup.js"
38-
]
39-
},
4031
"devDependencies": {
4132
"@size-limit/preset-app": "^4.10.1",
4233
"@types/jest": "^26.0.22",

packages/jellyfish-crypto/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
"name": "DeFi Jellyfish Contributors"
2727
}
2828
],
29-
"main": "dist",
30-
"types": "dist",
29+
"main": "./dist/index.js",
30+
"types": "./dist/index.d.ts",
3131
"files": [
3232
"dist"
3333
],

packages/jellyfish-wallet-ocean/README.md

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[![npm](https://img.shields.io/npm/v/@defichain/jellyfish-wallet-whale)](https://www.npmjs.com/package/@defichain/jellyfish-wallet-whale/v/latest)
2+
[![npm@next](https://img.shields.io/npm/v/@defichain/jellyfish-wallet-whale/next)](https://www.npmjs.com/package/@defichain/jellyfish-wallet-whale/v/next)
3+
4+
# @defichain/jellyfish-wallet-whale
5+
6+
WhaleWalletAccount implements the WalletAccount from jellyfish-wallet; a stateless account service for DeFi.
7+
All stateless and stateful node service is provided by DeFi whale server.

packages/jellyfish-wallet-ocean/package.json renamed to packages/jellyfish-wallet-whale/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"private": false,
3-
"name": "@defichain/jellyfish-wallet-ocean",
3+
"name": "@defichain/jellyfish-wallet-whale",
44
"version": "0.0.0",
55
"description": "A collection of TypeScript + JavaScript tools and libraries for DeFi Blockchain developers to build decentralized finance on Bitcoin",
66
"keywords": [

packages/jellyfish-wallet-ocean/src/index.ts renamed to packages/jellyfish-wallet-whale/src/index.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ import { Network } from '@defichain/jellyfish-network'
33
import { HRP, toBech32 } from '@defichain/jellyfish-crypto'
44

55
/**
6-
* jellyfish-api-ocean implementation of WalletAccount.
6+
* jellyfish-api-whale implementation of WalletAccount.
77
* All stateless and stateful node service is provided by an ocean instance.
88
*/
9-
export class OceanWalletAccount implements WalletAccount {
9+
export class WhaleWalletAccount implements WalletAccount {
1010
private readonly hdNode: WalletHdNode
1111
private readonly network: Network
1212

@@ -29,18 +29,18 @@ export class OceanWalletAccount implements WalletAccount {
2929
}
3030

3131
/**
32-
* Provide OceanWalletAccount with upstream to DeFi ocean services.
32+
* Provide WhaleWalletAccount with upstream to DeFi whale services.
3333
*/
34-
export class OceanWalletAccountProvider implements WalletAccountProvider<OceanWalletAccount> {
34+
export class WhaleWalletAccountProvider implements WalletAccountProvider<WhaleWalletAccount> {
3535
private readonly network: Network
3636

37-
// TODO(fuxingloh): to implement after 'jellyfish-api-ocean'
37+
// TODO(fuxingloh): to implement after 'jellyfish-api-whale'
3838

3939
constructor (network: Network) {
4040
this.network = network
4141
}
4242

43-
provide (hdNode: WalletHdNode): OceanWalletAccount {
44-
return new OceanWalletAccount(hdNode, this.network)
43+
provide (hdNode: WalletHdNode): WhaleWalletAccount {
44+
return new WhaleWalletAccount(hdNode, this.network)
4545
}
4646
}

packages/jellyfish-wallet/jest.config.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,9 @@ module.exports = {
88
},
99
verbose: true,
1010
clearMocks: true,
11-
testTimeout: 120000
11+
testTimeout: 120000,
12+
coveragePathIgnorePatterns: [
13+
'/node_modules/',
14+
'.*/__tests__/.*'
15+
]
1216
}

0 commit comments

Comments
 (0)