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

fix typos #7

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions hypersign-identity-network/developers/hid-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ The generation of Golang code is done by the script `scripts/protogenc.sh`. The

### DID Document

The [DID-Core](https://www.w3.org/TR/did-core/) W3C Specification has been followed to frame the structure of a DID Document. It's proto representation is mentioned in `proto/ssi/v1/did.proto`. The message `DidDocumentState` is stored on chain.
The [DID-Core](https://www.w3.org/TR/did-core/) W3C Specification has been followed to frame the structure of a DID Document. Its proto representation is mentioned in `proto/ssi/v1/did.proto`. The message `DidDocumentState` is stored on chain.

```
// proto/ssi/v1/did.proto
Expand Down Expand Up @@ -148,21 +148,21 @@ message Credential {

## `x/ssi` Module

In Cosmos SDK, every operations related to blockchain such as staking, delegation, token trasfer, etc are handled by different modules. They are defined in the `x` directory of Cosmos SDK (See [here](https://github.com/cosmos/cosmos-sdk/tree/main/x)). For instance, `x/bank` module handles the functionality of token transfer. `x/ssi` module lets you store documents such as Decentralised Identifiers (DID), Schema Document and Verifiable credential Status on chain.
In Cosmos SDK, every operation related to blockchain such as staking, delegation, token trasfer, etc are handled by different modules. They are defined in the `x` directory of Cosmos SDK (See [here](https://github.com/cosmos/cosmos-sdk/tree/main/x)). For instance, `x/bank` module handles the functionality of token transfer. `x/ssi` module lets you store documents such as Decentralised Identifiers (DID), Schema Document and Verifiable credential Status on chain.

**Quick Overview**

`x/ssi/client/cli`: CLI Client for sending SSI-based transactions to and querying data from Blockchain.

`x/ssi/keeper`: Interaction with the state of blockchain

`x/ssi/genesis.go`: - Initialising and Exporting of genesis variables of `x/ssi` module, such as `chain_namespace`. - For public mainnet chain, `chain_namespace` should be empty. In case of testnet, the name of the testnet should be assigned. If you are running a private network, you can specify your own chain namepsace.
`x/ssi/genesis.go`: - Initialising and Exporting of genesis variables of `x/ssi` module, such as `chain_namespace`. - For public mainnet chain, `chain_namespace` should be empty. In case of testnet, the name of the testnet should be assigned. If you are running a private network, you can specify your own chain namespace.

`x/ssi/modules.go`: Defines the interface for `ssi` module

### Keeper

Keepers provides an abstraction to interact with the state of the blockchain. The store is a data structure which persists the state. The `Get` and `Set` methods of the store are handled by the Keeper. There are Keeper functions defined for each of the RPCs. Transaction-based RPCs share a similar workflow, while Query-based share different workflow similarity among themeselves.
Keepers provides an abstraction to interact with the state of the blockchain. The store is a data structure which persists the state. The `Get` and `Set` methods of the store are handled by the Keeper. There are Keeper functions defined for each of the RPCs. Transaction-based RPCs share a similar workflow, while Query-based share different workflow similarity among themselves.

**Transaction Based Keepers**

Expand Down Expand Up @@ -202,7 +202,7 @@ func (k msgServer) CreateDID(goCtx context.Context, msg *types.MsgCreateDID) (*t
didDocument <- get the DID Document from `msg` arg
signature <- get the signature information from `msg` arg

// Verfication of Document //
// Verification of Document //
err = ValidateDidDocumentElements(didDocument)
if err != nil {
return nil, err
Expand Down Expand Up @@ -572,7 +572,7 @@ The `50uhid` is deduced from the **Identity Provider** account

The cross-chain transfer of tokens between Cosmos-based chains is possible using Inter-Blockchain Communication (IBC) Protocol. Refer the IBC Documentation [here](https://ibc.cosmos.network/main/ibc/overview.html).

Run the following to transfer tokens between two accounts located on seperate chains
Run the following to transfer tokens between two accounts located on separate chains

```
hid-noded tx ibc-transfer transfer <source-ibc-port> <source-ibc-channel> <destination-chain-wallet-address> <amount> --from <source-chain-wallet-address>
Expand All @@ -590,11 +590,11 @@ This node stores the complete state of blockchain. However, it does not actively

#### Validator Node

It is a full node, which has a significant stake in the network and activately takes part in the validation process.
It is a full node, which has a significant stake in the network and actively takes part in the validation process.

#### Seed Node

It's purpose is to introduce newly connected nodes, to other nodes in the network, and disconnects after doing so.
Its purpose is to introduce newly connected nodes, to other nodes in the network, and disconnects after doing so.

In order to run in seed mode, set `pex = true` and `seed_mode = true` in `<hid-node config dir>/config/config.toml`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ description: A Javascript based SDK for DID Operations

Hypersign Decentralized Identifiers (Hypersign DID) comply [W3C DID specification](https://www.w3.org/TR/did-core/) and is built on top of [Hypersign Identity Blockchain Network](https://explorer.hypersign.id/hypersign-testnet). It implements [Hypersign DID scheme (`did:hid`)](https://docs.hypersign.id/self-sovereign-identity-ssi/decentralized-identifier-did).

Note: `did:hid` DID scheme is yet to be offcially registered on [W3C DID registry](https://www.w3.org/TR/did-spec-registries/).
Note: `did:hid` DID scheme is yet to be officially registered on [W3C DID registry](https://www.w3.org/TR/did-spec-registries/).

Read [decentralized-identifier-did](../../../core-concepts/decentralized-identifier-did/ "mention") section for more details.&#x20;

## Hypersign DID SDK

Is a javascript library for DID related operation (generate, sign, verify etc). It also provides APIs to store/update/retrive DID and DID Documents to/from the [Hypersign DID Registry](https://docs.hypersign.id/self-sovereign-identity-ssi/decentralized-identifier-did/did-registry) on the Hypersign Blockchain network easily.
Is a javascript library for DID related operation (generate, sign, verify etc). It also provides APIs to store/update/retrieve DID and DID Documents to/from the [Hypersign DID Registry](https://docs.hypersign.id/self-sovereign-identity-ssi/decentralized-identifier-did/did-registry) on the Hypersign Blockchain network easily.

## Table of Contents

Expand Down Expand Up @@ -51,7 +51,7 @@ import { HypersignDID } from 'hs-ssi-sdk';
```javascript
const hypersignDID = new HypersignDID();

// OR initialize by passing a namepace. Default 'testnet'
// OR initialize by passing a namespace. Default 'testnet'
// More complex way to initialize this class can be found in this documentation later
const namespace = 'testnet';
const hypersignDID = new HypersignDID({ namespace });
Expand Down Expand Up @@ -150,7 +150,7 @@ Sing a DID Document and generated proof
```javascript
sign(params: {
didDocument: object; // A DID Document to signed
privateKeyMultibase: string; // private key mulibase of type ED25519
privateKeyMultibase: string; // private key multibase of type ED25519
challenge: string; // Random challenge
domain: string; // Domain name
did: string; // DID, if passed then DID will be resolved and `didDocument` parameter will not be used
Expand Down Expand Up @@ -232,7 +232,7 @@ Verifies a signed DID Document.

```javascript
verify(params: {
didDocument: object; // Signed did documen
didDocument: object; // Signed did document
verificationMethodId: string; // The verification method
challenge: string; // Random challenge
domain?: string // The domain name
Expand Down Expand Up @@ -305,7 +305,7 @@ const hypersignDid = new HypersignDID({
namespace: 'testnet', // OPTIONAL namespace of did, Default ''
});

// OR Just initalize with offlineSigner
// OR Just initialize with offlineSigner
const hypersignDid = new HypersignDID({
offlineSigner
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ List all accounts.
mnemonic: ""
```

`node1` is the first account which has balance and be used as a sender of the the transaction.&#x20;
`node1` is the first account which has balance and be used as a sender of the transaction.&#x20;

### Send amount from one account to other

Create a new account called `my-account1`and lets send balance from account `node1` to `my-account1` and then finnally check balances.
Create a new account called `my-account1`and lets send balance from account `node1` to `my-account1` and then finally check balances.

```bash
hid-noded tx bank send <source-addr> <destination-addr> <amount> --keyring-backend test --chain-id hidnode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ mkdir -p <hid-node Config Directory>/cosmovisor/upgrades/<Proposal Name>/bin
cp <Update Binary Location> <Binary Config Directory>/cosmovisor/upgrades/<Proposal Name>/bin
```

* At the the proposed height, the upgrade would take place automatically.
* At the proposed height, the upgrade would take place automatically.