Fix links and start changes to Snippet component

Signed-off-by: Chris Chinchilla <[email protected]>

Author: Chris Chinchilla

code_examples/sdk_examples/src/workshop/index.ts

@@ -5,35 +5,25 @@
  * found in the LICENSE file in the root directory of this source tree.
  */
 
-import type {
-  KiltAddress,
-  SignerInterface,
-  KeyringPair,
-  MultibaseKeyPair,
-  TransactionSigner,
-  ICType
-} from '@kiltprotocol/types'
-import { Keyring } from '@polkadot/keyring'
-import { BN } from '@polkadot/util'
 import * as Kilt from '@kiltprotocol/sdk-js'
-import { Multikey } from '@kiltprotocol/utils'
-import { Blockchain, BalanceUtils } from '@kiltprotocol/chain-helpers'
 import { CType } from '@kiltprotocol/credentials'
 // TODO: Look into tidier way with PD Keyring…
 import { getFunds } from '../getFunds'
-// import { releaseWeb3Name } from '../core_features/web3names/04_release'
 
 export function generateAccounts() {
   const issuerAccount = Kilt.generateKeypair({ type: 'ed25519' })
   const submitterAccount = Kilt.generateKeypair({ type: 'ed25519' })
   const holderAccount = Kilt.generateKeypair({ type: 'ed25519' })
+  const verifierAccount = Kilt.generateKeypair({ type: 'ed25519' })
 
   console.log('keypair generation complete')
-  console.log(`ISSUER_ACCOUNT_ADDRESS=${issuerAccount}`)
-  console.log(`SUBMITTER_ACCOUNT_ADDRESS=${submitterAccount}`)
-  console.log(`HOLDER_ACCOUNT_ADDRESS=${holderAccount}`)
+  console.log(`ISSUER_ACCOUNT_ADDRESS=${issuerAccount.publicKeyMultibase}`)
+  console.log(
+    `SUBMITTER_ACCOUNT_ADDRESS=${submitterAccount.publicKeyMultibase}`
+  )
+  console.log(`HOLDER_ACCOUNT_ADDRESS=${holderAccount.publicKeyMultibase}`)
 
-  return { issuerAccount, submitterAccount, holderAccount }
+  return { issuerAccount, submitterAccount, holderAccount, verifierAccount }
 }
 
 export async function generateIssuerDid(
@@ -56,7 +46,7 @@ export async function generateIssuerDid(
   }
 
   let { didDocument, signers } = didDocumentTransactionResult.asConfirmed
-  console.log(`ISSUER_DID_URI=${didDocument}`)
+  console.log(`ISSUER_DID_URI=${didDocument.id}`)
   // TODO: Don't need to pass signers? but explain that it's more flexible in real use
   return { didDocument, signers }
 }
@@ -82,12 +72,11 @@ export async function generateHolderDid(
   }
 
   let { didDocument, signers } = didDocumentTransactionResult.asConfirmed
-  console.log(`HOLDER_DID_URI=${didDocument}`)
+  console.log(`HOLDER_DID_URI=${didDocument.id}`)
   // TODO: Don't need to pass signers? but explain that it's more flexible in real use
   return { didDocument, signers }
 }
 
