Skip to content

Commit b98a64c

Browse files
Ed Mossgitbook-bot
Ed Moss
authored andcommitted
GITBOOK-196: change request with no subject merged in GitBook
1 parent 08ac9e2 commit b98a64c

19 files changed

+513
-32
lines changed
Loading

.gitbook/assets/Untitled (1).png

53 KB
Loading

.gitbook/assets/Untitled (2) (1).png

91.1 KB
Loading

.gitbook/assets/Untitled (2).png

75.2 KB
Loading

.gitbook/assets/Untitled (3).png

88.6 KB
Loading

.gitbook/assets/Untitled (4).png

50.6 KB
Loading

.gitbook/assets/Untitled.png

25.9 KB
Loading

SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Table of contents
22

33
* [🚀 DeSo Vision](README.md)
4+
* [⭐ DeSo Tutorial (Build Apps)](deso-tutorial-build-apps.md)
45
* [📅 DeSo Roadmap](deso-roadmap.md)
56
* [🛠 DeSo Tech Stack](deso-tech-stack.md)
67
* [🌐 DeSo Applications](deso-applications.md)

deso-backend/api/dao-endpoints.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ description: >-
66

77
# DeSo Tokens Endpoints
88

9-
<mark style="color:red;">Note: "DAO Coins" are now referred to as "</mark><mark style="color:red;">**DeSo Tokens**</mark><mark style="color:red;">" in all public-facing documentation, but the code and API have not yet been updated to reflect this change.</mark>\ <mark style="color:red;"></mark>\ <mark style="color:red;"></mark>\ <mark style="color:red;"></mark>For endpoints to check ownership of DeSo Tokens, see [#get-hodlers-for-public-key](social-endpoints.md#get-hodlers-for-public-key "mention") and [#is-hodling-public-key](social-endpoints.md#is-hodling-public-key "mention").
9+
<mark style="color:red;">Note: "DAO Coins" are now referred to as "</mark><mark style="color:red;">**DeSo Tokens**</mark><mark style="color:red;">" in all public-facing documentation, but the code and API have not yet been updated to reflect this change.</mark>\
10+
\
11+
\
12+
For endpoints to check ownership of DeSo Tokens, see [#get-hodlers-for-public-key](social-endpoints.md#get-hodlers-for-public-key "mention") and [#is-hodling-public-key](social-endpoints.md#is-hodling-public-key "mention").
1013

1114
{% swagger method="post" path="" baseUrl="/api/v0/get-dao-coin-limit-orders" summary="Gets All Open Orders on Order Book for a DeSo Token (DAO Coin) Market" %}
1215
{% swagger-description %}

deso-backend/configuration/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Compared to private, monopolized Web2 social media, all of the data on the DeSo
1212

1313
This means that **anybody can access this information and build their own application** using that data.&#x20;
1414

15-
However, blockchains require transactions and cryptography to validate information. ****&#x20;
15+
However, blockchains require transactions and cryptography to validate information.&#x20;
1616

1717
We know this can be a hassle, so we've built this API along with the [Broken link](broken-reference "mention") service to make it easy for you, the developer, to focus on what matters: building your application.&#x20;
1818

deso-backend/transaction-utilities.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Hex of transaction
8080
| TxOutputs | <p>Array of transaction outputs</p><p></p><p>[{ PublicKey: string, AmountNanos: integer }]</p> | <p>Attribute of transaction</p><p></p><p>Each element represents an output (DeSo being received) in the transaction</p> |
8181
| TxnMeta | Transaction Metadata object | <p>Attribute of transaction</p><p></p><p>Transaction Metadata descriptions coming soon. Each transaction type has its own transaction metadata object structure.</p> |
8282
| TxnHashHex | String | Hex of transaction hash broadcasted to the DeSo blockchain |
83-
| PostEntryResponse | ``[`PostEntryResponse`](broken-reference) | If a transaction is a submit post transaction, the `PostEntryResponse` that was created by the transaction is included |
83+
| PostEntryResponse | [`PostEntryResponse`](broken-reference) | If a transaction is a submit post transaction, the `PostEntryResponse` that was created by the transaction is included |
8484
{% endtab %}
8585
{% endtabs %}
8686
{% endswagger-response %}

deso-blockchain/consensus-pow-and-pos.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ The math below walks through DeSo scalability at each stage:
8686
* 1,811 tps vs Twitter with 6,000 posts per second and 300M users (assume only posts, no likes)\
8787

8888
* Users = 300M \* 1,811 / 6000 / 3 txns per post = **\~30M users.**\
89-
****
89+
9090
4. **Sharding**
9191
* All transactions can then be write-sharded to make syncing a node parallelizable, thus providing multiple orders of magnitude in speedup.\
9292
\

deso-blockchain/privacy-and-security.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Furthermore, if you own a large amount of DeSo it may be prudent to create two s
2727
## **What do I do i**f I lose my seed phrase?
2828

2929
Because your seed phrase is stored exclusively in your browser, it cannot be recovered by any third party. **If you lose your seed phrase, currently the only option is to create a new account, save the new seed phrase, and send all of your holdings to this new account.**\
30-
****\
31-
****You may need to liquidate your creator coin holdings into DeSo first. You can transfer a username by first changing the username on the old account and then quickly claiming the username with the new account.
30+
\
31+
You may need to liquidate your creator coin holdings into DeSo first. You can transfer a username by first changing the username on the old account and then quickly claiming the username with the new account.
3232

3333
We apologize for the inconvenience here. We know this process is not ideal, but we're working on alternative solutions, and hope to have an easier recovery path for users in the future.
3434

@@ -37,8 +37,8 @@ We apologize for the inconvenience here. We know this process is not ideal, but
3737
DeSo Identity, located at [identity.deso.org](https://identity.deso.org), safely stores your sensitive account information in your browser's local storage. To protect private key material the identity service has minimal dependencies, a strict content security policy, and is audited by multiple security firms.\
3838
\
3939
**For now, the developer community does not recommend entering your seed phrase anywhere other than identity.deso.org.**\
40-
****\
41-
****Always check the URL bar to verify you are using `identity.deso.org.`
40+
\
41+
Always check the URL bar to verify you are using `identity.deso.org.`
4242

4343
The DeSo Identity Service aims to make it easy for users to use a wide array of community projects safely and securely.\
4444
\

deso-exchange-listings/exchange-listing-api.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# 1⃣ Exchange Listing: API
22

33
The developer community recommends using the open-source Rosetta API implementation, currently used by Coinbase, for integrating DeSo on an exchange: [https://github.com/deso-protocol/rosetta-deso](https://github.com/deso-protocol/rosetta-deso).\
4-
****\
5-
****This being said, we provide an alternative set of APIs in this document that may be easier to use, and that the DeSo core team plans to support indefinitely.
4+
\
5+
This being said, we provide an alternative set of APIs in this document that may be easier to use, and that the DeSo core team plans to support indefinitely.
66

77
Now that anyone in the world can run a DeSo node, we thought we'd democratize and decentralize this effort by publishing a simple public API that any crypto exchange in the world could follow to integrate DeSo.
88

@@ -56,7 +56,7 @@ Note that the node software is cross-platform and should run on Linux, Mac, and
5656

5757

5858
_NOTE: You must set `READ_ONLY_MODE` to false in_ [_dev.env_](https://github.com/deso-protocol/run/blob/190a2380b278689a4db844bb52a31d0450db7d46/dev.env#L265) _in order for some API calls to work. However, at the time of this writing, it is not yet recommended to deploy a production node with `READ_ONLY_MODE` set to false. This should change shortly, though. Keep an eye on the_ [_README_](https://github.com/deso-protocol/run/tree/190a2380b278689a4db844bb52a31d0450db7d46) _for updates._\
59-
__
59+
6060

6161
### Check Node Sync Status
6262

@@ -92,7 +92,7 @@ curl --header "Content-Type: application/json" --request POST --data '{
9292
* Under the hood, every public/private key pair maps to derivation path m/44'/0'/0'/0/{index}. \
9393
\
9494
**Thus they would be identical to what is generated by any Bitcoin wallet using the same mnemonic, passphrase, and derivation path.**\
95-
****
95+
9696
* The public and private keys returned by this function will be encoded using base58 check encoding described in more detail in the [Full API Guide](exchange-listing-api.md#full-api-guide) section for this endpoint. For now, all that you need to know is that you can pass the public/private key strings to other API endpoints to check balances, spend DeSo, etc…\
9797

9898
* DeSo public keys that are encoded with base58 always start with the prefix “BC”. DeSo private keys that are encoded with base58 always start with the prefix “bc” (lower-case).\
@@ -114,7 +114,7 @@ curl --header "Content-Type: application/json" --request POST --data '{
114114
* We pipe the command into “python -m json.tool” so that it will “pretty print” but that you can delete this if you don’t have Python installed.
115115
116116
_**Note: This API is strictly for use by exchanges.** The DeSo nodes use a different API that never receives your seed phrase, and your seed phrase never leaves your browser. In contrast, exchanges are typically custodial and so some of these endpoints manipulate seeds on behalf of users._\
117-
__
117+
118118
119119
### Check Balance of DeSo Public Key
120120
@@ -148,7 +148,7 @@ curl --header "Content-Type: application/json" --request POST --data '{
148148
* You can buy DeSo on diamondapp.com and then use the "Send DeSo" page to get some DeSo for testing purposes.\
149149
150150
* The amount must be specified in "nanos," where 1 DeSo = 1e9 nanos. This example transfers 1 DeSo from public key `BC1YLgAJ2kZ7Q4fZp7KzK2Mzr9zyuYPaQ1evEWG4s968sChRBPKbSV1` to public key `BC1YLgU67opDhT9bTPsqvue9QmyJLDHRZrSj77cF3P4yYDndmad9Wmx`\
151-
``
151+
152152
* To do a "dry run" of the transaction without broadcasting it, simply add `DryRun: true` to the params.\
153153
154154
* Setting “AmountNanos” to a negative value like -1 will send the maximum amount possible.\

deso-identity/identity/mobile-integration.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ It also means that derived keys are extremely sensitive information and therefor
3434
1. Generate a derived key by making a call to [#derive](../window-api/#derive "mention") window API endpoint\
3535

3636
2. Construct a `AuthorizeDerivedKey` transaction via Backend API through `/api/v0/authorize-derived-key`\
37-
``
37+
3838
3. Sign the `AuthorizeDerivedKey` transaction with the derived key\
3939

4040
4. Submit signed `AuthorizeDerivedKey` transaction via `/api/v0/submit-transaction`\
41-
``
41+
4242
5. (Optional) Confirm that the derived key was successfully authorized through Backend API in `/api/v0/get-user-derived-keys`\
43-
``
43+
4444

4545
### Generate Derived Key
4646

@@ -90,9 +90,9 @@ Let’s take a look at these values:
9090
To check if a derived key is valid you should compare the current block height, e.g. taken from `/api/v0/get-app-state` Backend API endpoint, with the `expirationBlock` that you can find by querying the `/api/v0/get-user-derived-keys` Backend API endpoint.\
9191

9292
* `derivedJwt` is a JWT token with a month-long timeout signed by the `derivedPublicKeyBase58Check`\
93-
``
93+
9494
* `jwt` is a JWT token with a month-long timeout signed by the owner `publicKeyBase58Check`\
95-
``
95+
9696
* `network` is the network for which this derived key was generated\
9797

9898
* `messagingKeyName` is the key name used for v3 messaging\

deso-repos/architecture-overview/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ We use the following commit hashes to refer to the code:
8484

8585
* Choose a remote peer as a syncPeer in [`_startSync()`](https://github.com/deso-protocol/core/blob/135c03a/lib/server.go#L685). Call this the "remote peer."\
8686

87-
* Send the remote peer [`MsgDeSoGetHeaders` in `_startSync()`](https://github.com/deso-protocol/core/blob/135c03a/lib/server.go#L765)``\
88-
``
87+
* Send the remote peer [`MsgDeSoGetHeaders` in `_startSync()`](https://github.com/deso-protocol/core/blob/135c03a/lib/server.go#L765)\
88+
8989
* Remote peer replies to the `MsgDeSoGetHeaders` with a [`MsgDeSoHeaderBundle` in `_handleGetHeaders()`](https://github.com/deso-protocol/core/blob/135c03a/lib/server.go#L439).\
9090

9191
* Note that a "header locator" similar to Bitcoin is used to determine which headers are needed.\
@@ -145,10 +145,10 @@ We use the following commit hashes to refer to the code:
145145
* Note that we are currently working on increasing the nonce size to 64 bits up from 32 bits. This will result in ExtraNonce being basically deprecated, and will make `GetBlockTemplate()` much faster because it won't have to copy a block.\
146146

147147
* Once a block has been submitted via SubmitBlock, it is then relayed to other peers via the INV mechanism described previously. This happens as follows:
148-
* [`SubmitBlock()` in `miner.go`](https://github.com/deso-protocol/backend/blob/47bcc8af71b039f857bd949fcea94bfbed8b57e8/routes/miner.go#L125) calls [`ProcessBlock()`](https://github.com/deso-protocol/backend/blob/47bcc8af71b039f857bd949fcea94bfbed8b57e8/routes/miner.go#L177)``\
149-
``
150-
* `ProcessBlock()` notifies core's `server.go` that a block was connected by calling [`_handleBlockMainChainConnectedd()`](https://github.com/deso-protocol/core/blob/135c03a/lib/blockchain.go#L1854)``\
151-
``
148+
* [`SubmitBlock()` in `miner.go`](https://github.com/deso-protocol/backend/blob/47bcc8af71b039f857bd949fcea94bfbed8b57e8/routes/miner.go#L125) calls [`ProcessBlock()`](https://github.com/deso-protocol/backend/blob/47bcc8af71b039f857bd949fcea94bfbed8b57e8/routes/miner.go#L177)\
149+
150+
* `ProcessBlock()` notifies core's `server.go` that a block was connected by calling [`_handleBlockMainChainConnectedd()`](https://github.com/deso-protocol/core/blob/135c03a/lib/blockchain.go#L1854)\
151+
152152
* `_handleBlockMainChainConnectedd()` updates the mempool using [`UpdateAfterConnectBlock()`](https://github.com/deso-protocol/core/blob/135c03a/lib/server.go#L1078), which removes transactions from the mempool that have been mined into the block\
153153

154154
* `ProcessBlock()` notifies `server.go` again by [enqueing a `MsgDeSoBlockAccepted`](https://github.com/deso-protocol/core/blob/135c03a/lib/blockchain.go#L2135) message at the end, triggering a call to [`_handleBlockAccepted`](https://github.com/deso-protocol/core/blob/135c03a/lib/server.go#L1127).

deso-repos/architecture-overview/making-your-first-changes.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If your frontend repo is loaded into Goland, the following steps should allow yo
2222
* Look for the `GLOBAL_TAB` function in the file and modify the return statement as follows (you can name your feed whatever you want):\
2323

2424
* `static GLOBAL_TAB = "Satoshi's Feed";`\
25-
``
25+
2626
* Save your changes.
2727

2828
\
@@ -63,4 +63,3 @@ Now you should see some custom content in the post that you added to the feed. Y
6363
6464
##
6565
66-
****

deso-tech-stack.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ We strive on the following development principles:
2222
### **1) Easy for web2 developers to build.**
2323

2424
* **API-Driven & Permissionless**\
25-
****Everything that DeSo builds is API-driven from the start. We believe this makes it easier for Web2 developers to focus on creating world-class Web3 applications, using familiar programming languages like [Javascript](deso-frontend/exchange-listing-api.md) & Python. There's no need to learn smart-contract languages and write cost-prohibitive contracts.\
25+
Everything that DeSo builds is API-driven from the start. We believe this makes it easier for Web2 developers to focus on creating world-class Web3 applications, using familiar programming languages like [Javascript](deso-frontend/exchange-listing-api.md) & Python. There's no need to learn smart-contract languages and write cost-prohibitive contracts.\
2626
\
2727
Anyone in the world can also run their own DeSo node to curate and moderate their own feed. Read more: [feeds-and-moderation.md](deso-features/feeds-and-moderation.md "mention")\
2828

2929
* **Virtually Zero Gas Fees**\
30-
****On DeSo, you'll never expect to pay more than a fraction of a penny for thousands of on-chain transactions. The average fee per post is <$0.000017, in contrast to Ethereum where the average fee per post can cost >$50 depending on gas fees.\
30+
On DeSo, you'll never expect to pay more than a fraction of a penny for thousands of on-chain transactions. The average fee per post is <$0.000017, in contrast to Ethereum where the average fee per post can cost >$50 depending on gas fees.\
3131
\
3232
DeSo solves very complex storage & indexing problems to be able to handle decentralized social applications extremely efficiently. This is an advantage of DeSo being an "infinite-state" blockchain that's optimized for storage-heavy use cases. Read more: [infinite-state.md](deso-blockchain/infinite-state.md "mention")\
3333

@@ -47,7 +47,7 @@ We strive on the following development principles:
4747
### **2) Easy for mainstream users to onboard.**
4848

4949
* **Frictionless Usage & Onboarding**\
50-
****DeSo is a very user-experienced-driven project, as we believe the key to Web3 social is to make the user experience on par with the expectations of Web2 social.\
50+
DeSo is a very user-experienced-driven project, as we believe the key to Web3 social is to make the user experience on par with the expectations of Web2 social.\
5151
\
5252
This means unlike other blockchains, DeSo makes it very simple to sign up and try applications with an identity, wallet, and free "starter $DESO" to start engaging.\
5353
\
@@ -76,7 +76,7 @@ We strive on the following development principles:
7676
* All of your NFTs, Creator Coins, and DeSo Tokens are coupled with your Identity. See an example here: [https://signup.deso.com/wallet](https://signup.deso.com/wallet)\
7777

7878
* **Privacy & Safety**\
79-
****DeSo was built with ideas like Account Abstraction in mind from day one. \
79+
DeSo was built with ideas like Account Abstraction in mind from day one. \
8080
\
8181
We utilize "derived keys" and "spending limits" which makes it safer to give permissions to specific applications like posting, commenting, or following — without giving up your private keys.\
8282
\
@@ -87,7 +87,7 @@ We strive on the following development principles:
8787
### **3) Easy for creators to engage & monetize.**
8888

8989
* **Monetization & Social Features**\
90-
****A unique advantage for DeSo being its own layer-1 is that the blockchain combines social + money transactions very seamlessly.\
90+
A unique advantage for DeSo being its own layer-1 is that the blockchain combines social + money transactions very seamlessly.\
9191
\
9292
This allows DeSo offers multiple methods of on-chain monetization and social features for developers to build on, like the following:\
9393

0 commit comments

Comments
 (0)