Skip to content

Commit

Permalink
fix: adjusting residual docker mentions regarding fuel-core (FuelLa…
Browse files Browse the repository at this point in the history
  • Loading branch information
arboleya authored Jul 5, 2023
1 parent 26a689b commit 044de73
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 26 deletions.
2 changes: 2 additions & 0 deletions .changeset/pink-lobsters-study.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
run: |
pnpm changeset version
echo "BUILD_VERSION=$(sed -nE 's/^\s*"version": "(.*?)",$/\1/p' packages/fuels/package.json)" >> $GITHUB_ENV
echo "FUEL_CORE_VERSION=$(sed 's/.*fuel-core:v\(.*\).*/\1/;t;d' ./.docker/fuel-core/Dockerfile)" >> $GITHUB_ENV
echo "FUEL_CORE_VERSION=$(cat ./packages/fuel-core/VERSION)" >> $GITHUB_ENV
echo "FORC_VERSION=$(cat ./packages/forc/VERSION)" >> $GITHUB_ENV
git reset --hard
env:
Expand Down
12 changes: 0 additions & 12 deletions .vscode/tasks.json

This file was deleted.

6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ pnpm test packages/my-desired-package
pnpm test packages/my-desired-package/src/my.test.ts
```

Or if you want to run docker and all tests serially you can do:
Or if you want to start a local Fuel-Core node and run all tests serially you can do:

```sh
pnpm ci:test
Expand Down Expand Up @@ -192,10 +192,10 @@ After this you should run tests and fix any incompatibilities.

# Updating Fuel Core version

Manually edit the `.docker/fuel-core/Dockerfile` file, add the right version, and then:
Manually edit the `packages/fuel-core/VERSION` file, add the right version, and then:

```sh
pnpm node:clean # causes rebuilding of local node DB
pnpm install # will download new binaries
pnpm test:ci
```

Expand Down
11 changes: 6 additions & 5 deletions apps/docs/src/guide/providers/connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ At a high level, you can use the Fuel TypeScript SDK to build applications that

For this interaction to work, the SDK must be able to communicate with a `fuel-core` node; you have two options at your disposal:

1. Use the [Testnet](../providers/connecting-to-an-external-node.md) or run a Fuel node (using `fuel-core`) and instantiate a provider that points to that node's IP and port.
2. Use Docker - `pnpm services:run`
3. Use [fuelup](https://github.com/FuelLabs/fuelup)

The second/third options are ideal for smart contract testing, as you can quickly spin up and tear down nodes between specific test cases.
1. Use the [Testnet](../providers/connecting-to-an-external-node.md)
1. Run a local Fuel-Core node and instantiate a provider that points to that node's IP and port:
- Run `pnpm node:run` will spin up a short-lived node locally, OR
- Use [fuelup](https://github.com/FuelLabs/fuelup) to setup the entire Fuel toolchain

For application building, you should use the first option.

The second option is ideal for smart contract testing, as you can quickly spin up and tear down nodes between specific test cases.
3 changes: 0 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,6 @@
"lint:md-links": "tsx ./scripts/lint-md-links",
"prettier:check": "prettier --check --cache --cache-location=./.husky/.lintcache/prettier packages",
"prettier:format": "prettier --write packages",
"services:run": "pnpm docker:run:bg",
"services:clean": "pnpm docker:clean",
"services:restart": "run-s services:clean services:run",
"changeset:publish": "changeset publish --no-git-tag",
"changeset:next": "tsx ./scripts/changeset-next",
"changeset:version-with-docs": "tsx ./scripts/changeset-version-with-docs",
Expand Down
2 changes: 1 addition & 1 deletion packages/versions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
It automatically assembles all supported versions of the Fuel toolchain, including:

- `FUELS` — comes from `/packages/fuels/package.json`
- `FUEL_CORE` — comes from `/.docker/fuel-core/Dockerfile`
- `FUEL_CORE` — comes from `/packages/fuel-core/VERSION`
- `FORC` — comes from `/packages/forc/VERSION`

There is a `prebuild` script to ensure that the `src/index.ts` file never goes outdated.
Expand Down
2 changes: 1 addition & 1 deletion packages/versions/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
1) Variables
------------
`FUELS` — comes from `/packages/fuels/package.json`
`FUEL_CORE` — comes from `/.docker/fuel-core/Dockerfile`
`FUEL_CORE` — comes from `/packages/fuel-core/VERSION`
`FORC` — comes from `/packages/forc/VERSION`
3) Pre Build
Expand Down

0 comments on commit 044de73

Please sign in to comment.