Skip to content

Commit

Permalink
Merge pull request #49 from canow-co/DDS-473-cheqd-node-dependency-up…
Browse files Browse the repository at this point in the history
…date

feat: [DDS-473] Updated canow-co/cheqd-node dependency
  • Loading branch information
spivachuk authored Oct 3, 2023
2 parents 9f36916 + 0571d56 commit d79e785
Show file tree
Hide file tree
Showing 30 changed files with 1,740 additions and 306 deletions.
1 change: 0 additions & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ jobs:
- uses: actions/setup-go@v3
with:
go-version-file: ./go.mod
cache: true

- name: Run golangci-lint
uses: golangci/golangci-lint-action@v3
Expand Down
38 changes: 14 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,10 @@
<div align="center">
<img src="docs/canow.svg" width="100" height="100" />

<hr height="0.5px" />

<br/>

<h1> Canow Ledger </h1>
<p> Self-Sovereign identity ledger based on Cosmos SDK framework. </p>

<br/>
</div>

### ℹ️ — Canow Ledger benefits

___
# Canow Ledger

Self-Sovereign identity ledger based on Cosmos SDK framework.

## ℹ️ — Canow Ledger benefits

---

Canow Ledger is a blockchain network for self-sovereign identity based on Cosmos SDK framework. It allows you:

Expand All @@ -25,24 +16,23 @@ Canow Ledger is a blockchain network for self-sovereign identity based on Cosmos
- Join Canow network as a validator or observer.
- Delegate `ARX` tokens to existing validator and receive a passive income.

### 🚧 — Testnet
## 🚧 — Testnet

___
---

Canow Testnet is a network where you can get Testnet ARX tokens to try Canow ledger and test your functionality without any real payments.

