Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

chore: reorganize repo #4467

Merged
merged 8 commits into from
Aug 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ docs/assets/launch.json linguist-language=JSON5
tsconfig-base.json linguist-language=JSON5
.nycrc linguist-language=JSON
.prettierrc linguist-language=JSON
src/packages/ganache/api-extractor.json linguist-language=JSON5
src/packages/ganache/tsdoc.json linguist-language=JSON5
packages/ganache/api-extractor.json linguist-language=JSON5
packages/ganache/tsdoc.json linguist-language=JSON5
18 changes: 0 additions & 18 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,21 +1,3 @@
# global code owner:

* @davidmurdoch

# typed transactions:

src/chains/ethereum/transaction/src/access-lists.ts @MicaiahReid
src/chains/ethereum/transaction/src/base-transaction.ts @MicaiahReid
src/chains/ethereum/transaction/src/eip1559-fee-market-transaction.ts @MicaiahReid
src/chains/ethereum/transaction/src/eip2930-access-list-transaction.ts @MicaiahReid
src/chains/ethereum/transaction/src/legacy-transaction.ts @MicaiahReid
src/chains/ethereum/transaction/src/transaction-factory.ts @MicaiahReid
src/chains/ethereum/transaction/src/transaction-types.ts @MicaiahReid

# transaction pool:

src/chains/ethereum/ethereum/src/transaction-pool.ts @MicaiahReid

# miner:

src/chains/ethereum/ethereum/src/miner @MicaiahReid
2 changes: 1 addition & 1 deletion .github/actions/docker-publish/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ runs:
uses: docker/build-push-action@175d02bffea74695e96b351069ac938b338802f9
with:
context: .
file: ./src/packages/ganache/Dockerfile
file: ./packages/ganache/Dockerfile
push: true
tags: ${{ format('trufflesuite/ganache:{0}, trufflesuite/ganache:v{1}', inputs.TAG, inputs.VERSION) }}
labels: ${{ steps.meta.outputs.labels }}
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ jobs:
run: |
npm run build &&
npm run prepublishOnly &&
cd ./src/packages/ganache &&
cd ./packages/ganache &&
npm pack &&
size="$(zcat ganache-*.tgz | wc -c)" &&
echo "Bundle size: $size" &&
Expand All @@ -69,4 +69,4 @@ jobs:
uses: actions/upload-artifact@v3
with:
name: Candidate
path: ./src/packages/ganache/ganache-*.tgz
path: ./packages/ganache/ganache-*.tgz
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ jobs:

- name: Set VERSION
run: |
echo "VERSION=$(node -e 'console.log(require("./src/packages/ganache/package.json").version)')" >> $GITHUB_ENV
echo "VERSION=$(node -e 'console.log(require("./packages/ganache/package.json").version)')" >> $GITHUB_ENV

- name: Set VERSION as job output variable
id: set_version_output
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ node_modules
.nyc_output
lerna-debug.log
npm-debug.log
src/**/*/lib
packages/**/*/lib
coverage
dist/
typings/
2 changes: 1 addition & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
.nyc_output
lerna-debug.log
npm-debug.log
src/**/*/lib
packages/**/*/lib
coverage
npm-shrinkwrap.json
docs/assets/js/ganache/*
Expand Down
16 changes: 4 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
- `git clone [email protected]:trufflesuite/ganache.git`
- `cd ganache`
- `npm install` (use npm v6)
- On Linux and macOS: run `source completions.sh` to enable autocomplete for npm scripts.

## Solving node-gyp issues

Expand Down Expand Up @@ -97,20 +96,13 @@ To pass options to the cli you must separate the args with `--`, e.g.:

- `npm start -- --chain.chainId 1 --wallet.totalAccounts 5`

## To create a new chain/flavor

- `npm run create <name> --location chains`

This will create a new folder at `src/chains/<name>` where `<name>` should be the flavor name (e.g. `ethereum`), which
you then can [create packages under](#to-create-a-new-package).

## To create a new package

- `npm run create <name> --location <location> [--folder <folder>]`

This will create a new package with Ganache defaults at `src/<location>/<name>`.
This will create a new package with Ganache defaults at `<location>/<name>`.

If you provide the optional `--folder` option, the package will be created at `src/<location>/<folder>`.
If you provide the optional `--folder` option, the package will be created at `<location>/<folder>`.

## To add a module to a package:

Expand Down Expand Up @@ -160,8 +152,8 @@ index 2a2aa9e..57cbf21 100644
"--colors",
"--require",
"ts-node/register",
- "${workspaceFolder}/src/**/tests/**/*.test.ts"
+ "${workspaceFolder}/src/chains/ethereum/ethereum/tests/**/*.test.ts"
- "${workspaceFolder}/packages/**/tests/**/*.test.ts"
+ "${workspaceFolder}/packages/ethereum/ethereum/tests/**/*.test.ts"
],
"skipFiles": ["<node_internals>/**"],
"console": "integratedTerminal",
Expand Down
2 changes: 1 addition & 1 deletion README.md
39 changes: 0 additions & 39 deletions completions.sh

This file was deleted.

2 changes: 1 addition & 1 deletion docs/assets/js/ganache/ganache.min.js

Large diffs are not rendered by default.

7 changes: 0 additions & 7 deletions docs/assets/js/ganache/ganache.min.js.LICENSE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,6 @@
* @license MIT
*/

/*!
* @ganache/filecoin-options
*
* @author Tim Coulter
* @license MIT
*/

/*!
* @ganache/secp256k1
*
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/ganache/ganache.min.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/assets/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"--colors",
"--require",
"ts-node/register",
"${workspaceFolder}/src/**/tests/**/*.test.ts"
"${workspaceFolder}/packages/**/tests/**/*.test.ts"
],
"skipFiles": [
"<node_internals>/**"
Expand Down
Loading