Update README #88

amarts · 2023-06-27T09:43:52Z

Description

Make sure README reflects what is in the project, and using README, one is able to complete a demo run. Also it should have links to documentation for further study.

Goals

Run through the README file and verify the if it is missing something

Expected Outcome

README file is accurate, anyone following it should not have any further questions, in setting up the dev environment and be able to run the demo script

Acceptance Criteria

Following the instructions on the README file, one should be able to set up the dev environment and be able to run the demo script

Implementation Details

NA

Mockups / Wireframes

NA

Product Name

CORD

Organization Name

Dhiway

Domain

Blockchain

Tech Skills Needed

Rust build tool chain

Mentor(s)

@amarts @NiranjanAP

Complexity

Low

Sub Category

Beginner friendly

StillAbeginnerr · 2023-12-13T16:00:05Z

I want to take up the issue, Assign me, please.

amarts · 2023-12-14T05:13:33Z

@StillAbeginnerr feel free to work on it and while submitting refer to this issue (#88).

StillAbeginnerr · 2023-12-15T17:09:19Z

Using Github Desktop, I cloned the repository and then first tried with the following.

npm install cord.network/sdk 
npm ERR! code 128
npm ERR! An unknown git error occurred
npm ERR! command git --no-replace-objects ls-remote ssh://[email protected]/cord.network/sdk.git
npm ERR! [email protected]: Permission denied (publickey).
npm ERR! fatal: Could not read from remote repository.
npm ERR!
npm ERR! Please make sure you have the correct access rights
npm ERR! and the repository exists.

Then The following to get the node modules installed

npm i
npm ERR! code EUNSUPPORTEDPROTOCOL
npm ERR! Unsupported URL Type "workspace:": workspace:*

npm ERR! A complete log of this run can be found in: C:\Users\Shiva\AppData\Local\npm-cache\_logs\2023-12-15T16_36_57_461Z-debug-0.log

This problem persists. I checked my possible ways to work with it via Chatgpt and Other Tools like Stackoverflow.
Need some tips regarding this issue.
@amarts

amarts · 2023-12-15T17:23:30Z

Did you miss the '@'... It's npm install @cord.network/sdk

adi-a11y · 2023-12-15T17:41:02Z

Using Github Desktop, I cloned the repository and then first tried with the following.
npm install cord.network/sdk 
npm ERR! code 128
npm ERR! An unknown git error occurred
npm ERR! command git --no-replace-objects ls-remote ssh://[email protected]/cord.network/sdk.git
npm ERR! [email protected]: Permission denied (publickey).
npm ERR! fatal: Could not read from remote repository.
npm ERR!
npm ERR! Please make sure you have the correct access rights
npm ERR! and the repository exists.
Then The following to get the node modules installed
npm i
npm ERR! code EUNSUPPORTEDPROTOCOL
npm ERR! Unsupported URL Type "workspace:": workspace:*

npm ERR! A complete log of this run can be found in: C:\Users\Shiva\AppData\Local\npm-cache\_logs\2023-12-15T16_36_57_461Z-debug-0.log
This problem persists. I checked my possible ways to work with it via Chatgpt and Other Tools like Stackoverflow. Need some tips regarding this issue. @amarts

@StillAbeginnerr, Can you please try using yarn instead of npm?

StillAbeginnerr · 2023-12-15T18:11:13Z

Did you miss the '@'... It's npm install @cord.network/sdk

It gives another error

PS C:\Users\Shiva\OneDrive\Pictures\cord.js> npm install @cord.network/sdk
At line:1 char:13
+ npm install @cord.network/sdk
+             ~~~~~
The splatting operator '@' cannot be used to reference variables in an expression. '@cord' can be used only as an argument to a command. To reference variables in 
an expression use '$cord'.
    + CategoryInfo          : ParserError: (:) [], ParentContainsErrorRecordException
    + FullyQualifiedErrorId : SplattingNotPermitted

StillAbeginnerr · 2023-12-15T18:13:16Z

Using Github Desktop, I cloned the repository and then first tried with the following.
npm install cord.network/sdk 
npm ERR! code 128
npm ERR! An unknown git error occurred
npm ERR! command git --no-replace-objects ls-remote ssh://[email protected]/cord.network/sdk.git
npm ERR! [email protected]: Permission denied (publickey).
npm ERR! fatal: Could not read from remote repository.
npm ERR!
npm ERR! Please make sure you have the correct access rights
npm ERR! and the repository exists.
Then The following to get the node modules installed
npm i
npm ERR! code EUNSUPPORTEDPROTOCOL
npm ERR! Unsupported URL Type "workspace:": workspace:*

npm ERR! A complete log of this run can be found in: C:\Users\Shiva\AppData\Local\npm-cache\_logs\2023-12-15T16_36_57_461Z-debug-0.log
This problem persists. I checked my possible ways to work with it via Chatgpt and Other Tools like Stackoverflow. Need some tips regarding this issue. @amarts
Can you please try using yarn instead of npm?

PS C:\Users\Shiva\OneDrive\Pictures\cord.js> yarn add @cord.network/sdk
At line:1 char:10
+ yarn add @cord.network/sdk
+          ~~~~~
The splatting operator '@' cannot be used to reference variables in an    
expression. '@cord' can be used only as an argument to a command. To      
reference variables in an expression use '$cord'.
    + CategoryInfo          : ParserError: (:) [], ParentContainsErrorRe  
   cordException
    + FullyQualifiedErrorId : SplattingNotPermitted

PS C:\Users\Shiva\OneDrive\Pictures\cord.js> yarn add cord.network/sdk 
Usage Error: The cord.network/sdk string didn't match the required format (package-name@range). Did you perhaps forget to explicitly reference the package name?

$ yarn add [--json] [-F,--fixed] [-E,--exact] [-T,--tilde] [-C,--caret] [-D,--dev] [-P,--peer] [-O,--optional] [--prefer-dev] [-i,--interactive] [--cached] [--mode #0] ...

StillAbeginnerr · 2023-12-19T08:30:38Z

@amarts

amarts · 2023-12-19T09:16:03Z

Wanting to understand what is that is being tried here.

There are 2 things:

Consume this SDK : this is where one needs to install @cord.network/sdk, this is never done on a github codebase, but on a machine where application is using the SDK (think inside a nodejs app, reactjs app, may be used on GNU/Linux CLI, or in docker.
Develop, and improve the SDK: This is a task for developers, once cloned, you would do npm install and npm run build. make changes to code, and run demo scripts, and make sure your changes work.

As a project we need to cover both in documentation. Ideally README should contain the section 1 part, so it can be used in npmjs package page while publishing. The developer part can be a separate page inside the docs/ which may or may not be having a link from README.

In github desktop, you don't need to handle 'npm install @cord.network/sdk, but can just manage the code, and yarn and yarn build`

StillAbeginnerr · 2023-12-19T09:42:53Z

okay sir, I understand.

what I did was,

Cloned the repository in my system.
Tried to install the node_modules using npm install
got an error regarding installation of node_modules.
tried npm i @cord.network/sdk.
again got an error.
tried npm i cord.network/sdk.
again got an error.
then tried chatgpt to work upon that but didn't work.
so pasted the issue and error here.

StillAbeginnerr · 2023-12-19T09:43:26Z

same error with yarn

StillAbeginnerr · 2023-12-24T12:11:00Z

Wanting to understand what is that is being tried here.

There are 2 things:

Consume this SDK : this is where one needs to install @cord.network/sdk, this is never done on a github codebase, but on a machine where application is using the SDK (think inside a nodejs app, reactjs app, may be used on GNU/Linux CLI, or in docker.

Develop, and improve the SDK: This is a task for developers, once cloned, you would do npm install and npm run build. make changes to code, and run demo scripts, and make sure your changes work.

As a project we need to cover both in documentation. Ideally README should contain the section 1 part, so it can be used in npmjs package page while publishing. The developer part can be a separate page inside the docs/ which may or may not be having a link from README.

In github desktop, you don't need to handle 'npm install @cord.network/sdk, but can just manage the code, and yarn and yarn build`

I managed to work successfully with the first pointer that is consuming the SDK but had received errors in running the demo script and the attached screenshot is here where i utilised the Experiment the SDK methods using the following commands.
yarn
yarn build
npx tsx demo/src/func-test.ts
npx tsx demo/src/network-score-test.ts

the error while I tried to run the demo script:

gitpod /workspace/cord.js (develop) $ npx tsx demo/src/func-test.ts
node:internal/modules/cjs/loader:1144
const err = new Error(message);
^

Error: Cannot find module './generateKeypairs'
Require stack:

/workspace/cord.js/demo/src/utils/generateDid.ts
/workspace/cord.js/demo/src/func-test.ts
at Module._resolveFilename (node:internal/modules/cjs/loader:1144:15)
at l.default._resolveFilename (/workspace/cord.js/node_modules/tsx/dist/cjs/index.cjs:1:1671)
at Module._load (node:internal/modules/cjs/loader:985:27)
at Module.require (node:internal/modules/cjs/loader:1235:19)
at require (node:internal/modules/helpers:176:18)
at (/workspace/cord.js/demo/src/utils/generateDid.ts:3:34)
at Object. (/workspace/cord.js/demo/src/utils/generateDid.ts:10:23)
at Module._compile (node:internal/modules/cjs/loader:1376:14)
at Object.j (/workspace/cord.js/node_modules/tsx/dist/cjs/index.cjs:1:1197)
at Module.load (node:internal/modules/cjs/loader:1207:32) {
code: 'MODULE_NOT_FOUND',
requireStack: [
'/workspace/cord.js/demo/src/utils/generateDid.ts',
'/workspace/cord.js/demo/src/func-test.ts'
]
}

Node.js v20.10.0

StillAbeginnerr · 2023-12-25T14:37:02Z

@adi-a11y sir could you please my issue?

amarts · 2023-12-25T17:09:39Z

@StillAbeginnerr try npm install @cord.network/[email protected], and then run the func-test

The issue of the generate is because of #157 . Also make sure you update to latest of develop branch.

StillAbeginnerr · 2023-12-30T21:55:40Z

I cloned the Latest develop branch and worked but the same issue persists, I thought that running npx tsx demo/src/func-test.ts would show me some demo but somehow I failed again.

I don't understand why it is not referring to utils/key module to get the required library as per issue 157

I looked in the code to see if I could find why the module is missing using issue #157.

StillAbeginnerr · 2024-01-03T06:11:32Z

@amarts @NiranjanAP

NiranjanAP · 2024-01-03T06:56:05Z

we'll take a look at this and get back

NiranjanAP · 2024-01-03T10:07:25Z

Pls make the changes as below, test and create a PR.

diff --git a/demo/src/utils/generateDid.ts b/demo/src/utils/generateDid.ts
index f23517b..ec37b89 100644
--- a/demo/src/utils/generateDid.ts
+++ b/demo/src/utils/generateDid.ts
@@ -1,6 +1,5 @@
 import * as Cord from '@cord.network/sdk'
 import { mnemonicGenerate } from '@polkadot/util-crypto'
-import { generateKeypairs } from './generateKeypairs'
 
 /**
  * It creates a DID on chain, and returns the mnemonic and DID document
@@ -21,7 +20,7 @@ export async function createDid(
     keyAgreement,
     assertionMethod,
     capabilityDelegation,
-  } = generateKeypairs(mnemonic)
+  } = Cord.Utils.Key.generateKeypairs(mnemonic)
   // Get tx that will create the DID on chain and DID-URI that can be used to resolve the DID Document.
   const didCreationTx = await Cord.Did.getStoreTx(
     {

NiranjanAP · 2024-01-03T10:19:21Z

@StillAbeginnerr
Along with the above changes to fix the generateKeyPair issue, we have also updated the readme to clarify the sdk installation flow.

StillAbeginnerr · 2024-01-07T12:04:00Z

@NiranjanAP
I have noted that and applied,
I am confused what is the result (It seems like the server is connected) I don't know if I need to run something else also, and or now just make a documentation on the whole process.

StillAbeginnerr · 2024-01-07T12:08:27Z

StillAbeginnerr · 2024-01-07T12:29:36Z

@NiranjanAP https://github.com/StillAbeginnerr/cord.js/blob/develop/README.md
this is my repository and I have made a few changes for the demo script run.

Do I need to include yarn install @cord.network/[email protected] because the latest didn't work on my system?

Npm didn't work for me, so should i include it in the readme or not?

NiranjanAP · 2024-01-07T12:39:40Z

Please run a CORD instance locally then run the demo script. Refer CORD repo Readme to run the CORD instance locally

…

On Sun, 7 Jan, 2024, 5:59 pm shivam agarwal, ***@***.***> wrote: @NiranjanAP <https://github.com/NiranjanAP> https://github.com/StillAbeginnerr/cord.js/blob/develop/README.md this is my repository and I have made a few changes for the demo script run. Do I need to include yarn install @***@***.*** because the latest didn't work on my system? Npm didn't work for me, so should i include it in the readme or not? — Reply to this email directly, view it on GitHub <#88 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA5JWEYTLRXJZDKJOITKJFDYNKILVAVCNFSM6AAAAAAZVKVSE2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQOBQGA2DMMBYGY> . You are receiving this because you were mentioned.Message ID: <dhiway/cord .***@***.***>

NiranjanAP · 2024-01-07T14:37:51Z

@NiranjanAP https://github.com/StillAbeginnerr/cord.js/blob/develop/README.md this is my repository and I have made a few changes for the demo script run.

Do I need to include yarn install @cord.network/[email protected] because the latest didn't work on my system?

Npm didn't work for me, so should i include it in the readme or not?

You install sdk only if you are writing a new app and want to consume the sdk, read the updated readme
For just running the demo script, you don't need to install the SDK

StillAbeginnerr · 2024-01-07T17:39:01Z

Okay i got it, thank you :)

NiranjanAP · 2024-01-08T09:45:55Z

Once you are able to run CORD instance and test the cordjs demo script. Please update the same in this README as a prerequisite and make a PR. It'll help others trying the same. @StillAbeginnerr

StillAbeginnerr · 2024-01-08T13:24:07Z

Once you are able to run CORD instance and test the cordjs demo script. Please update the same in this README as a prerequisite and make a PR. It'll help others trying the same. @StillAbeginnerr

I'm on it.

Vishalk91-4 · 2024-01-26T04:21:35Z

@NiranjanAP, could you just brief the steps to start

I mean running yarn, then yarn run build
after that I am facing w2s disconnected error for running npx tsx demo/src/func-test.ts

amarts · 2024-01-27T06:33:57Z

after that I am facing w2s disconnected error for running npx tsx demo/src/func-test.ts

for 'connecting', you would need CORD instance running. On your machine, you should be running a docker instance of cord, or compiled cord to run these scripts. Check the instructions to run cord project locally.

vilol-04 · 2024-01-27T10:48:42Z

Can I work on this issue?

StillAbeginnerr · 2024-02-01T14:21:27Z

I'll make a PR by tomorrow. most of the work is done. had health issues so couldn't work on it. please make me assigned to this issue.

Once you are able to run CORD instance and test the cordjs demo script. Please update the same in this README as a prerequisite and make a PR. It'll help others trying the same. @StillAbeginnerr

I'm on it.

NiranjanAP · 2024-02-02T10:12:16Z

@StillAbeginnerr since we don't track this regularly, it doesn't make sense to assign if it is not being dedicatedly worked upon. However, once the work is done, feel free to assign to yourself and raise a PR.

VishnuAmit · 2024-04-25T09:54:52Z

Hey @NiranjanAP . I would like to take this issue. Kindly assign it to me. Thanks

scyther · 2024-04-28T10:15:16Z

Hi , I beleive PR for this issue has been merged . Tried README.md and was able to run yarn demo-statement

Except .nvmrc didn't get the LTS version of Node ( As node LTS needs to be installed first ). A troubleshoot doc can be helpful mentioning to use nvm install lts/*

SGCODEX · 2024-10-04T20:08:30Z

Hi, Can this issue be assigned to me?

vatsa287 · 2024-10-18T17:53:23Z

#88 (comment)

OK by seeing above comment, the documentation needs to mention that CORD needs to be running to test/run the SDK.
We can point out the documentation of setting up of CORD as a redirect as part mandatory pre-requisite.

SGCODEX · 2024-10-19T15:42:49Z

Please assign this issue to me

amarts added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 27, 2023

NiranjanAP added the C4GT Community label Jul 26, 2023

vatsa287 assigned SGCODEX Oct 19, 2024

Update README #88

Update README #88

Comments

amarts commented Jun 27, 2023 • edited by NiranjanAP Loading

Description

Goals

Expected Outcome

Acceptance Criteria

Implementation Details

Mockups / Wireframes

Product Name

Organization Name

Domain

Tech Skills Needed

Mentor(s)

Complexity

Category

Sub Category

StillAbeginnerr commented Dec 13, 2023

amarts commented Dec 14, 2023

StillAbeginnerr commented Dec 15, 2023 • edited Loading

amarts commented Dec 15, 2023 • edited Loading

adi-a11y commented Dec 15, 2023 • edited Loading

StillAbeginnerr commented Dec 15, 2023

StillAbeginnerr commented Dec 15, 2023 • edited Loading

StillAbeginnerr commented Dec 19, 2023

amarts commented Dec 19, 2023

StillAbeginnerr commented Dec 19, 2023

StillAbeginnerr commented Dec 19, 2023

StillAbeginnerr commented Dec 24, 2023 • edited Loading

StillAbeginnerr commented Dec 25, 2023 • edited Loading

amarts commented Dec 25, 2023

StillAbeginnerr commented Dec 30, 2023 • edited Loading

StillAbeginnerr commented Jan 3, 2024

NiranjanAP commented Jan 3, 2024

NiranjanAP commented Jan 3, 2024

NiranjanAP commented Jan 3, 2024

StillAbeginnerr commented Jan 7, 2024 • edited Loading

StillAbeginnerr commented Jan 7, 2024

StillAbeginnerr commented Jan 7, 2024

NiranjanAP commented Jan 7, 2024 via email • edited Loading

NiranjanAP commented Jan 7, 2024

StillAbeginnerr commented Jan 7, 2024

NiranjanAP commented Jan 8, 2024

StillAbeginnerr commented Jan 8, 2024

Vishalk91-4 commented Jan 26, 2024

amarts commented Jan 27, 2024

vilol-04 commented Jan 27, 2024

StillAbeginnerr commented Feb 1, 2024 • edited Loading

NiranjanAP commented Feb 2, 2024

VishnuAmit commented Apr 25, 2024

scyther commented Apr 28, 2024

SGCODEX commented Oct 4, 2024

vatsa287 commented Oct 18, 2024

SGCODEX commented Oct 19, 2024

amarts commented Jun 27, 2023 •

edited by NiranjanAP

Loading

StillAbeginnerr commented Dec 15, 2023 •

edited

Loading

amarts commented Dec 15, 2023 •

edited

Loading

adi-a11y commented Dec 15, 2023 •

edited

Loading

StillAbeginnerr commented Dec 15, 2023 •

edited

Loading

StillAbeginnerr commented Dec 24, 2023 •

edited

Loading

StillAbeginnerr commented Dec 25, 2023 •

edited

Loading

StillAbeginnerr commented Dec 30, 2023 •

edited

Loading

StillAbeginnerr commented Jan 7, 2024 •

edited

Loading

NiranjanAP commented Jan 7, 2024 via email •

edited

Loading

StillAbeginnerr commented Feb 1, 2024 •

edited

Loading