- [Setup Testnet node](docs/node-setup/validator-creation.md) to participate the network.
- [Big Dipper Explorer](https://explorer.testnet.canowchain.com) for the network monitoring.
- [Big Dipper Explorer](https://explorer.testnet.canowchain.com/desmos) for the network monitoring.
- [Omniflix instance](https://omniflix.testnet.canowchain.com) for tokens transferring, delegating and adding Canow wallet to Keplr.
- [Community chat]() for your questions to Canow Chain maintainers and other participants

### 🤝 — How to contribute
## 🤝 — How to contribute

___
---

We will be happy to see your contributions and work together! Thanks in advance!

- Development [environment](docs/dev-instructions/environment.md) secrets.
- How to [build and install](docs/dev-instructions/build-and-install.md) **canow-chain** application.
- How to [build and install](docs/dev-instructions/build-and-install.md) **canow-chain** application.
- How to set up [a local pool](docs/dev-instructions/setup-local-pool.md).
- [List of issues](https://github.com/canow-co/canow-chain/issues) for bug reports and feature suggestions.
- [List of issues](https://github.com/canow-co/canow-chain/issues) for bug reports and feature suggestions.
10 changes: 5 additions & 5 deletions docs/architecture/canow_did_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Each DID Document MUST have a metadata section when a representation is produced
2. **updated** (string): The value of the property MUST follow the same formatting rules as the created property. The updated field is null if an Update operation has never been performed on the DID document. If an updated property exists, it can be the same value as the created property when the difference between the two timestamps is less than one second.
3. **deactivated** (string): If DID has been deactivated, DID document metadata MUST include this property with the boolean value true. By default this is set to false.
4. **versionId** (string): Contains transaction hash of the current DIDDoc version.
5. **linkedResourceMetadata** (list of resources metadata referred to as [Resource previews](https://github.com/cheqd/node-docs/blob/main/architecture/adr-list/adr-008-ledger-resources.md)| *optional*). Cannot be changed by CreateDID or UpdateDID transactions. canow ledger stores only the resource identifiers in the DID Doc metadata. The remainder of the resources' metadata is added when a DID is resolved.
5. **linkedResourceMetadata** (list of resources metadata referred to as [Resource previews](https://docs.cheqd.io/identity/architecture/adr-list/adr-002-did-linked-resources)| *optional*). Cannot be changed by CreateDID or UpdateDID transactions. canow ledger stores only the resource identifiers in the DID Doc metadata. The remainder of the resources' metadata is added when a DID is resolved.

Example of DIDDoc metadata:

Expand Down Expand Up @@ -204,7 +204,7 @@ Example of DIDDoc metadata:

## DID Resources

It is associated with DID Document bytes data with specific Resource metadata. More details in [ADR 008: On-ledger Resources with DID URLs](https://github.com/cheqd/node-docs/blob/main/architecture/adr-list/adr-008-ledger-resources.md). DID Resource properties:
It is associated with DID Document bytes data with specific Resource metadata. More details in [ADR 008: On-ledger Resources with DID URLs](https://docs.cheqd.io/identity/architecture/adr-list/adr-002-did-linked-resources). DID Resource properties:

- **ResourceMetadata**
- **Resource Collection ID:** an identifier of a “parent” DID Document without `did:canow:testnet:` prefix;
Expand Down Expand Up @@ -305,7 +305,7 @@ For supporting CL Anoncreds, Schema and Credential definition(Cred_def) entities

### BBS+ signature

[BBS+ signature](https://w3c-ccg.github.io/ldp-bbs2020/) is an alternative to [CL signature](https://eprint.iacr.org/2012/562.pdf) in SSI world. It is a new modern flow that supports selective disclosure and hence can be used instead of CL Anoncreds in many cases.
[BBS+ signature](https://www.w3.org/TR/vc-di-bbs/) is an alternative to [CL signature](https://eprint.iacr.org/2012/562.pdf) in SSI world. It is a new modern flow that supports selective disclosure and hence can be used instead of CL Anoncreds in many cases.

BBS signature is stored in DID Doc [[spec](https://www.w3.org/TR/did-core/#core-properties)] as a [Verification method](#verification-method) (`publicKeyMultibase` or `publicKeyJwk`) in **[Assertion](https://www.w3.org/TR/did-core/#assertion)** section.

Expand Down Expand Up @@ -453,12 +453,12 @@ Using the idea of linked DIDs (trusted DID chain) does not exclude the possibili
- [DID Specification Registries](https://www.w3.org/TR/did-spec-registries/)
- [DIDComm Messaging v2.0](https://identity.foundation/didcomm-messaging/spec/v2.0/) specification
- [Verifiable Credentials Data Model](https://www.w3.org/TR/vc-data-model/) specification
- [BBS+ signature](https://w3c-ccg.github.io/ldp-bbs2020/) specification
- [BBS+ signature](https://www.w3.org/TR/vc-di-bbs/) specification
- [CL Anoncreds](https://hyperledger.github.io/anoncreds-spec/) specification
- [CL signatures](https://eprint.iacr.org/2012/562.pdf)
- [Revocation Entry](https://hyperledger.github.io/anoncreds-spec/#issuer-create-and-publish-revocation-registry-objects)
- [Revocation Status List](https://w3c-ccg.github.io/vc-status-rl-2020/)
- [DID Resources](https://github.com/cheqd/node-docs/blob/main/architecture/adr-list/adr-008-ledger-resources.md)
- [DID Resources](https://docs.cheqd.io/identity/architecture/adr-list/adr-002-did-linked-resources)
- [Tendermint](https://tendermint.com/)
- [Cosmos blockchain framework](https://cosmos.network/) official project website
- [cosmos-sdk](https://github.com/cosmos/cosmos-sdk) GitHub repository ([documentation](https://docs.cosmos.network/))
16 changes: 8 additions & 8 deletions docs/dev-instructions/build-and-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@ Setup Go according project [environment description](environment.md).

Pull repo from GitHub

```commandline
```bash
git clone https://github.com/canow-co/canow-chain.git
cd canow-chain
```

### Build the project
## Build the project

```commandline
```bash
make build
```

### Install binary
## Install binary

Move the binary to `/usr/bin/`
Move the binary to `/usr/bin/`

```commandline
```bash
mv build/canow-chain /usr/bin/
```

### Define permissions (optional)
## Define permissions (optional)

On this step we need to allow the binary execution if it is needed.

```commandline
```bash
sudo chmod +x /usr/bin/canow-chain
```
2 changes: 1 addition & 1 deletion docs/dev-instructions/environment.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Environment

Go 1.18
Go 1.18
12 changes: 6 additions & 6 deletions docs/dev-instructions/setup-local-pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

/docker/localnet/docker-compose.env

```
```bash
BUILD_IMAGE="canow-co/canow-chain:build-latest"
```

Launch a local pool

* 4 validators
* 1 seed
* 1 observer
- 4 validators
- 1 seed
- 1 observer

```
```bash
docker compose --env-file docker-compose.env up --force-recreate
```
```
4 changes: 3 additions & 1 deletion docs/interfaces/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Something interesting coming soon
# README

Something interesting coming soon
4 changes: 3 additions & 1 deletion docs/interfaces/canow-cli/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Something interesting coming soon
# README

Something interesting coming soon
4 changes: 3 additions & 1 deletion docs/interfaces/canow-cli/node-maintain.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Something interesting coming soon
# Node Maintain

Something interesting coming soon
4 changes: 3 additions & 1 deletion docs/interfaces/canow-cli/staking.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Something interesting coming soon
# Staking

Something interesting coming soon
4 changes: 3 additions & 1 deletion docs/interfaces/canow-cli/tokenomic.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Something interesting coming soon
# Tokenomic

Something interesting coming soon
4 changes: 3 additions & 1 deletion docs/interfaces/canow-cli/voting.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Something interesting coming soon
# Voting

Something interesting coming soon
4 changes: 3 additions & 1 deletion docs/interfaces/canow-cli/wallet.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Something interesting coming soon
# Wallet

Something interesting coming soon
4 changes: 3 additions & 1 deletion docs/interfaces/canow-rest-api.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Something interesting coming soon
# Canow REST API

Something interesting coming soon
4 changes: 3 additions & 1 deletion docs/interfaces/canow-rpc-grpc/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Something interesting coming soon
# README

Something interesting coming soon
4 changes: 3 additions & 1 deletion docs/interfaces/canow-rpc-grpc/identity.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Something interesting coming soon
# Identity

Something interesting coming soon
4 changes: 3 additions & 1 deletion docs/interfaces/canow-rpc-grpc/tokenomic.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Something interesting coming soon
# Tokenomic

Something interesting coming soon
34 changes: 18 additions & 16 deletions docs/node-setup/binary-installation.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,41 @@
# Binary Installation

Canow-chain binary can be downloaded from the repo [Releases on GitHub](https://github.com/canow-co/canow-chain/releases). The last stable and recommended release is marked by the label `latest`.
The binary can be used like a CLI for node requests, transactions building and sending.
The binary can be used like a CLI for node requests, transactions building and sending.

Besides `canow-chain` binary is complete application for launching Canow node.
Besides `canow-chain` binary is complete application for launching Canow node.

## Step 1. Download

### Step 1. Download
For installing `canow-chain` lets download and unpack it to `/usr/bin/` directory. If you are executing this command from the user without root permission, `sudo` will be needed for getting permissions for `/usr/bin/` directory.
Here is the command to install version 0.2.1. You can check which version is the latest now and download it [from the repository](https://github.com/canow-co/canow-chain/releases/latest).
Here is the command to install version 0.2.2. You can check which version is the latest now and download it [from the repository](https://github.com/canow-co/canow-chain/releases/latest).

#### For Linux
### For Linux

```commandline
sudo wget -c https://github.com/canow-co/canow-chain/releases/download/v0.2.1/canow-chain-v0.2.1-linux.tar.gz -O - | sudo tar -xz -C /usr/bin/
```bash
sudo wget -c https://github.com/canow-co/canow-chain/releases/download/v0.2.2/canow-chain-v0.2.2-linux.tar.gz -O - | sudo tar -xz -C /usr/bin/
```
#### For macOS

```commandline
sudo wget -c https://github.com/canow-co/canow-chain/releases/download/v0.2.1/canow-chain-v0.2.1-darwin.tar.gz -O - | sudo tar -xz -C /usr/bin/
### For macOS

```bash
sudo wget -c https://github.com/canow-co/canow-chain/releases/download/v0.2.2/canow-chain-v0.2.2-darwin.tar.gz -O - | sudo tar -xz -C /usr/bin/
```

### Step 2. Define permissions
## Step 2. Define permissions

After downloading and unpack Canow-chain binary it may have `-rw-r--r--` permissions. On this step we need to allow the binary execution.
After downloading and unpack Canow-chain binary it may have `-rw-r--r--` permissions. On this step we need to allow the binary execution.

```commandline
```bash
sudo chmod +x /usr/bin/canow-chain
```

### Step 3. Check
## Step 3. Check

For checking canow-chain installation success you can get a version of the installed binary:

```commandline
```bash
canow-chain version

> v0.2.1
> v0.2.2
```
Loading

0 comments on commit d79e785

Please sign in to comment.