From 193fd5e0bc5d8f5840e614f097975bc7ef19820d Mon Sep 17 00:00:00 2001 From: Chris Chinchilla Date: Tue, 2 Apr 2024 16:42:41 +0200 Subject: [PATCH 1/2] Change web3name Signed-off-by: Chris Chinchilla --- .../core_features/getting_started/03_fetch_did.ts | 10 +++++----- .../getting_started/04_fetch_endpoints.ts | 8 ++++---- .../getting_started/06_verify_credential.ts | 4 ++-- .../src/core_features/getting_started/index.ts | 12 ++++++------ .../src/core_features/web3names/index.ts | 6 +++--- docs/develop/01_sdk/01_quickstart.md | 12 ++++++------ 6 files changed, 26 insertions(+), 26 deletions(-) diff --git a/code_examples/sdk_examples/src/core_features/getting_started/03_fetch_did.ts b/code_examples/sdk_examples/src/core_features/getting_started/03_fetch_did.ts index 4e8dcea33..5741b09fd 100644 --- a/code_examples/sdk_examples/src/core_features/getting_started/03_fetch_did.ts +++ b/code_examples/sdk_examples/src/core_features/getting_started/03_fetch_did.ts @@ -3,14 +3,14 @@ import * as Kilt from '@kiltprotocol/sdk-js' export async function main(): Promise { let apiConfig = Kilt.ConfigService.get('api') - const encodedJohnDoeDetails = - await apiConfig.call.did.queryByWeb3Name('john_doe') + const encodedKiltnerd123Details = + await apiConfig.call.did.queryByWeb3Name('kiltnerd123') - // This function will throw if johnDoeOwner does not exist + // This function will throw if kiltnerd123 does not exist const { document: { uri } - } = Kilt.Did.linkedInfoFromChain(encodedJohnDoeDetails) - console.log(`My name is john_doe and this is my DID: "${uri}"`) + } = Kilt.Did.linkedInfoFromChain(encodedKiltnerd123Details) + console.log(`My name is kiltnerd123 and this is my DID: "${uri}"`) return uri } diff --git a/code_examples/sdk_examples/src/core_features/getting_started/04_fetch_endpoints.ts b/code_examples/sdk_examples/src/core_features/getting_started/04_fetch_endpoints.ts index 0aebcaa99..2d655defa 100644 --- a/code_examples/sdk_examples/src/core_features/getting_started/04_fetch_endpoints.ts +++ b/code_examples/sdk_examples/src/core_features/getting_started/04_fetch_endpoints.ts @@ -3,11 +3,11 @@ import * as Kilt from '@kiltprotocol/sdk-js' export async function main( uri: Kilt.DidUri ): Promise { - const johnDoeDidDocument = await Kilt.Did.resolve(uri) - console.log(`John Doe's DID Document:`) - console.log(JSON.stringify(johnDoeDidDocument, null, 2)) + const kiltnerd123DidDocument = await Kilt.Did.resolve(uri) + console.log(`kiltnerd123's DID Document:`) + console.log(JSON.stringify(kiltnerd123DidDocument, null, 2)) - const endpoints = johnDoeDidDocument?.document?.service + const endpoints = kiltnerd123DidDocument?.document?.service if (!endpoints) { console.log('No endpoints for the DID.') return [] diff --git a/code_examples/sdk_examples/src/core_features/getting_started/06_verify_credential.ts b/code_examples/sdk_examples/src/core_features/getting_started/06_verify_credential.ts index e8f8e74dd..096625c33 100644 --- a/code_examples/sdk_examples/src/core_features/getting_started/06_verify_credential.ts +++ b/code_examples/sdk_examples/src/core_features/getting_started/06_verify_credential.ts @@ -10,9 +10,9 @@ export async function main(credential: Kilt.ICredential): Promise { throw new Error('The credential has been revoked, hence it is not valid.') } console.log( - `John Doe's credential is valid and has been attested by ${attester}!` + `kiltnerd123's credential is valid and has been attested by ${attester}!` ) } catch { - console.log("John Doe's credential is not valid.") + console.log("kiltnerd123's credential is not valid.") } } diff --git a/code_examples/sdk_examples/src/core_features/getting_started/index.ts b/code_examples/sdk_examples/src/core_features/getting_started/index.ts index 87c1ec93b..e3b985cc7 100644 --- a/code_examples/sdk_examples/src/core_features/getting_started/index.ts +++ b/code_examples/sdk_examples/src/core_features/getting_started/index.ts @@ -4,16 +4,16 @@ import { main as connectToPeregrine } from './02_connect_spirit' import { main as connectToSpiritnet } from './02_connect_spirit' import { main as disconnect } from './07_disconnect' import { main as fetchEndpointData } from './05_fetch_endpoint_data' -import { main as fetchJohnDoeDid } from './03_fetch_did' -import { main as fetchJohnDoeEndpoints } from './04_fetch_endpoints' +import { main as fetchkiltnerd123Did } from './03_fetch_did' +import { main as fetchkiltnerd123Endpoints } from './04_fetch_endpoints' import { main as printHelloWorld } from './01_print_hello_world' import { main as verifyCredential } from './06_verify_credential' async function fetchDidAndCredential() { - const johnDoeDid = await fetchJohnDoeDid() - if (!johnDoeDid) - throw new Error('"john_doe" is not associated to any DID on Spiritnet') - const endpoints = await fetchJohnDoeEndpoints(johnDoeDid) + const kiltnerd123Did = await fetchkiltnerd123Did() + if (!kiltnerd123Did) + throw new Error('"kiltnerd123" is not associated to any DID on Spiritnet') + const endpoints = await fetchkiltnerd123Endpoints(kiltnerd123Did) if (!endpoints || !endpoints.length) throw new Error(`DID doesn't include services`) diff --git a/code_examples/sdk_examples/src/core_features/web3names/index.ts b/code_examples/sdk_examples/src/core_features/web3names/index.ts index 66764f2ef..1a49ae271 100644 --- a/code_examples/sdk_examples/src/core_features/web3names/index.ts +++ b/code_examples/sdk_examples/src/core_features/web3names/index.ts @@ -45,13 +45,13 @@ export async function runAll( throw new Error('web3name is registered for a wrong DID') } - console.log('3 w3n) Query credentials for "john_doe" web3name') + console.log('3 w3n) Query credentials for "kiltnerd123" web3name') try { - await queryPublishedCredentials('john_doe') + await queryPublishedCredentials('kiltnerd123') } catch (e) { if (e instanceof FetchError) { console.log( - 'Query credentials for "john_doe" web3name failed because of bad IPFS gateway. Ignoring this.' + 'Query credentials for "kiltnerd123" web3name failed because of bad IPFS gateway. Ignoring this.' ) } else { // This one should not have happened. diff --git a/docs/develop/01_sdk/01_quickstart.md b/docs/develop/01_sdk/01_quickstart.md index e1c043217..02bd1c8f5 100644 --- a/docs/develop/01_sdk/01_quickstart.md +++ b/docs/develop/01_sdk/01_quickstart.md @@ -160,7 +160,7 @@ The next step is to start querying data from the blockchain. ## Query a KILT Identity -The following code queries information related to a **web3name** (`john_doe`) and uses it to retrieve the **KILT DID** linked to it. +The following code queries information related to a **web3name** (`kiltnerd123`) and uses it to retrieve the **KILT DID** linked to it. Between the `Kilt.connect()` and `Kilt.disconnect()` lines, add the following code: @@ -173,18 +173,18 @@ dropTail="1" Try running the code and check the result. -Did you get the DID? You now have `john_doe`'s DID. -The next step is to see if `john_doe` has any publicly linked KILT credentials to retrieve and verify. +Did you get the DID? You now have `kiltnerd123`'s DID. +The next step is to see if `kiltnerd123` has any publicly linked KILT credentials to retrieve and verify. ## Retrieve and Verify a Credential A **KILT DID** can expose services that allow external resources to be linked to the DID. **KILT credentials** represent one type of external resource. -You can retrieve the **services** attached to John Doe's DID and see if they link to any public credentials to **query** and **verify**. +You can retrieve the **services** attached to kiltnerd123's DID and see if they link to any public credentials to **query** and **verify**. Add the following code after the code you added in the previous step but before the `await Kilt.disconnect()`. -It retrieves the services exposed by the DID found for `john_doe`: +It retrieves the services exposed by the DID found for `kiltnerd123`: -Run the code and wait to see if you can retrieve **and** verify one of John Doe's credentials! +Run the code and wait to see if you can retrieve **and** verify one of kiltnerd123's credentials! :::info Next steps From c804eaefda4fe895f9b523b73ed408712efd5778 Mon Sep 17 00:00:00 2001 From: Chris Chinchilla Date: Thu, 18 Apr 2024 13:38:34 +0200 Subject: [PATCH 2/2] Remove spiritnet Signed-off-by: Chris Chinchilla --- .../src/core_features/getting_started/index.ts | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/code_examples/sdk_examples/src/core_features/getting_started/index.ts b/code_examples/sdk_examples/src/core_features/getting_started/index.ts index e3b985cc7..f306b6d59 100644 --- a/code_examples/sdk_examples/src/core_features/getting_started/index.ts +++ b/code_examples/sdk_examples/src/core_features/getting_started/index.ts @@ -1,7 +1,6 @@ import * as Kilt from '@kiltprotocol/sdk-js' -import { main as connectToPeregrine } from './02_connect_spirit' -import { main as connectToSpiritnet } from './02_connect_spirit' +import { main as connectToPeregrine } from './02_connect_pere' import { main as disconnect } from './07_disconnect' import { main as fetchEndpointData } from './05_fetch_endpoint_data' import { main as fetchkiltnerd123Did } from './03_fetch_did' @@ -33,14 +32,6 @@ async function fetchDidAndCredential() { export async function runAll(): Promise { await printHelloWorld() - // check that the getting started works with both spiritnet and peregine - await connectToSpiritnet() - try { - await fetchDidAndCredential() - } finally { - await disconnect() - } - await connectToPeregrine() try { await fetchDidAndCredential()