Skip to content

Commit

Permalink
Ln/deso (#118)
Browse files Browse the repository at this point in the history
* (bit)clout -> deso

* docs.deso.org

* update README and add assets

* clouthash to desohash

* rename bitclout math

* revert changes to extradata keys related to posts in constants.go

* Clout -> DeSo

* udpate README

* fix LICENSE
  • Loading branch information
lazynina authored Sep 21, 2021
1 parent 0c4a2d8 commit 2acd49e
Show file tree
Hide file tree
Showing 57 changed files with 3,851 additions and 3,821 deletions.
2 changes: 1 addition & 1 deletion CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# For now, tag everyone who wants to participate
* @bitclout/reviewers
* @deso-protocol/reviewers
8 changes: 4 additions & 4 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ FROM alpine:edge AS core
RUN apk update && apk upgrade
RUN apk add --update go=1.16.6-r0 gcc g++ vips vips-dev

WORKDIR /bitclout/src/core
WORKDIR /deso/src/core

COPY third_party third_party
COPY go.mod .
COPY go.sum .

RUN go mod download

COPY clouthash clouthash
COPY desohash desohash
COPY cmd cmd
COPY lib lib
COPY migrate migrate
Expand All @@ -26,6 +26,6 @@ FROM alpine:edge

RUN apk add --update vips-dev

COPY --from=core /bitclout/src/core/bin/core /bitclout/bin/core
COPY --from=core /deso/src/core/bin/core /deso/bin/core

ENTRYPOINT ["/bitclout/bin/core"]
ENTRYPOINT ["/deso/bin/core"]
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 BitClout Developer Community
Copyright (c) 2021 DeSo Community Developers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
60 changes: 30 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,44 @@
![BitClout Logo](https://bitclout.com/assets/img/camelcase_logo.svg)
![DeSo Logo](assets/camelcase_logo.svg)

# About BitClout
BitClout is a blockchain built from the ground up to support a fully-featured
# About DeSo
DeSo is a blockchain built from the ground up to support a fully-featured
social network. Its architecture is similar to Bitcoin, only it supports complex
social network data like profiles, posts, follows, creator coin transactions, and
more.

[Read about the vision](https://docs.bitclout.com/the-vision)
[Read about the vision](https://docs.deso.org/the-vision)

# About this Repo

This repo contains all of the consensus code for the BitClout protocol. While it can
This repo contains all of the consensus code for the DeSo protocol. While it can
technically be built and run as a stand-alone binary, it is mainly intended to be
"composed" into other projects that want to build on top of BitClout. We provide
"composed" into other projects that want to build on top of DeSo. We provide
multiple examples of how to do this in this README.

# Building on BitClout Core
# Building on DeSo Core

Below we provide a few real-world examples of how to compose BitClout core into your project.
Below we provide a few real-world examples of how to compose DeSo core into your project.

## Example 1: A BitClout Website (aka [bitclout.com](https://bitclout.com))
## Example 1: A Standard DeSo App (e.g. [bitclout.com](https://bitclout.com) or [flickapp.com](https://flickapp.com))

The code that powers [bitclout.com](https://bitclout.com) is fully open-source
The code that powers DeSo apps like [bitclout.com](https://bitclout.com) is fully open-source
such that anyone in the world can run it, and it consists of three repositories:
* **[github.com/bitclout/backend](https://github.com/bitclout/backend)**
* **[github.com/bitclout/frontend](https://github.com/bitclout/frontend)**
* **[github.com/bitclout/identity](https://github.com/bitclout/identity)**
* **[github.com/deso-protocol/backend](https://github.com/deso-protocol/backend)**
* **[github.com/deso-protocol/frontend](https://github.com/deso-protocol/frontend)**
* **[github.com/deso-protocol/identity](https://github.com/deso-protocol/identity)**

The repo that is most interesting for understanding the role of BitClout core is
[backend](https://github.com/bitclout/backend) because it effectively includes core
The repo that is most interesting for understanding the role of DeSo core is
[backend](https://github.com/deso-protocol/backend) because it effectively includes core
as a library and [uses its public API](https://FIXME)
to run a node. Then, it builds on core's basic
functionality to expose [a rich API](https://FIXME) of its own that can be used to
construct transactions, submit transactions to the network, manage user data, and
much more.

The backend repo's API is then utilized by
[frontend](https://github.com/bitclout/frontend) and
[identity](https://github.com/bitclout/identity), which are Angular apps that are
served as the frontend to [bitclout.com](https://bitclout.com).
[frontend](https://github.com/deso-protocol/frontend) and
[identity](https://github.com/deso-protocol/identity), which are Angular apps that are
served as the frontend to apps like [bitclout.com](https://bitclout.com).

## Example 2: A Rosetta API for Exchange Listing

Expand All @@ -48,18 +48,18 @@ Rosetta API makes it a breeze to integrate a coin because all of their infrastru
can plug into a standardized interface.

Because exchanges have a different set of needs than what's required to run a
BitClout web app, composing core allowed us
DeSo web app, composing core allowed us
to build a fully Dockerized Rosetta API that conforms perfectly to spec as its own
self-contained service. This allows exchanges to integrate BitClout without having
self-contained service. This allows exchanges to integrate DeSo without having
to run the unnecessary services associated with serving bitclout.com.

For more information on the BitClout Rosetta API, see our bitclout-rosetta repo here:
* **[https://github.com/bitclout/rosetta-bitclout](https://github.com/bitclout/rosetta-bitclout)**
For more information on the DeSo Rosetta API, see our deso-rosetta repo here:
* **[https://github.com/deso-protocol/rosetta-deso](https://github.com/deso-protocol/rosetta-deso)**

## Example 3: A MongoDB Data Dumper

Another example of composing the core repo is the BitClout MongoDB Dumper.
* **[github.com/bitclout/mongodb-dumper](https://github.com/bitclout/mongodb-dumper)**
Another example of composing the core repo is the DeSo MongoDB Dumper.
* **[github.com/deso-protocol/mongodb-dumper](https://github.com/deso-protocol/mongodb-dumper)**

This tool does the following:
* It includes core as a library
Expand All @@ -69,20 +69,20 @@ This tool does the following:
This gives users the ability to query all of the chain data using the MongoDB
commandline tool, or to layer a product like Retool on top of it.

# Running BitClout Core
# Running DeSo Core

Because core is intended to be composed into other projects, we suggest that
users who want to run it start by reading [the README in the backend repo](https://github.com/bitclout/backend)
users who want to run it start by reading [the README in the backend repo](https://github.com/deso-protocol/backend)
mentioned previously. This repo provides instructions on how set up a dev environment
for a full frontend and backend stack that can serve a full clone
of [bitclout.com](https://bitclout.com) with one's own custom feed.
of apps like [bitclout.com](https://bitclout.com) with one's own custom feed.

We also provide a [run repo](https://github.com/bitclout/run) that shows how to
We also provide a [run repo](https://github.com/deso-protocol/run) that shows how to
run this full stack in a fully Dockerized production environment.

# Acknowledgements

The architecture for BitClout was heavily-inspired by Bitcoin. We also owe a debt
The architecture for DeSo was heavily-inspired by Bitcoin. We also owe a debt
of gratitude to the developers of [btcd](https://github.com/btcsuite/btcd) for
producing a truly amazing Go Bitcoin client that served as a reference when
building BitClout.
building DeSo.
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Security Policy

BitClout encourages responsible vulnerability disclosure for security issues.
DeSo encourages responsible vulnerability disclosure for security issues.

Read the [Bug Bounty documentation](https://docs.bitclout.com/devs/bug-bounty) for more information.
Read the [Bug Bounty documentation](https://docs.deso.org/devs/bug-bounty) for more information.
30 changes: 30 additions & 0 deletions assets/camelcase_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 0 additions & 33 deletions clouthash/algorithm.go

This file was deleted.

8 changes: 4 additions & 4 deletions cmd/config.go
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
package cmd

import (
"github.com/bitclout/core/lib"
"github.com/deso-protocol/core/lib"
"github.com/golang/glog"
"github.com/spf13/viper"
"os"
)

type Config struct {
// Core
Params *lib.BitCloutParams
Params *lib.DeSoParams
ProtocolPort uint16
DataDirectory string
MempoolDumpDirectory string
Expand Down Expand Up @@ -62,9 +62,9 @@ func LoadConfig() *Config {
// Core
testnet := viper.GetBool("testnet")
if testnet {
config.Params = &lib.BitCloutTestnetParams
config.Params = &lib.DeSoTestnetParams
} else {
config.Params = &lib.BitCloutMainnetParams
config.Params = &lib.DeSoMainnetParams
}

config.ProtocolPort = uint16(viper.GetUint64("protocol-port"))
Expand Down
Loading

0 comments on commit 2acd49e

Please sign in to comment.