Interacting with Quorum nodes.

Put it in docs

Figure out what Bolt is and publish to docs

For Quorum & Remix for reference jpmorganchase/quorum/issues/549.

Do a MultiChain demo app and publish it in Tutorials

See if we need them at all and how to implement them https://vuepress.vuejs.org/default-theme-config/#prev-next-links

Put in Corda > Tools.

Sources:

https://lankydan.dev/ktor-a-kotlin-web-framework
https://lankydan.dev/connecting-a-ktor-web-server-to-a-corda-node

Explain the Gibibyte (Gi) notation for storage in control panel UI and put it in the docs

https://app.zenhub.com/files/135687734/8d3ca5a0-0eea-40ec-866c-36a5f34de956/download

Summary

The docs site currently doesn't match the UI and brand of Chainstack much in terms of colours and fonts.

We should make some small tweaks to align our properties more from a visual standpoint so that our brand is strong and persistent across the whole experience for users who interact with us.

Initiative

Brand and style consistency
Usability

Requirements

Update the UI on the docs site to be more inline with the rest of the Chainstack properties. This includes:

• Header logo, contents and colour
• Global font family, colours and sizing
• Side navigation colours

Out of scope:
We won't touch the design/layout of the documentation content itself

Stakeholders

@easeev
@mcbzz

1. Latest version to docs.dev.chainstack.com
2. Prod version to docs.chainstack.com

1. Open a section in docs
2. Click a link that leads to a subsection
3. The subsection does not expand by default, which leads to confusion

Example:

1. Click any link from the See also section at https://docs.dev.chainstack.com/blockchains/
2. The subsection page opens but the user is still in the Blockchains section

Summary

Problem
We do not have consistency in styling with the Chainstack docs site compared to the rest of the platform's header and side nav.

Solution
Update the following items on the Docs site:

• Header logo, contents and colour
• Side navigation styling

References

Requirements

Header

1. Add the Chainstack Docs logo to the header
2. Update the styling for the search bar and 'try free' CTA
3. Add a link to the console
4. Review sizing and styling of the top header (incl. padding, borders, drop shadow, etc.)

Side nav

1. Change the background colour to light blue/grey
2. Remove borders
3. Change triangles to carets
4. Review spacing, sizing, and states (unselected, hover and selected)

Adapt and publish https://hackernoon.com/executing-public-private-transactions-on-jpmorgans-quorum-with-web3-347190e3c35f to Tutorials section.

Review the docs for Quorum nodes access and credentials and update the protected access instructions.

For Quorum and Ethereum, we need to show a warning to explain in the docs that the unprotected endpoints will be deprecated.

Do and release version 1 of our documentation style guide

• Glossary https://github.com/chainstack/core/issues/213
• Protocol selection guide https://github.com/chainstack/core/issues/212
• Consensus selection explainer https://github.com/chainstack/core/issues/245
• Deployment options explainer https://github.com/chainstack/core/issues/247
• Governance selection guide https://github.com/chainstack/core/issues/301
• Getting started guide https://github.com/chainstack/core/issues/310
• Application bootstrapping guide (based on credentials that we provide) https://github.com/chainstack/core/issues/320
• Network lifecycle guide
• FAQ https://github.com/chainstack/core/issues/360

Investigate & fix.

Current behavior example:

1. Type "feedback" in the search field
2. See five results. Only one of them is a valid link

Probably has to do with legacy structure indexed.

including the faucet info

also fix the ropsten mention here https://docs.chainstack.com/projects/public-chain#networks

Rework the current documentation structure around topic-based authoring.

There are several typos that exist in the new content found on the Chainstack docs.

1. Under 'Application Development', the wrong article is each time a node is mentioned.

• Deploy an MultiChain node on Chainstack, and make a note of the connection details for the node.

• Deploy an Quorum node on Chainstack, and make a note of the connection details for the node.

2. Under 'Academic certificates on Ethereum

-"In this tutorial we will be writing a academic certificate generating DApp and will deploy it on public Ethereum node using Chainstack." This sentence structure feels odd in general.

-This is an ownable contract. It is implemented in a way that only authority can generate a certificate and only the contract owner can transfer his authority. (is this correct? personally not sure- should it be someone authorized?)

• This is our main contract. It will handle the generation and verification of certificates.

