Skip to content

Commit

Permalink
chore(bitgo): update references to core
Browse files Browse the repository at this point in the history
- updates references to old core module with new bitgo module name

Ticket: BG-41837
  • Loading branch information
bitgoAaron committed Mar 23, 2022
1 parent 88c43ab commit ca9e23c
Show file tree
Hide file tree
Showing 11 changed files with 78 additions and 78 deletions.
2 changes: 1 addition & 1 deletion .codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ comment:
flags:
bitgo:
paths:
- modules/core
- modules/bitgo
account-lib:
paths:
- modules/account-lib
Expand Down
58 changes: 29 additions & 29 deletions CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -7,41 +7,41 @@
# Order is important. The last matching pattern has the most precedence.

# Recovery
modules/core/src/v2/recovery.ts [email protected]
modules/bitgo/src/v2/recovery.ts [email protected]

# Coin Support
modules/core/src/v2/coins/*btc.ts @BitGo/btc-team
modules/core/src/v2/coins/*bch.ts @BitGo/btc-team
modules/core/src/v2/coins/*btg.ts @BitGo/btc-team
modules/core/src/v2/coins/*bsv.ts @BitGo/btc-team
modules/core/src/v2/coins/*ltc.ts @BitGo/btc-team
modules/core/src/v2/coins/*dash.ts @BitGo/btc-team
modules/core/src/v2/coins/*zec.ts @BitGo/btc-team
modules/core/src/v2/coins/abstractUtxoCoin.ts @BitGo/btc-team
modules/core/src/v2/coins/utxo/* @BitGo/btc-team
modules/bitgo/src/v2/coins/*btc.ts @BitGo/btc-team
modules/bitgo/src/v2/coins/*bch.ts @BitGo/btc-team
modules/bitgo/src/v2/coins/*btg.ts @BitGo/btc-team
modules/bitgo/src/v2/coins/*bsv.ts @BitGo/btc-team
modules/bitgo/src/v2/coins/*ltc.ts @BitGo/btc-team
modules/bitgo/src/v2/coins/*dash.ts @BitGo/btc-team
modules/bitgo/src/v2/coins/*zec.ts @BitGo/btc-team
modules/bitgo/src/v2/coins/abstractUtxoCoin.ts @BitGo/btc-team
modules/bitgo/src/v2/coins/utxo/* @BitGo/btc-team

# Eth
modules/core/src/v2/coins/abstractEthLikeCoin.ts @BitGo/eth-team
modules/core/src/v2/coins/*celo.ts @BitGo/eth-team
modules/core/src/v2/coins/celoToken.ts @BitGo/eth-team
modules/core/src/v2/coins/*eth.ts @BitGo/eth-team
modules/core/src/v2/coins/*eth2.ts @BitGo/eth-team
modules/core/src/v2/coins/*rbtc.ts @BitGo/eth-team
modules/core/src/v2/coins/token.ts @BitGo/eth-team

modules/core/test/v2/unit/coins/abstractEthLikeCoin.ts @BitGo/eth-team
modules/core/test/v2/unit/coins/*celo.ts @BitGo/eth-team
modules/core/test/v2/unit/coins/celoToken.ts @BitGo/eth-team
modules/core/test/v2/unit/coins/*eth.ts @BitGo/eth-team
modules/core/test/v2/unit/coins/*eth2.ts @BitGo/eth-team
modules/core/test/v2/unit/coins/*rbtc.ts @BitGo/eth-team
modules/core/test/v2/unit/coins/token.ts @BitGo/eth-team

modules/core/src/v2/coins/*xlm.ts [email protected] [email protected] [email protected]
modules/core/src/v2/coins/*xrp.ts [email protected] [email protected] [email protected]
modules/bitgo/src/v2/coins/abstractEthLikeCoin.ts @BitGo/eth-team
modules/bitgo/src/v2/coins/*celo.ts @BitGo/eth-team
modules/bitgo/src/v2/coins/celoToken.ts @BitGo/eth-team
modules/bitgo/src/v2/coins/*eth.ts @BitGo/eth-team
modules/bitgo/src/v2/coins/*eth2.ts @BitGo/eth-team
modules/bitgo/src/v2/coins/*rbtc.ts @BitGo/eth-team
modules/bitgo/src/v2/coins/token.ts @BitGo/eth-team

modules/bitgo/test/v2/unit/coins/abstractEthLikeCoin.ts @BitGo/eth-team
modules/bitgo/test/v2/unit/coins/*celo.ts @BitGo/eth-team
modules/bitgo/test/v2/unit/coins/celoToken.ts @BitGo/eth-team
modules/bitgo/test/v2/unit/coins/*eth.ts @BitGo/eth-team
modules/bitgo/test/v2/unit/coins/*eth2.ts @BitGo/eth-team
modules/bitgo/test/v2/unit/coins/*rbtc.ts @BitGo/eth-team
modules/bitgo/test/v2/unit/coins/token.ts @BitGo/eth-team

modules/bitgo/src/v2/coins/*xlm.ts [email protected] [email protected] [email protected]
modules/bitgo/src/v2/coins/*xrp.ts [email protected] [email protected] [email protected]

# Trading accounts
modules/core/src/v2/trading/*.ts [email protected]
modules/bitgo/src/v2/trading/*.ts [email protected]

# Express
modules/express/* [email protected]
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The BitGo SDK repository is a monorepo composed of separate modules, each of whi

| Package Name | Module | Description | |
|---------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
| bitgo | `core` | Authentication, wallet management, user authentication, cryptographic primitives, abstract coin interfaces, coin implementations. | [Link](https://github.com/BitGo/BitGoJS/tree/master/modules/core) |
| bitgo | `bitgo` | Authentication, wallet management, user authentication, cryptographic primitives, abstract coin interfaces, coin implementations. | [Link](https://github.com/BitGo/BitGoJS/tree/master/modules/bitgo) |
| @bitgo/account-lib | `account-lib` | Build and sign transactions for account-based coins. | [Link](https://github.com/BitGo/BitGoJS/tree/master/modules/account-lib) |
| @bitgo/blake2b | `blake2b` | Blake2b (64-bit version) in pure JavaScript. | [Link](https://github.com/BitGo/BitGoJS/tree/master/modules/blake2b) |
| @bitgo/blake2b-wasm | `blake2b-wasm` | Blake2b implemented in WASM. | [Link](https://github.com/BitGo/BitGoJS/tree/master/modules/blake2b-wasm) |
Expand All @@ -29,16 +29,16 @@ The BitGo SDK repository is a monorepo composed of separate modules, each of whi

Each module provides release notes in `modules/*/RELEASE_NOTES.md`.

The release notes for the `core` module are [here](https://github.com/BitGo/BitGoJS/blob/master/modules/core/RELEASE_NOTES.md).
The release notes for the `bitgo` module are [here](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/RELEASE_NOTES.md).

# Examples

Examples can be found in each of the modules specific to the module use cases. Starter examples can be found [here](https://github.com/BitGo/BitGoJS/tree/master/modules/core/example).
Examples can be found in each of the modules specific to the module use cases. Starter examples can be found [here](https://github.com/BitGo/BitGoJS/tree/master/modules/bitgo/example).

# NodeJS Version Support Policy

We only support [Long-Term Support](https://github.com/nodejs/Release) versions of Node, with the current set of
supported versions described in the [`engines` property of the `core` module package.json](https://github.com/BitGo/BitGoJS/blob/master/modules/core/package.json#L18).
supported versions described in the [`engines` property of the `bitgo` module package.json](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/package.json#L18).

We specifically limit our support to LTS versions of Node, not because this package won't work on other versions, but
because LTS versions tend to be the most widely used in practice. It's possible the packages in this repository will
Expand All @@ -63,4 +63,4 @@ installing this package on a supported version of Node, please report the issue

# Notes for Developers

See [DEVELOPERS.md](https://github.com/BitGo/BitGoJS/blob/master/DEVELOPERS.md)
See [DEVELOPERS.md](https://github.com/BitGo/BitGoJS/blob/master/DEVELOPERS.md)
2 changes: 1 addition & 1 deletion modules/bitgo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For more general information about the BitGo API, please see our [REST API Docum

# Release Notes

You can find the complete release notes (since version 4.44.0) [here](https://github.com/BitGo/BitGoJS/blob/master/modules/core/RELEASE_NOTES.md).
You can find the complete release notes (since version 4.44.0) [here](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/RELEASE_NOTES.md).

# Example Usage

Expand Down
10 changes: 5 additions & 5 deletions modules/bitgo/RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,8 +333,8 @@ __No changes__
* Allow `gasLimit` param to be sent when prebuilding Ethereum transactions

### Bug Fixes
* Fix type custom type inclusion in core module
* Move superagent type augmentation into `core/types`
* Fix type custom type inclusion in bitgo module
* Move superagent type augmentation into `bitgo/types`

## 8.1.1 (09-11-2019)

Expand Down Expand Up @@ -530,11 +530,11 @@ This breaking change was required since some of the coins we are considering add
* Extract example keycard rendering logic out of `Wallet`

## 6.0.0
The BitGoJS SDK is being modularized! The code base has been split into two modules: `core` and `express`.
The BitGoJS SDK is being modularized! The code base has been split into two modules: `bitgo` and `express`.

`core` contains the Javascript library that you get when you `require('bitgo')`.
`bitgo` contains the Javascript library that you get when you `require('bitgo')`.

`express` contains the source for the BitGo Express local signing server, and it uses the `core` module to provide access to BitGoJS functionality over a REST interface.
`express` contains the source for the BitGo Express local signing server, and it uses the `bitgo` module to provide access to BitGoJS functionality over a REST interface.

The long term plan is to modularize based on each underlying coin library, so users of `bitgo` won't need to bring in many large dependencies for coins they aren't using. This may require additional major versions if breaking changes are required, but we will do as much as possible to maintain the current API of the BitGoJS SDK.

Expand Down
60 changes: 30 additions & 30 deletions modules/bitgo/example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,47 +4,47 @@

In this directory, you can find examples on how to use the BitGoJS SDK with TypeScript. These examples use modern TypeScript/ES6 syntax with `async`/`await`. This is the recommended way to use the BitGoJS SDK for new projects.

* [Backup Key Creation](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/backup-key-creation.ts)
* [Create Policy](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/create-policy.ts)
* [Create Wallet Address](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/create-wallet-address.ts)
* [Create Wallet Addresses](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/create-wallet-addresses.ts)
* [Create Wallet](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/create-wallet.ts)
* [Get Maximum Spendable](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/get-maximum-spendable.ts)
* [Get Wallet Balance](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/get-wallet-balance.ts)
* [Get Wallet](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/get-wallet.ts)
* [Get Wallet](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/get-wallet.ts)
* [List Wallet Shares](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/list-wallet-shares.ts)
* [List Wallet Transfers](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/list-wallet-transfers.ts)
* [List Wallets](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/list-wallets.ts)
* [Recover XRP](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/recover-xrp.ts)
* [Resend Wallet Share Invite](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/resend-wallet-share-invite.ts)
* [Send Wallet Transaction](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/send-wallet-transaction.ts)
* [Send With Provided Public Key](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/send-with-provided-public-keys.ts)
* [Share Wallet](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/share-wallet.ts)
* [Update Wallet Forwarders](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/update-wallet-forwarders.ts)
* [Backup Key Creation](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/backup-key-creation.ts)
* [Create Policy](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/create-policy.ts)
* [Create Wallet Address](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/create-wallet-address.ts)
* [Create Wallet Addresses](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/create-wallet-addresses.ts)
* [Create Wallet](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/create-wallet.ts)
* [Get Maximum Spendable](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/get-maximum-spendable.ts)
* [Get Wallet Balance](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/get-wallet-balance.ts)
* [Get Wallet](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/get-wallet.ts)
* [Get Wallet](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/get-wallet.ts)
* [List Wallet Shares](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/list-wallet-shares.ts)
* [List Wallet Transfers](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/list-wallet-transfers.ts)
* [List Wallets](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/list-wallets.ts)
* [Recover XRP](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/recover-xrp.ts)
* [Resend Wallet Share Invite](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/resend-wallet-share-invite.ts)
* [Send Wallet Transaction](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/send-wallet-transaction.ts)
* [Send With Provided Public Key](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/send-with-provided-public-keys.ts)
* [Share Wallet](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/share-wallet.ts)
* [Update Wallet Forwarders](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/update-wallet-forwarders.ts)

### Algorand (ALGO)

* [Account Consolidation Build](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/algo/account-consolidation-build.ts)
* [Account Consolidation Send](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/algo/account-consolidation-send.ts)
* [Disable Token](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/algo/disable-token.ts)
* [Enable Token](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/algo/enable-token.ts)
* [Account Consolidation Build](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/algo/account-consolidation-build.ts)
* [Account Consolidation Send](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/algo/account-consolidation-send.ts)
* [Disable Token](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/algo/disable-token.ts)
* [Enable Token](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/algo/enable-token.ts)

### Ethereum (ETH)

* [Create Wallet Address](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/eth/create-wallet-address.ts)
* [Create Wallet](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/eth/create-wallet.ts)
* [Deploy Forwarder](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/eth/deployForwarder.ts)
* [Flush Forwarder Token](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/eth/flushForwarderToken.ts)
* [Set Flush Threshold](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/eth/set-flush-threshold.ts)
* [Create Wallet Address](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/eth/create-wallet-address.ts)
* [Create Wallet](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/eth/create-wallet.ts)
* [Deploy Forwarder](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/eth/deployForwarder.ts)
* [Flush Forwarder Token](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/eth/flushForwarderToken.ts)
* [Set Flush Threshold](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/eth/set-flush-threshold.ts)

### Tezos (XTZ)

* [Consolidate Account Balances](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/xtz/consolidate-account-balances.ts)
* [Create Address](https://github.com/BitGo/BitGoJS/blob/master/modules/core/example/ts/xtz/create-address.ts)
* [Consolidate Account Balances](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/xtz/consolidate-account-balances.ts)
* [Create Address](https://github.com/BitGo/BitGoJS/blob/master/modules/bitgo/example/ts/xtz/create-address.ts)

## `js` directory (JavaScript)

In this directory, you can find examples on how to use the BitGoJS SDK with JavaScript. These examples use coroutine syntax with `yield`.

> Note the directory structure is the same for the JavaScript examples as the TypeScript examples listed above.
> Note the directory structure is the same for the JavaScript examples as the TypeScript examples listed above.
4 changes: 2 additions & 2 deletions modules/bitgo/example/ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ You will need node and npm installed locally. You can find information on how to

## Running the examples

First, run `npm install` in the `modules/core` directory.
First, run `npm install` in the `modules/bitgo` directory.

```
$ cd modules/core && npm install
$ cd modules/bitgo && npm install
```

Then change into the `example/ts` directory and use `npx ts-node` to run the desired example:
Expand Down
2 changes: 1 addition & 1 deletion modules/bitgo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"repository": {
"type": "git",
"url": "https://github.com/BitGo/BitGoJS.git",
"directory": "modules/core"
"directory": "modules/bitgo"
},
"license": "Apache-2.0",
"engines": {
Expand Down
Loading

0 comments on commit ca9e23c

Please sign in to comment.