Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
ae1de13
feat: chainSpec based controller config; Types from apps-config
emostov Nov 24, 2020
5d254dd
Update mock api to include derive getBlock - specs work
emostov Nov 24, 2020
7072fdc
Update to reflect TS 4.1
emostov Nov 24, 2020
c682665
Clean up comments
emostov Nov 24, 2020
4ab1b2d
Save
emostov Dec 2, 2020
cc9a962
Merge origin master
emostov Dec 2, 2020
ede1787
feat: Token query param for non-native token balance-info
emostov Dec 2, 2020
39e1a1a
Revert package.json
emostov Dec 2, 2020
be66056
Initial reply david review
emostov Dec 2, 2020
e465092
Update src/main.ts
emostov Dec 2, 2020
19a66e7
Remove kulupu controller
emostov Dec 2, 2020
0ac5573
Merge branch 'types-package' of https://github.com/paritytech/substra…
emostov Dec 2, 2020
c5e9284
Add chain builder integration guide
emostov Dec 3, 2020
0c57ecd
Patch CHAIN_INTEGRATION.md
emostov Dec 3, 2020
6692e50
Apply suggestions from code review
emostov Dec 4, 2020
4b4d9a2
Update CHAIN_INTEGRATION.md
emostov Dec 4, 2020
b81c0d1
Bump deps
emostov Dec 8, 2020
46f067d
Merge remote-tracking branch 'origin' into types-package
emostov Dec 8, 2020
92a8856
Use whole options object for controller creation
emostov Dec 8, 2020
8451309
Apply suggestions from code review
emostov Dec 9, 2020
87572a9
Respond to maciej feedback
emostov Dec 9, 2020
c38c105
Merge branch 'types-package' of https://github.com/paritytech/substra…
emostov Dec 9, 2020
a1a988a
Update chain integration guide
emostov Dec 9, 2020
79f9eb8
Remove excessive nullish colescing operators
emostov Dec 9, 2020
cf84d63
Merge origin master
emostov Dec 9, 2020
b34cca2
Fix merge issue
emostov Dec 9, 2020
a16235a
Update CHAIN_INTEGRATION.md
emostov Dec 9, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from code review
Co-authored-by: joe petrowski <[email protected]>
  • Loading branch information
emostov and joepetrowski authored Dec 4, 2020
commit 6692e50a8d1a9fdc00021a5edb064de4734a296c
8 changes: 4 additions & 4 deletions CHAIN_INTEGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ This guide aims to help chain builders integrate their Substrate FRAME based cha

In order decode the SCALE encoded data from a substrate based node, polkadot-js needs to have a registry of type definitions. Sidecar pulls in chain type definitions from the [@polkadot/apps-config package hosted on NPM](https://www.npmjs.com/package/@polkadot/apps-config).

If the chains type definitions do not already exist in [@polkadot/apps-config](https://github.com/polkadot-js/apps/tree/master/packages/apps-config) they will need to be added via PR to polkadot-js/apps by following their [instructions for API config](https://github.com/polkadot-js/apps/tree/master/packages/apps-config#api).
If the chain's type definitions do not already exist in [@polkadot/apps-config](https://github.com/polkadot-js/apps/tree/master/packages/apps-config) they will need to be added via PR to polkadot-js/apps by following their [instructions for API config](https://github.com/polkadot-js/apps/tree/master/packages/apps-config#api).

Before taking any other steps to integrate a chain with Sidecar, a chains up-to-date type definitions must be included in a published version of @polkadot/apps-config.
Before taking any other steps to integrate a chain with Sidecar, a chain's up-to-date type definitions must be included in a published version of @polkadot/apps-config.

## Controller configuration

Expand All @@ -29,7 +29,7 @@ A chain builder can follow the below steps and submit a chain's controller confi

To determine what controllers to include, one must consider the runtime logic, specifically what pallets the chain uses. It is important to keep in mind the assumptions the service's logic makes and what exact pallets the service queries. E.g. in order to use [`PalletsStakingProgressController`](/src/controllers/pallets/PalletsStakingProgressController.ts), one would check [`PalletsStakingProgressService.ts`](/src/services/pallets/PalletsStakingProgressService.ts). There one would see it queries `staking`, `sessions`, `babe` pallets and makes certain assumptions about how the pallets are used together in the runtime.

In some circumstance, a chain may need a new path, modify a path or altered bushiness logic for a path it. Path changes that help a chain support custodial wallets will be given priority. Breaking path changes are strongly not preferred.
In some circumstance, a chain may need a new path, modify a path or altered business logic for a path. Path changes that help a chain support custodial wallets will be given priority. Breaking path changes are strongly not preferred.

##### Basic balance transfer support

Expand Down Expand Up @@ -58,7 +58,7 @@ const specToControllerMap = {

#### 3) Test

Run it against an archive version of your chains node:
Run it against an archive version of your chain's node:

- Ensure all the correct paths work, including the root path
- Exercise each query param of every path
Expand Down