• generates a certificate by calculating a hash of student name and details

3. In general, we are using the oxford comma in all our communications, which are missing in the new docs pages

The UI elements in docs must follow the industry-wide standards and be in bold.

Refs:

• https://docs.gitlab.com/ee/development/documentation/styleguide.html#describing-ui-elements

• https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines#line-level-formatting

• GitHub guides at https://guides.github.com/

Interacting with nodes in a compatibility zone.

Description

Currently we have 'google-analytics' and 'sitemap' plugins enabled by default:

They should be enabled only on production stand.

Track vuejs/vuepress/issues/1727 and implement when it's done in vuepress.

We don't need the prev/next links as they clutter up our docs and we make extensive use of the See also section for a more efficient and precise guidance.

Scrub & crosslink articles once restructured

Adding this to backlog as a reference to #816.

Introduction

Chainstack is multi-cloud, multi-protocol Platform-as-a-Service. It automates DevOps process for public and consortium blockchain development. You can configure and deploy Ethereum, Quorum or MultiChain node using any cloud provider of your choice just with a few clicks.

You can try Chainstack for free here.

What needs to be done?

Your goal is to create a tutorial for new and existing Chainstack users that outlines the process of launching an application for public Ethereum. On a high level this tutorial should include 3 parts:

1. Deploying and connecting to the node
2. Writing and compiling a DApp
3. Interacting with the smart contract

General requirements

• 1000-2000 words tutorial with pictures and Markdown formatting
• Incorporated into the VuePress website under the Tutorials section which should come after Guides
• Open-sourced code including Solidity smart contracts
• Has to be working with Chainstack in production

DApp requirements

Smart contract in this tutorial should be a simplified version of a typical blockchain notarization application with the following functionality:

• Issue academic certificate
  • Can be called by particular accounts
  • Returns a hash of data (two strings: student name, credential details)
  • Stores hashed information on the blockchain
• Verify a certificate
  • Can be called by anyone
  • Checks if the credential is indeed correct provided a cryptographic certificate and original data

The tutorial has to use Truffle and Solidity for smart contracts.

You can use this example for the smart contract logic. Platform documentation can be used for the reference.

Implement a copy to clipboard feature for vuepress

touchbase/kickstart July 17

Add "Edit on Github" link to the docs.

Reasoning: fast feedback and contribution engagement

Implement the changes to the new docs we agreed on with Eugene and Jona.

@ThomasRalee while working updating the docs to reflect the protected Quorum APIs, I tested the Quorum food supply tutorial and it's not deploying anymore.

Note that I specify the .env in the following format (just in case, I don't think this is the issue):

RPC1='https://user-name:[email protected]'
PK1='TRANSACTION_MANAGER_PUBLIC_KEY'
RPC2='https://user-name:[email protected]'
PK2='TRANSACTION_MANAGER_PUBLIC_KEY'
RPC3='https://user-name:[email protected]'
PK3='TRANSACTION_MANAGER_PUBLIC_KEY'

Whenever I run node public.js it's failing with:

(node:8646) UnhandledPromiseRejectionWarning: Error: Returned error: authentication needed: password or unlock
    at Object.ErrorResponse (/root/fuck/node_modules/web3-core-helpers/src/errors.js:29:16)
    at /root/fuck/node_modules/web3-core-requestmanager/src/index.js:140:36
    at XMLHttpRequest.request.onreadystatechange (/root/fuck/node_modules/web3-providers-http/src/index.js:96:13)
    at XMLHttpRequestEventTarget.dispatchEvent (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request-event-target.js:34:22)
    at XMLHttpRequest._setReadyState (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request.js:208:14)
    at XMLHttpRequest._onHttpResponseEnd (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request.js:318:14)
    at IncomingMessage.<anonymous> (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request.js:289:61)
    at IncomingMessage.emit (events.js:214:15)
    at endReadableNT (_stream_readable.js:1178:12)
    at processTicksAndRejections (internal/process/task_queues.js:77:11)
(node:8646) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:8646) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
Error: Returned error: authentication needed: password or unlock
    at Object.ErrorResponse (/root/fuck/node_modules/web3-core-helpers/src/errors.js:29:16)
    at /root/fuck/node_modules/web3-core-requestmanager/src/index.js:140:36
    at XMLHttpRequest.request.onreadystatechange (/root/fuck/node_modules/web3-providers-http/src/index.js:96:13)
    at XMLHttpRequestEventTarget.dispatchEvent (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request-event-target.js:34:22)
    at XMLHttpRequest._setReadyState (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request.js:208:14)
    at XMLHttpRequest._onHttpResponseEnd (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request.js:318:14)
    at IncomingMessage.<anonymous> (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request.js:289:61)
    at IncomingMessage.emit (events.js:214:15)
    at endReadableNT (_stream_readable.js:1178:12)
    at processTicksAndRejections (internal/process/task_queues.js:77:11)

