Skip to content

Commit

Permalink
chore(docs): point project to birthdayresearch/jellyfishsdk (#2103)
Browse files Browse the repository at this point in the history
#### What this PR does / why we need it:

As per title.
  • Loading branch information
fuxingloh authored May 23, 2023
1 parent d15b4c7 commit afed8a4
Show file tree
Hide file tree
Showing 36 changed files with 55 additions and 55 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,13 @@ TODO comments should usually include the author's github username in parentheses
## Publishing

`"version": "0.0.0"` is used because publishing will be done automatically
by [GitHub releases](https://github.com/JellyfishSDK/jellyfish/releases) with connected workflows. On
by [GitHub releases](https://github.com/BirthdayResearch/jellyfishsdk/releases) with connected workflows. On
release `types: [ published ]`, GitHub Action will automatically build all packages in this repo and publish it into
npm. All packages in this mono-repo will require `"peerDependencies": "defichain"` this setup ensures all
subsequent `@defichain/*` package uses the same version.

For packages with accompanying docker images, they are published automatically to GitHub Container Registry
(ghcr.io/jellyfishsdk). When a new [GitHub releases](https://github.com/JellyfishSDK/jellyfish/releases) is triggered,
(ghcr.io/birthdayresearch). When a new [GitHub releases](https://github.com/BirthdayResearch/jellyfishsdk/releases) is triggered,
GitHub Action will automatically build the docker image in this repo and publish it. Two images are created for each
release targeting `linux/amd64` and `linux/arm64`. The latest tag will always be updated with the last release and
semantic release is enforced for each release.
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![CI](https://github.com/JellyfishSDK/jellyfish/actions/workflows/ci.yml/badge.svg)](https://github.com/JellyfishSDK/jellyfish/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/JellyfishSDK/jellyfish/branch/main/graph/badge.svg?token=M22thSGyqO)](https://codecov.io/gh/JellyfishSDK/jellyfish)
[![CI](https://github.com/BirthdayResearch/jellyfishsdk/actions/workflows/ci.yml/badge.svg)](https://github.com/BirthdayResearch/jellyfishsdk/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/BirthdayResearch/jellyfishsdk/branch/main/graph/badge.svg?token=M22thSGyqO)](https://codecov.io/gh/BirthdayResearch/jellyfishsdk)
[![npm](https://img.shields.io/npm/v/@defichain/jellyfish-network)](https://www.npmjs.com/package/@defichain/jellyfish-network)
[![Netlify Status](https://api.netlify.com/api/v1/badges/c5b7a65e-aeec-4e12-a7b7-300cbc1a8069/deploy-status)](https://app.netlify.com/sites/cranky-franklin-5e59ef/deploys)

Expand All @@ -22,11 +22,11 @@ the way to make it merge-able. Here are some of our documented [contributing gui
## Security issues

If you discover a security vulnerability in
`JellyfishSDK/jellyfish`,
`BirthdayResearch/jellyfishsdk`,
[please see submit it privately](https://github.com/JellyfishSDK/.github/blob/main/SECURITY.md).

## License & Disclaimer

By using `JellyfishSDK/jellyfish` (this repo), you (the user) agree to be bound by [the terms of this license](LICENSE).
By using `BirthdayResearch/jellyfishsdk` (this repo), you (the user) agree to be bound by [the terms of this license](LICENSE).

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FDeFiCh%2Fjellyfish.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FDeFiCh%2Fjellyfish?ref=badge_large)
2 changes: 1 addition & 1 deletion apps/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain-apps/nest-apps",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"scripts": {
"build": "nest build",
Expand Down
12 changes: 6 additions & 6 deletions apps/playground-api/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Playground API

Migration of the entire `JellyfishSDK/playground` project into `JellyfishSDK/jellyfish/apps/playground-api`. This
project is different from `JellyfishSDK/jellyfish/packages/playground`.
Migration of the entire `JellyfishSDK/playground` project into `BirthdayResearch/jellyfishsdk/apps/playground-api`. This
project is different from `BirthdayResearch/jellyfishsdk/packages/playground`.

## Motivation

> https://github.com/JellyfishSDK/jellyfish/issues/580
> https://github.com/BirthdayResearch/jellyfishsdk/issues/580
As part of [#580](https://github.com/JellyfishSDK/jellyfish/issues/580) consolidation efforts. We had multiple projects
As part of [#580](https://github.com/BirthdayResearch/jellyfishsdk/issues/580) consolidation efforts. We had multiple projects
that were extensions of the jellyfish project. The separated projects allowed us to move quickly initially but proves to
be a bottleneck when it comes to development.

> https://github.com/JellyfishSDK/jellyfish/issues/978
> https://github.com/BirthdayResearch/jellyfishsdk/issues/978
We need to maintain this project regardless of the slated deprecation. By migrating this project into
`JellyfishSDK/jellyfish`, we can maintain it in one place.
`BirthdayResearch/jellyfishsdk`, we can maintain it in one place.

6 changes: 3 additions & 3 deletions apps/status-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ DeFiChain Status API, providing the statuses of different DeFiChain services.


## Motivation
> https://github.com/JellyfishSDK/jellyfish/issues/1270
> https://github.com/BirthdayResearch/jellyfishsdk/issues/1270
To decouple the DeFiChain products from the status page, the approach of having a centralised provider to determine each DeFiChain service status with a pre-defined logic will allow it to be maintained consistently throughout. This will allow other apps or services to share the status from the same Status APIs.

### `/blockchain`
>https://github.com/JellyfishSDK/jellyfish/issues/1271
>https://github.com/BirthdayResearch/jellyfishsdk/issues/1271
To provide the status of the blockchain based on the block creation time interval

Expand All @@ -31,7 +31,7 @@ To provide the status of each oracle given the address based on the last publish


### `/overall`
>https://github.com/JellyfishSDK/jellyfish/issues/1274
>https://github.com/BirthdayResearch/jellyfishsdk/issues/1274
To provide the aggregated status of all services required by Light Wallet & Scan (Blockchain & Ocean).

2 changes: 1 addition & 1 deletion docs/node/02-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const {blocks} = await client.mining.getMiningInfo()
## IEEE-754 arbitrary precision

Due to the dynamic nature of the JavaScript language, it forces all number to be interpolated as IEEE-754 which can
cause precision to be lost. [JellyfishSDK/jellyfish/issues/18](https://github.com/JellyfishSDK/jellyfish/issues/18)
cause precision to be lost. [BirthdayResearch/jellyfishsdk/issues/18](https://github.com/BirthdayResearch/jellyfishsdk/issues/18)

```js
it('lost precision converting DFI 😥', () => {
Expand Down
4 changes: 2 additions & 2 deletions docs/ocean/01-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /
:::info BETA API v0 & beyond

Ocean REST API is currently in public BETA, all endpoint is prefixed with `/v0`. As part of
[JellyfishSDK/jellyfish#580](https://github.com/JellyfishSDK/jellyfish/issues/580) consolidation effort to creating
[BirthdayResearch/jellyfishsdk#580](https://github.com/BirthdayResearch/jellyfishsdk/issues/580) consolidation effort to creating
better development synergy, `/v1` of the API is undergoing redesign and will look very different from `/v0`.
`/v0` of the API is **used in production by `DeFiCh/wallet` and `DeFiCh/scan`**, the API will be long-lived with
frequent incremental change with backward compatibility.
Expand All @@ -20,7 +20,7 @@ frequent incremental change with backward compatibility.
Ocean REST API is a global infrastructure project hosted by DeFiChain to simplify building decentralized light
applications. Powered by the Jellyfish Ecosystem, it features a super index that extends the capability of `defid`. The
project is currently housed in [JellyfishSDK/whale](https://github.com/JellyfishSDK/whale), they are getting
consolidated into `JellyfishSDK/jellyfish` as a single monorepo project.
consolidated into `BirthdayResearch/jellyfishsdk` as a single monorepo project.

Ocean Nodes are globally distributed around the world, any API request is served by the node nearest to the requester
with auto fail-over.
Expand Down
2 changes: 1 addition & 1 deletion docs/testing/03-jellyfish-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ testing.poolpair // for poolpair setup with reasonable defaults

<details>

<summary>Usage within JellyfishSDK/jellyfish/packages</summary>
<summary>Usage within BirthdayResearch/jellyfishsdk/packages</summary>

### Cyclic dependencies

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "defichain",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"files": [],
"workspaces": [
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-address/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-address",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-api-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-api-core",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-api-core/src/category/spv.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ export class Spv {
/**
* Looking at ain, it's returning an array of txid containing only 1 txid.
* Considering some factors, this implementation is different from the rpc docs
* on ain side. Refer to PR https://github.com/JellyfishSDK/jellyfish/pull/1324
* on ain side. Refer to PR https://github.com/BirthdayResearch/jellyfishsdk/pull/1324
*/
return await this.client.call<string[]>('spv_refundhtlcall', [destinationAddress, options.feeRate], 'number')
}
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-api-jsonrpc/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-api-jsonrpc",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-block/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-block",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist",
"types": "dist",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-buffer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-buffer",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-crypto/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-crypto",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-json/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-json",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-network/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-network",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-testing/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-testing",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-transaction-builder/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-transaction-builder",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist",
"types": "dist",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-transaction-signature/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-transaction-signature",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist",
"types": "dist",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-transaction/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-transaction",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist",
"types": "dist",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-wallet-classic/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-wallet-classic",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-wallet-encrypted/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-wallet-encrypted",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions packages/jellyfish-wallet-mnemonic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ agnostic.

### #555 Broke Compatibility with BIP32

> https://github.com/JellyfishSDK/jellyfish/pull/555
> https://github.com/BirthdayResearch/jellyfishsdk/pull/555
In [#555](https://github.com/JellyfishSDK/jellyfish/pull/555) a significant change was done to
In [#555](https://github.com/BirthdayResearch/jellyfishsdk/pull/555) a significant change was done to
"@defichain/jellyfish-wallet-mnemonic". Part of the BIP32 specification literature defines the use of HMAC-SHA512.
`"Calculate I = HMAC-SHA512(Key = "Bitcoin seed", Data = S)"`. The `Key` in this implementation was updated
to `"@defichain/jellyfish-wallet-mnemonic"`. Although a novel idea at that time, this, unfortunately, created
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-wallet-mnemonic/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-wallet-mnemonic",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/jellyfish-wallet/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/jellyfish-wallet",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/ocean-api-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/ocean-api-client",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/playground-api-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/playground-api-client",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/playground/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/playground",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/rich-list-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/rich-list-core",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/testcontainers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/testcontainers",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/testing/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/testing",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/whale-api-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/whale-api-client",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/whale-api-wallet/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "@defichain/whale-api-wallet",
"version": "0.0.0",
"description": "SDK & Ecosystem for building modern lite DeFi Applications at scale.",
"repository": "JellyfishSDK/jellyfish",
"repository": "BirthdayResearch/jellyfishsdk",
"license": "MIT",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
Loading

0 comments on commit afed8a4

Please sign in to comment.