Skip to content

Commit

Permalink
docs(readme): remove mention of apps-config (#985)
Browse files Browse the repository at this point in the history
* docs(readme): remove mention of apps-config

* remove instances of apps-config
  • Loading branch information
TarikGul committed Jul 27, 2022
1 parent f80666a commit e003e93
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 6 deletions.
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,6 @@ Some chains require custom type definitions in order for Sidecar to know how to
retrieved from the node. Sidecar affords environment variables which allow the user to specify an absolute path to a JSON file that contains type definitions in the corresponding formats. Consult polkadot-js/api for more info on
the type formats (see `RegisteredTypes`).

**N.B** Types set from environment variables will override the corresponding types pulled from
@polkadot/apps-config.

- `SAS_SUBSTRATE_TYPES_BUNDLE`: a bundle of types with versioning info, type aliases, derives, and
rpc definitions. Format: `OverrideBundleType` (see [`typesBundle`](https://github.com/polkadot-js/api/blob/21039dec1fcad36061a96bf5526248c5fab38780/packages/types/src/types/registry.ts#L72)).
- `SAS_SUBSTRATE_TYPES_CHAIN`: type definitions keyed by `chainName`. Format: `Record<string, RegistryTypes>` (see [`typesChain`](https://github.com/polkadot-js/api/blob/21039dec1fcad36061a96bf5526248c5fab38780/packages/types/src/types/registry.ts#L76)).
Expand Down Expand Up @@ -303,8 +300,6 @@ All the commits in this repo follow the [Conventional Commits spec](https://www.
and read the release notes for any breaking changes or high priority updates. In order to update all the dependencies and resolutions run `yarn update-pjs-deps`.

- @polkadot/api [release notes](https://github.com/polkadot-js/api/releases)
- @polkadot/apps-config [release notes](https://github.com/polkadot-js/apps/releases)
- If there are any major changes to this package that includes third party type packages, its worth noting to contact the maintainers of sidecar and do a peer review of the changes in apps-config, and make sure no bugs will be inherited.
- @polkadot/util-crypto [release notes](https://github.com/polkadot-js/common/releases)
- @substrate/calc [npm release page](https://www.npmjs.com/package/@substrate/calc)

Expand Down
1 change: 0 additions & 1 deletion guides/CHAIN_INTEGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,4 @@ Make sure it passes lint with `yarn lint --fix` and tests with `yarn test`. Then

#### 5) Maintenance

- Keep types up-to-date in `@polkadot/apps-config`
- If the business logic or storage of a chain's pallet queried by a Sidecar endpoint is changed, ensure that the corresponding service logic is updated in Sidecar as well

0 comments on commit e003e93

Please sign in to comment.