This probably has to do with web3 version 1.2.1.

I'm assigning this issue to you for the time being. Please let me know how this can be fixed and I'll update the tutorial.

User story #46

Checklist

Header bar

• Add the Chainstack Docs logo to the header
• Update the styling for the search bar and 'try free' CTA
• Add a link to the console
• Review sizing and styling of the top header (incl. padding, borders, drop shadow, etc.)
• Mobile view

Side nav

• Change the background colour to light blue/grey
• Remove borders
• Change triangles to carets
• Review spacing, sizing, and states (unselected, hover and selected)
• Mobile view

Use vuejs/vuepress#1339 once it's released

Write a MultiChain cold storage how-to and put it under Operations if #34 goes through

The problem

Opening most (but not all) sections in a new browser tab (eg CMD-click on macOS) shows the contents of docs/README.md instead of the proper section.

Steps to reproduce

1. Go to https://docs.chainstack.com/tutorials/academic-certificates-on-ethereum
2. maOS: CMD-click, Windows: CTRL-click (I think) on the Asset tokenization on Ethereum section in the sidebar.

Actual result

The rendered text in the new tab is from docs/README.md instead of the actual section.
In this new tab none of interactive elements load, so you can't browse and click the sidebar either.

Expected behaviour

A new tab opens with the proper section and the sidebar is interactive.

Environment

• OS: macOS Mojave Version: 10.14.6
• Browser:
  • Chrome Version 76.0.3809.100 (Official Build) (64-bit)
  • Safari Version 12.1.2 (14607.3.9)
  • Opera Version:62.0.3331.119
• The issue both with dev and prod.

Additional context

This happens with most of the sections in the scenario but not all.

From testing, I think the pattern is this (same both on dev and prod):

Fails:

1. Open a section that's not in the first group:
   eg https://docs.chainstack.com/tutorials/academic-certificates-on-ethereum

2. CMD/CTRL-click on any other section that's not in the first group
   eg Projects > Consortium.

Works:

1. Open a section that's not in the first group:
   eg https://docs.chainstack.com/tutorials/academic-certificates-on-ethereum

2. CMD/CTRL-click on any section that's in the first group
   eg Guides > Getting started. You will also notice here that it loads docs/README.md for a split second before switching to Getting started

Note Local builds work fine.

Scrub product and zendesk articles and links for validity.

Add feedback information as a separate topic. Must include:

• GitHub link
• Support link

https://github.com/hayorov/quorum-in-minutes-showcase/

Try building and running a CorDapp for docs tutorial

Description

• We are going to start protecting Ethereum APIs with credentials: https://github.com/chainstack/orchestrator/issues/222
• Previously one could connect to Ethereum node with just a hostname
• Docs should be reviewed and the change should be accommodated

Trying to find the best structure and a unified experience for all docs sections.

I must template all how-to/operations sections and unify them under the template.

Examples:

• The steps are unformatted numbered lists https://docs.dev.chainstack.com/operations/multichain/external-key-management
• The steps are unnumbered H3 https://docs.dev.chainstack.com/tutorials/decentralized-reputation-on-multichain

Considerations:

• Unformatted numbered steps do not expand when clicking the section, which is probably a good experience
• Numbered lists can be linked to but they expand when H2, which may not be a good experience

Need to think, discuss, template, and then brush up.

Icebox for now

Review the docs at master for linting & consistency.

Do instructions on how to make Quorum Geth from the latest release and put in Operations.

multichain hybrid installation

https://github.com/syahrul12345/challenge/blob/master/_posts/2019-06-02-ropsen.markdown

Icebox for now