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

[DMP 2024]: Create a core modules of cord.js sdk in Golang #1

Open
3 tasks
adi-a11y opened this issue Jun 19, 2024 · 6 comments
Open
3 tasks

[DMP 2024]: Create a core modules of cord.js sdk in Golang #1

adi-a11y opened this issue Jun 19, 2024 · 6 comments
Labels

Comments

@adi-a11y
Copy link
Collaborator

Description

cord.js is an SDK to connect to CORD. We have a requirement to write the same SDK in Golang.
As part of this we have to first create the core SDK modules that include the DID and Chainspace. Scope of this issue it to create an SDK in Golang along with any dependencies.

Goals

  • Basic framework of the SDK established, able to connect to CORD
  • Replication of all packages present currently in CORD.js ex: statement, asset, network-score etc.
  • Demo scripts for all implemented packages currently present in CORD.js, similar to statement demo-script -> https://github.com/dhiway/cord.js/blob/develop/demo/src/func-test.ts

Expected Outcome

We should have a functioning sdk written in Golang that connects to CORD and is able to make calls to CORD

Acceptance Criteria

Fully functioning SDK written in Golang with all the available methods/functions implemented
A working demo script similar to https://github.com/dhiway/cord.js/blob/develop/demo/src/func-test.ts
All the unit test cases implemented

Implementation Details

Refer cord.js repo for reference SDK written in typescript, this needs to be replicated in Golang
Refer to the documentation https://docs.cord.network/cordjs/integratecord/ for the detailed explanation on the working of demo script https://github.com/dhiway/cord.js/blob/develop/demo/src/func-test.ts
Note: There will be some dependency modules before these two modules can work

Mockups/Wireframes

NA

Product Name

cord sdk in Golang

Organisation Name

Dhiway

Domain

Open Source Library

Tech Skills Needed

Go, TypeScript

Mentors

@vatsa287 @adi-a11y @amarts @NiranjanAP

Category

Other

@kartikaysaxena
Copy link
Contributor

kartikaysaxena commented Jun 24, 2024

Weekly Learnings & Updates (To be filled by contributor)

Week 1

  • Learning 1 - I learned how to organise a package into multiple modules for the initializing the project, also while playing around I learnt how to publish a go package.
  • Learning 2 - I also learnt to implement basic connection between the Go SDK and the CORD network through gsrpc substrate package.
  • Learning 3 - Also learnt types play a very crucial role in building Go packages and sometimes we have to build some custom types which I am working on.

Week 2

  • Learning 1 - I learnt to create structs for CORD which were useful in creating the identifier module.
  • Learning 2 - Wrote some functions of the crypto_utils and other utils.

Week 3

  • Learning 1 - I learnt to create extrinsic transactions and to sign and submit them.
  • Learning 2 - I also learnt to create various aspects of the network module.

@vatsa287
Copy link
Member

vatsa287 commented Jul 23, 2024

Week 1 Goals:

  • Connection with CORD and basic structure

@vatsa287
Copy link
Member

vatsa287 commented Jul 23, 2024

Week 2 Goals:

  • Configuration and Network

@vatsa287
Copy link
Member

vatsa287 commented Jul 23, 2024

Week 3 Goals:

  • Identifier Module

@vatsa287
Copy link
Member

vatsa287 commented Jul 23, 2024

Week 4 Goals:

  • DID Module (Partially Completed)

@vatsa287
Copy link
Member

Week 5 Goals:

  • ChainSpace Module

  • Demo script to demonstrate the chain space module.

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

No branches or pull requests

3 participants