-
 export async function generateVerifierDid(
   submitterAccount,
   authenticationKeyPair
@@ -113,7 +102,6 @@ export async function generateVerifierDid(
   return { didDocument, signers }
 }
 
-
 export async function verifyDid(submitterAccount, didDocument, signers) {
   // TODO: DID verify step currently. What step?
   // ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
@@ -154,20 +142,16 @@ export async function verifyDid(submitterAccount, didDocument, signers) {
   console.log('assertion method added')
   return { didDocument, signers }
 }
-//Issuer
-// add into tutorial. Actually does it make sense?
+// TODO: Add into tutorial. Actually does it make sense?
 export async function claimWeb3Name(submitterAccount, didDocument, signers) {
-  // ┏━━━━━━━━━━━━━━━━━┓
-  // ┃ Claim web3name  ┃
-  // ┗━━━━━━━━━━━━━━━━━┛
   const api = Kilt.ConfigService.get('api')
 
   const claimW3nTransactionResult = await Kilt.DidHelpers.claimWeb3Name({
     api,
     didDocument,
     submitter: submitterAccount,
     signers,
-    name: 'testtest7865348'
+    name: 'testtest7865348999'
   }).submit()
 
   if (claimW3nTransactionResult.status !== 'confirmed') {
@@ -181,24 +165,24 @@ export async function claimWeb3Name(submitterAccount, didDocument, signers) {
 }
 
 // Issuer
-export async function issueCredential(didDocument, signers, submitterAccount) {
+export async function issueCredential(issuerDid, holderDid, signers, submitterAccount) {
   const passportCType = await CType.fetchFromChain(
     'kilt:ctype:0x5f6634bc0edf08ced5fc7a7bec24a2019228570b912703c834955e0d00f69bf4'
   )
 
   const passportCredential = await Kilt.Issuer.createCredential({
-    issuer: didDocument.id,
+    issuer: issuerDid.id,
     credentialSubject: {
-      id: didDocument.id,
-      age: 22,
+      id: holderDid.id,
+      age: 22
     },
     cType: passportCType.cType
   })
 
   const credential = await Kilt.Issuer.issue({
     credential: passportCredential,
     issuer: {
-      didDocument,
+      didDocument: issuerDid,
       signers: [...signers, submitterAccount],
       submitter: submitterAccount
     }
@@ -209,20 +193,11 @@ export async function issueCredential(didDocument, signers, submitterAccount) {
 }
 
 export async function createPresentation(credential, didDocument, signers) {
-  // ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-  // ┃ Create a Presentation        ┃
-  // ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
-  //
-  // Create a derived credential (a copy) that only contains selected properties (selective disclosure), then create a credential presentation for it.
-  // The presentation includes a proof of ownership and is scoped to a verified and time frame to prevent unauthorized re-use.
-  // Not on chain
-  // TODO: Why DID then? Because credential is attactached to a DID
   const derived = await Kilt.Holder.deriveProof({
     credential,
-    // Change
     proofOptions: { includeClaims: ['/credentialSubject/age'] }
   })
-  
+
   const presentation = await Kilt.Holder.createPresentation({
     credentials: [derived],
     holder: {
@@ -261,17 +236,7 @@ export async function removeVerificationMethod(
   submitterAccount,
   signers
 ) {
-  // More for internal tests, not part of workshop, links
   // TODO: Need more now to tear down all created assets
-  // ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-  // ┃ Remove a Verification Method ┃
-  // ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
-  //
-  // Removing a verification method can be done by specifying its id.
-  //
-  // Note:
-  // - The provided `didDocument` must include the specified verification method.
-  // - The authentication verification method can not be removed.
   const api = Kilt.ConfigService.get('api')
 
   const removeVmTransactionResult =
@@ -294,11 +259,6 @@ export async function removeVerificationMethod(
 }
 
 export async function releaseWeb3Name(didDocument, submitterAccount, signers) {
-  // ┏━━━━━━━━━━━━━━━━━━┓
-  // ┃ Release web3name ┃
-  // ┗━━━━━━━━━━━━━━━━━━┛
-  //
-  // A web3name can be released from a DID and potentially claimed by another DID.
   const api = Kilt.ConfigService.get('api')
 
   const releaseW3nTransactionResult = await Kilt.DidHelpers.releaseWeb3Name({
@@ -317,11 +277,6 @@ export async function releaseWeb3Name(didDocument, submitterAccount, signers) {
 }
 
 export async function removeService(didDocument, submitterAccount, signers) {
-  // ┏━━━━━━━━━━━━━━━━━━┓
-  // ┃ Remove a service ┃
-  // ┗━━━━━━━━━━━━━━━━━━┛
-  //
-  // Services can be removed by specifying the service `id`
   const api = Kilt.ConfigService.get('api')
 
   const removeServiceTransactionResult = await Kilt.DidHelpers.removeService({
@@ -341,12 +296,6 @@ export async function removeService(didDocument, submitterAccount, signers) {
 }
 
 export async function deactivateDid(didDocument, submitterAccount, signers) {
-  // ┏━━━━━━━━━━━━━━━━━━┓
-  // ┃ Deactivate a DID ┃
-  // ┗━━━━━━━━━━━━━━━━━━┛
-  //
-  // _Permanently_ deactivate the DID, removing all verification methods and services from its document.
-  // Deactivating a DID cannot be undone, once a DID has been deactivated, all operations on it (including attempts at re-creation) are permanently disabled.
   const api = Kilt.ConfigService.get('api')
 
   const deactivateDidTransactionResult = await Kilt.DidHelpers.deactivateDid({
@@ -369,7 +318,6 @@ export async function deactivateDid(didDocument, submitterAccount, signers) {
 }
 
 export async function runAll() {
-  // Setup code
   const api = await Kilt.connect(
     process.env.WSS_ADDRESS || 'wss://peregrine.kilt.io'
   )
@@ -380,20 +328,12 @@ export async function runAll() {
     seed: '0xe566550fec3ca23d80dfe9e9529ada463b93fc33f17219c1089de906f7253f1c'
   })
 
-  const { issuerAccount, submitterAccount, holderAccount } = generateAccounts()
-const verifierAccount = generateAccounts()
-
-  // ┏━━━━━━━━━━━━┓
-  // ┃ Get funds  ┃
-  // ┗━━━━━━━━━━━━┛
-  //
-
-  await getFunds(faucetAccount, submitterAccount, 5)
+  const { issuerAccount, submitterAccount, holderAccount, verifierAccount } = generateAccounts()
+  
+  await getFunds(faucetAccount, submitterAccount, 10)
   console.log('Successfully transferred tokens')
   let issuerDid = await generateIssuerDid(submitterAccount, issuerAccount)
-
   let holderDid = await generateHolderDid(submitterAccount, holderAccount)
-
   let verifierDid = await generateVerifierDid(submitterAccount, verifierAccount)
 
   issuerDid = await verifyDid(
@@ -403,11 +343,12 @@ const verifierAccount = generateAccounts()
   )
   issuerDid = await claimWeb3Name(
     submitterAccount,
-    issuerDid,
+    issuerDid.didDocument,
     issuerDid.signers
   )
   const credential = await issueCredential(
     issuerDid.didDocument,
+    holderDid.didDocument,
     issuerDid.signers,
     submitterAccount
   )
@@ -444,7 +385,6 @@ const verifierAccount = generateAccounts()
     holderDid.signers
   )
 
-  // Release the connection to the blockchain.
   await api.disconnect()
 
   console.log('disconnected')

code_examples/sdk_examples/tsconfig.json

@@ -6,6 +6,9 @@
     "target": "ES2020"
   },
   "exclude": [
-    "src/test.ts"
+    "src/test.ts",
+    "src/core_features",
+    "src/dapp",
+    "src/staking"
   ]
 }

develop/02_chain/04_fullnode.md

@@ -41,7 +41,7 @@ This can either be `peregrine` or `spiritnet`.
 
 Hence, to start a full node for the Spiritnet network, the parameter would be `--chain=spiritnet`.
 Unfortunately, there is no hardcoded chain spec for the Peregrine network, so the full path of the chainspec file must be provided `--chain=/node/dev-specs/kilt-parachain/peregrine-kilt.json`.
-Please refer to the [KILT node repository](https://github.com/KILTprotocol/kilt-node/blob/master/dev-specs/kilt-parachain/peregrine-kilt.json) or the [Docker image](https://hub.docker.com/r/kiltprotocol/kilt-node/tags) for more information.
+Please refer to the [KILT node repository](https://github.com/KILTprotocol/kilt-node/blob/master/chainspecs/peregrine/peregrine-paseo.json) or the [Docker image](https://hub.docker.com/r/kiltprotocol/kilt-node/tags) for more information.
 
 ### Specify the Blockchain Storage Path
 

docusaurus.config.js

@@ -54,11 +54,12 @@ module.exports = {
         srcDark: 'img/logo_dark.svg',
       },
       items: [
-        {
-          type: 'docsVersionDropdown',
-          position: 'right',
-          dropdownActiveClassDisabled: true,
-        },
+        // TODO: Not working right now…
+        // {
+        //   type: 'docsVersionDropdown',
+        //   position: 'right',
+        //   dropdownActiveClassDisabled: true,
+        // },
         {
           to: '/concepts/what-is-kilt',
           label: 'What is KILT?',

participate/01_staking/01_become_a_collator/03_setup_node.md

@@ -74,7 +74,7 @@ This can either be `peregrine` or `spiritnet`.
 
 Hence, to start a collator node for the Spiritnet network, the parameter would be `--chain=spiritnet`.
 Unfortunately, there is no hardcoded chain spec for the Peregrine network, so the full path of the chainspec file must be provided `--chain=/node/dev-specs/kilt-parachain/peregrine-kilt.json`.
-Please refer to the [KILT node repository](https://github.com/KILTprotocol/kilt-node/blob/master/dev-specs/kilt-parachain/peregrine-kilt.json) or the [Docker image](https://hub.docker.com/r/kiltprotocol/kilt-node/tags) for more information.
+Please refer to the [KILT node repository](https://github.com/KILTprotocol/kilt-node/blob/master/chainspecs/peregrine/peregrine-paseo.json) or the [Docker image](https://hub.docker.com/r/kiltprotocol/kilt-node/tags) for more information.
 
 ### Specify the Blockchain Storage Path
 

sdk/02_tutorial/03_overview.md

@@ -56,12 +56,6 @@ A presentation is derived from a credential and doesn't need to contain all attr
 After the request, the <span className="label-role holder">Holder</span> can choose to hide elements of their credentials that aren't relevant to the claim.
 For example, hide their address from their ID if the <span className="label-role issuer">Issuer</span> is only interested in their age.
 
-:::info
-
-A later step in the workshop [explains CTypes in more detail](./04_issuer/03_ctype.md).
-
-:::
-
 ```mermaid
 sequenceDiagram
 actor C as Holder

sdk/02_tutorial/04_accounts.md

@@ -7,8 +7,6 @@ import TsJsBlock from '@site/src/components/TsJsBlock';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-import GenerateAccount from '!!raw-loader!@site/code_examples/sdk_examples/src/workshop/index.ts';
-
 With the [project structure setup](./) in the last step, you can create your <span className="label-role issuer">Issuer</span> account.
 
 With KILT, an account is an object that interacts with the blockchain.