Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

University docs bugs, mostly nits #127

Open
eliotstock opened this issue Jun 15, 2022 · 1 comment
Open

University docs bugs, mostly nits #127

eliotstock opened this issue Jun 15, 2022 · 1 comment

Comments

@eliotstock
Copy link

At https://university.subquery.network/quickstart/quickstart.html:

for this guide we will use "Polkadot"
I only see Substrate. Oh wait, that's the network family, not the network. network family isn't in the docs yet.

RPC endpoint (Required): Provide a HTTPS URL
Actually the default is a wss URL.

Git repo comes after RPC endpoint in CLI flow but before in the docs.

cd PROJECT_NAME
yarn install

cd PROJECT_NAME
npm install

Second cd is redundant. [Much later] Oh! I only just realised these are two alternatives and I only need to run one of them. Can we not put these into a single code block with 'yarn' and 'npm' tabs? Experienced devs will know these are alternatives, but it still seems clunky to show both snippets.

Copying the Transfer snippet into schema.graphql and running yarn codegen throws:

Unknown type "Account".
error Command failed with exit code 1.

Was I supposed to do this right away?

The Projet Manifest
typo

In the code snippets:

import { Transfer } from "../types";
At this point my project's types dir has only an empty models dir in it. I have no types and VSC renders a problem (red squiggly underline). And in fact this kills the yarn build step below. This is 'error continued' from point 5 above. I'm going to change the Account types to Strings so I can move forward.

You can update the handleEvent...
Actually we're renaming it to handleTransfer so this is more like replacing the whole file and updating a function.

yarn start:docker threw 'Permission denied' errors. I had to do the stuff at https://docs.docker.com/engine/install/linux-postinstall/ to get docker to run wtihout sudo. I expect this is just me though - most users will have docker properly set up already.

I got errors starting docker:

subquery-node_1   | 2022-06-15T22:33:46.569Z <fetch> ERROR failed to index block at height 1 handleBlock() TypeError: mappingFunctions[funcName] is not a function

Can we add any frequently used troubleshooting steps at this point in the docs?

I noticed the manifest still has handler: handleEvent but my mapping source has a function called handleTransfer(). I renamed handleTransfer() back to handleEvent() and rebuilt, but got the same error.

@eliotstock
Copy link
Author

Point 10 above was due to a leftover handler declared in the starter project.yaml that I hadn't removed. User error, but can we make the docs more clear that all other handlers need to be deleted?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant