Compare commits
22
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
32f64d704d | ||
|
|
0a51e2f652 | ||
|
|
b260fc0624 | ||
|
|
7b11a03e02 | ||
|
|
7963e5bdd4 | ||
|
|
6ad1f91862 | ||
|
|
167587081f | ||
|
|
47da88fe2a | ||
|
|
fed52c65da | ||
|
|
0ec0dea55d | ||
|
|
dac8511d1f | ||
|
|
362c14c83c | ||
|
|
053aad7833 | ||
|
|
026bb01b81 | ||
|
|
e020eb3c13 | ||
|
|
1be0995bbf | ||
|
|
d8b37ed0e6 | ||
|
|
1b56526711 | ||
|
|
707f616224 | ||
|
|
5277050c37 | ||
|
|
698222cf32 | ||
|
|
1c0888e0cf |
No files matched your search
@@ -25,7 +25,6 @@
|
||||
|
||||
|
||||
## Prerequisites
|
||||
- [lbry/web-daemon](https://github.com/lbryio/web-daemon)
|
||||
- [Node](https://nodejs.org) (version >= 10)
|
||||
|
||||
## Notes
|
||||
|
||||
@@ -22,8 +22,7 @@ export default () => `
|
||||
|
||||
<div>
|
||||
<span><a href="https://github.com/lbryio/lbrycrd">lbrycrd</a></span>
|
||||
<span><a href="https://github.com/lbryio/torba">torba</a></span>
|
||||
<span><a href="https://github.com/lbryio/lbryumx">lbryumx</a></span>
|
||||
<span><a href="https://github.com/lbryio/lbry-sdk">SDK</a></span>
|
||||
</div>
|
||||
</h2>
|
||||
|
||||
|
||||
@@ -27,11 +27,11 @@ export default pagePath => {
|
||||
break;
|
||||
|
||||
case "/api/blockchain":
|
||||
githubUrl = "https://github.com/lbryio/lbrycrd/blob/add_api_docs_scripts/contrib/devtools/generated/api_v1.json";
|
||||
githubUrl = "https://github.com/lbryio/lbrycrd/blob/master/contrib/devtools/generated/api_v1.json";
|
||||
break;
|
||||
|
||||
case "/api/sdk":
|
||||
githubUrl = "https://github.com/lbryio/lbry-sdk/blob/master/lbry/docs/api.json";
|
||||
githubUrl = "https://github.com/lbryio/lbry-sdk/blob/master/docs/api.json";
|
||||
break;
|
||||
|
||||
default:
|
||||
|
||||
@@ -16,7 +16,7 @@ let resolve = function(urls) {
|
||||
return new Promise(function(resolve, reject) {
|
||||
let options = {
|
||||
method: "POST",
|
||||
url: "https://api.lbry.tv/api/proxy",
|
||||
url: "https://api.lbry.tv/api/v1/proxy",
|
||||
headers:
|
||||
{
|
||||
"Content-Type": "application/json"
|
||||
@@ -54,7 +54,7 @@ let getTrending = function() {
|
||||
return new Promise(function(resolve, reject) {
|
||||
let options = {
|
||||
method: "POST",
|
||||
url: "https://api.lbry.tv/api/proxy",
|
||||
url: "https://api.lbry.tv/api/v1/proxy",
|
||||
headers:
|
||||
{
|
||||
"Content-Type": "application/json"
|
||||
@@ -107,6 +107,7 @@ let getTrending = function() {
|
||||
} else
|
||||
return resolve(daemonResponse.result.items);
|
||||
|
||||
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
+3
-15
@@ -17,12 +17,9 @@ import redirects from "~data/redirects.json";
|
||||
|
||||
const cache = new Map();
|
||||
const filePathBlockchain = "/contrib/devtools/generated/api_v1.json";
|
||||
const filePathSdk = "/lbry/docs/api.json";
|
||||
const filePathSdk = "/docs/api.json";
|
||||
const rawGitHubBase = "https://raw.githubusercontent.com/lbryio/";
|
||||
|
||||
if (!process.env.GITHUB_OAUTH_TOKEN) // No point in rendering this page
|
||||
throw new Error("Missing GitHub token");
|
||||
|
||||
const octokit = new Octokit({
|
||||
auth: `token ${process.env.GITHUB_OAUTH_TOKEN}`
|
||||
});
|
||||
@@ -246,7 +243,7 @@ async function getTags(repositoryName) {
|
||||
repo: repositoryName
|
||||
});
|
||||
|
||||
const tags = [];
|
||||
const tags = ["master"];
|
||||
|
||||
// NOTE:
|
||||
// The versioning in our repos do not make sense so extra
|
||||
@@ -257,16 +254,7 @@ async function getTags(repositoryName) {
|
||||
switch(true) {
|
||||
case repositoryName === "lbry-sdk":
|
||||
data.forEach(tag => {
|
||||
if (
|
||||
tag.name >= "v0.38.0" &&
|
||||
tag.name !== "v0.38.0rc7" &&
|
||||
tag.name !== "v0.38.0rc6" &&
|
||||
tag.name !== "v0.38.0rc5" &&
|
||||
tag.name !== "v0.38.0rc4" &&
|
||||
tag.name !== "v0.38.0rc3" &&
|
||||
tag.name !== "v0.38.0rc2" &&
|
||||
tag.name !== "v0.38.0rc1"
|
||||
) tags.push(tag.name);
|
||||
if (tag.name >= "v0.52.0") tags.push(tag.name);
|
||||
});
|
||||
break;
|
||||
|
||||
|
||||
+1
-1
@@ -83,7 +83,7 @@ export default () => html`
|
||||
<section class="community">
|
||||
<div class="inner-wrap">
|
||||
<h3>Community</h3>
|
||||
<p>There's literally <a href="https://spee.ch/@lbrytech/dozens.mp4">12<sup>n</sup></a> of us.</p>
|
||||
<p>There's literally <a href="https://lbry.tv/@lbrytech:1/dozens:e">12n</a> of us.</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="//chat.lbry.com" title="LBRY on Discord">Chat</a></li>
|
||||
|
||||
+4
-4
@@ -5,7 +5,7 @@ description: Learn how to build your own app via LBRY in this comprehensive guid
|
||||
|
||||
## Introduction
|
||||
|
||||
Want to build something on top of LBRY? This is the place to get started. If this is your first introduction to LBRY, you should read the [Overview](/overview) first. If you would rather build with us, check out our [Contributing Guide](/contribute).
|
||||
Want to build something on top of LBRY? This is the place to get started. If this is your first introduction to LBRY, you should read the [Overview](./overview.md) first. If you would rather build with us, check out our [Contributing Guide](./contribute.md).
|
||||
|
||||
There are exactly 1,000,006 app ideas that could work on the LBRY network, but it doesn't make sense for _everything_ to be built on it.
|
||||
|
||||
@@ -86,7 +86,7 @@ Unfortunately, most users will want more functionality in an app than typing int
|
||||
|
||||
You can build many types of apps. Your app doesn't have to use Electron, nor does it have to be targeted at consumers, use a UI, or even fetch digital content at all! In this section, we'll look into the different types of apps you could build, and the different components needed to build anything you want.
|
||||
|
||||
Most applications will use the [LBRY SDK](#sdk) as a way of accessing and communicating with the LBRY network. A look at the [APIs](/api/sdk) provided by the SDK will help you understand what it can and can't do.
|
||||
Most applications will use the [LBRY SDK](#sdk) as a way of accessing and communicating with the LBRY network. A look at the [APIs](https://lbry.tech/api/sdk) provided by the SDK will help you understand what it can and can't do.
|
||||
|
||||
Some applications do not need to access content available on the network (e.g. a wallet-only app, or a blockchain visualizer). These applications might use [lbrycrd](#lbrycrd), the full-node blockchain daemon, or [chainquery](#chainquery), which parses blockchain data into SQL.
|
||||
|
||||
@@ -142,7 +142,7 @@ Regardless of the type of desktop app, you'll want to follow the steps for [usin
|
||||
|
||||
The [official LBRY desktop app](https://github.com/lbryio/lbry-desktop) is built with Electron. It is very easy to build with, and allows web developers to easily start creating "native" desktop applications. You can use a plain html document with a `<script>` tag, or build out a large web app. The official desktop app uses [React](https://reactjs.org/).
|
||||
|
||||
If you want to write an electron app, check out the [electron-starter project](https://github.com/lbryio/electron-starter) for a bare bones setup that is very similar to how [lbry-desktop](https://github.com/lbryio/lbry-desktop) is structured. It's also a simple way to explore the [SDK API](<(https://https://lbry.tech/api/sdk)>).
|
||||
If you want to write an electron app, check out the [electron-starter project](https://github.com/lbryio/electron-starter) for a bare bones setup that is very similar to how [lbry-desktop](https://github.com/lbryio/lbry-desktop) is structured. It's also a simple way to explore the [SDK API](https://lbry.tech/api/sdk).
|
||||
|
||||
Check out [this video](https://spee.ch/6/lbry-electron-starter) for a brief overview and guide to get it running. If you just want the source code, go [here](https://github.com/lbryio/electron-starter). Or, if you really really want to see it in action _now_, just paste these commands into your terminal:
|
||||
|
||||
@@ -195,7 +195,7 @@ Once that is downloaded, there are two steps to get it integrated into your app.
|
||||
|
||||
First, run `lbrynet start` in the directory you downloaded the SDK. This starts the API server and connects to the LBRY network.
|
||||
|
||||
Then, use an API wrapper to talk to the SDK or write your own. There are a number of simple [api wrappers](https://lbry.tech/resources/api-wrappers) available in several different languages, created by LBRY community members! These allow you to easily send commands to the SDK in the language of your choice.
|
||||
Then, use an API wrapper to talk to the SDK or write your own. There are a number of simple [API wrappers](https://lbry.tech/resources/api-wrappers) available in several different languages, created by LBRY community members! These allow you to easily send commands to the SDK in the language of your choice.
|
||||
|
||||
If a wrapper for the language you would like to use doesn't exist, it is still fairly easy to interact with. The SDK provides a JSON-RPC server at `localhost:5279` for interaction. You can call it via `cURL` or the HTTP functionality provided by the language you are using. You can look at an existing wrapper in another language for more detail.
|
||||
|
||||
|
||||
@@ -22,10 +22,8 @@ If you want to contribute to LBRY, there's definitely something for you! The fir
|
||||
| Component | Language (Toolset) | What Is It | Intro Video
|
||||
--- | --- | --- | ---
|
||||
| [lbrycrd](https://github.com/lbryio/lbrycrd) | C++ | A full node for the LBRY blockchain, including a standalone wallet. Used by miners and some applications. Most consumer applications do not bundle [[lbrycrd]] directly, and instead bundle [[lbry-sdk]]. | [Video](/resources/video-lbrycrd)
|
||||
| [lbry-sdk](https://github.com/lbryio/lbry-sdk) | Python (asyncio) | A daemon that can be used directly or to develop other applications. Provides convenience [APIs](/api/sdk), bundles an SPV wallet ([[torba]]), and contains an implementation of the LBRY data network. | [Video](/resources/video-lbrysdk)
|
||||
| [torba](https://github.com/lbryio/lbry-sdk) | Python | An [[SPV]] (Simple Payment Verification) wallet. Bundled with [[lbry-sdk]].
|
||||
| [wallet server](https://github.com/lbryio/lbry-sdk/tree/master/lbry/lbry/wallet/server) | Protobuf, Python | The wallet server used by [[torba]]. | |
|
||||
| [schema](https://github.com/lbryio/lbry-sdk/tree/master/lbry/lbry/schema) | Protobuf, Python | Defines the structure of the metadata stored in the LBRY blockchain. | |
|
||||
| [lbry-sdk](https://github.com/lbryio/lbry-sdk) | Python (asyncio) | A daemon that can be used directly or to develop other applications. Provides convenience [APIs](/api/sdk), bundles an SPV wallet client and server, and contains an implementation of the LBRY data network. | [Video](/resources/video-lbrysdk)
|
||||
| [schema](https://github.com/lbryio/lbry-sdk/tree/master/lbry/schema) | Protobuf, Python | Defines the structure of the metadata stored in the LBRY blockchain. | |
|
||||
|
||||
### Official Applications
|
||||
| Application | Language (Toolset) | What Is It | Intro Video
|
||||
|
||||
@@ -43,7 +43,7 @@ An open, distributed ledger that records transactions in a verifiable and change
|
||||
|
||||
### Canonical URL
|
||||
|
||||
Similar to the [Short URL](#short-url) but for claims that are signed by channels, both the channel Short URL and claim Short URL are returned (i.e. lbry://@LBRY-Social#d/two#f. A canonical URL will change if the channel is updated, therefore its less permanent than a Short URL which is less permanent than the [Permanent URL](https://spec.lbry.com/#urls).
|
||||
Similar to the [Short URL](#short-url), but will include the channel for but for claims that are signed by channels. The canonical URL is generally the recommend URL to use when linking LBRY URLs or displaying URLs to users. Note that it is rarely possible for the canonical URL to change to a shorter version when a competeting channel or claim is abandoned, but even if this happens, older canonical URLs will still work.
|
||||
|
||||
### Chainquery
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ While the blockchain is the innovation that makes LBRY _possible_, the [Data Net
|
||||
|
||||
At this level:
|
||||
|
||||
- [Metadata](/spec#metadata] stored in the blockchain is interpreted and validated.
|
||||
- [Metadata](/spec#metadata) stored in the blockchain is interpreted and validated.
|
||||
- [Data referenced by metadata](/spec#data) is accessed and distributed via a peer-to-peer network.
|
||||
- [Identities](/spec#channels) are created, signed, and validated.
|
||||
|
||||
|
||||
@@ -18,3 +18,4 @@ description: Find the LBRY specification, API documentation, our Contributor's g
|
||||
- [Regtest Setup](/resources/regtest-setup)
|
||||
- [LBRY Android App Build Steps](/resources/android-build)
|
||||
- [Lighthouse (search) API](https://lbryio.github.io/lighthouse)
|
||||
- [Run Your Own Wallet Server](/resources/wallet-server)
|
||||
@@ -3,7 +3,7 @@ title: SDK Settings
|
||||
description: The daemon provided by the LBRY SDK has many settings. This resource lists them all and what they mean. Ready, set, settings!
|
||||
---
|
||||
|
||||
This document outlines how to configure SDK daemon settings and what options are available. They can be found on the lbry GitHub repository in [conf.py](https://github.com/lbryio/lbry-sdk/blob/master/lbry/lbry/conf.py).
|
||||
This document outlines how to configure SDK daemon settings and what options are available. They can be found on the lbry GitHub repository in [conf.py](https://github.com/lbryio/lbry-sdk/blob/master/lbry/conf.py).
|
||||
|
||||
## Daemon settings configuration
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ For this example, we will use claim ID `d9317ac7842f88ba442fee749c4f834353c24206
|
||||
|
||||
## Parse the Metadata
|
||||
|
||||
Perform a `getclaimbyid` call to lbrycrd using the claim ID for the claim you want to look up. You should get a response with some parameters. The `value` parameter contains the claim contents as a protobuf-encoded binary string. Decode the value using the protobuf definitions in [lbryio/types](https://github.com/lbryio/types/tree/master/proto). You will get a Claim object.
|
||||
Perform a `getclaimbyid` call to lbrycrd using the claim ID for the claim you want to look up. You should get a response with some parameters. The `value` parameter contains the claim contents as a protobuf-encoded binary string. Decode the value using the protobuf definitions in [lbryio/types](https://github.com/lbryio/types/tree/master/v2/proto). You will get a Claim object.
|
||||
|
||||
|
||||
## Get the Stream Hash
|
||||
|
||||
@@ -33,7 +33,7 @@ For this example, we will use claimID `d9317ac7842f88ba442fee749c4f834353c24206`
|
||||
|
||||
## Parse the Metadata
|
||||
|
||||
Perform a `getclaimbyid` call to lbrycrd using the claimID for the claim you want to look up. You should get a response with some parameters. The `value` parameter contains the claim contents as a protobuf-encoded binary string. Decode the value using the protobuf definitions in [lbryio/types](https://github.com/lbryio/types/tree/master/proto). You will get a Claim object.
|
||||
Perform a `getclaimbyid` call to lbrycrd using the claimID for the claim you want to look up. You should get a response with some parameters. The `value` parameter contains the claim contents as a protobuf-encoded binary string. Decode the value using the protobuf definitions in [lbryio/types](https://github.com/lbryio/types/tree/master/v2/proto). You will get a Claim object.
|
||||
|
||||
|
||||
## Get the SD Hash
|
||||
|
||||
@@ -101,4 +101,4 @@ A template for issues should exist to guide users in correctly filing them.
|
||||
|
||||
## Style and Formatting Notes
|
||||
|
||||
- Rely on autowrap instead of manually breaking up paragraphs with carriage return.
|
||||
- Rely on autowrap instead of manually breaking up paragraphs with a carriage return.
|
||||
@@ -0,0 +1,100 @@
|
||||
# How To Run Your Own Wallet Server
|
||||
|
||||
This guide will walk you through the process of setting up a LBRY wallet server. This involves provisioning a web server and setting up some services (docker, lbrycrd, and the wallet server). At the end, you'll have your own connection to the LBRY network.
|
||||
|
||||
**note:** This is early-stage stuff. You may encounter unexpected issues. Please be patient and don't hesitate to [reach out for help](#get-in-touch).
|
||||
|
||||
|
||||
## Start With A Fresh Server
|
||||
|
||||
We recommend a dual-core server with at least 8GB RAM, 50GB disk, and a fresh Ubuntu 18.04 install.
|
||||
|
||||
I tested this guide on AWS using a `t3.large` instance and the `ami-07d0cf3af28718ef8` image. If you're using AWS, create your instance in the us-east-2 (Ohio) region. That's where our snapshots are stored, so downloading them will be faster for you.
|
||||
|
||||
Make sure your firewall has ports 9246 and 50001 open. 9246 is the port lbrycrd uses to communicate to other nodes. 50001 is the wallet server RPC port.
|
||||
|
||||
|
||||
## Set Up Docker
|
||||
|
||||
### Install Docker & Docker Compose
|
||||
```
|
||||
sudo apt install -y apt-transport-https ca-certificates curl software-properties-common && \
|
||||
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - && \
|
||||
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" && \
|
||||
sudo apt install -y docker-ce docker-ce-cli containerd.io && \
|
||||
sudo systemctl enable docker && sudo systemctl start docker && \
|
||||
sudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose && \
|
||||
sudo chmod +x /usr/local/bin/docker-compose
|
||||
|
||||
```
|
||||
|
||||
### Download our docker-compose.yml
|
||||
|
||||
You can see it [here](https://github.com/lbryio/lbry-sdk/blob/master/docker/docker-compose-wallet-server.yml).
|
||||
```
|
||||
curl -L "https://raw.githubusercontent.com/lbryio/lbry-sdk/master/docker/docker-compose-wallet-server.yml" -o docker-compose.yml
|
||||
```
|
||||
|
||||
## Turn It On
|
||||
|
||||
### Start the servers
|
||||
```
|
||||
sudo docker-compose up --detach
|
||||
```
|
||||
|
||||
### Check that everything worked
|
||||
|
||||
The first time you start the wallet server, it will take a few minutes to download a recent snapshot of the database and extract it. You can follow the progress with
|
||||
|
||||
```
|
||||
sudo docker-compose logs --follow
|
||||
```
|
||||
|
||||
After the wallet server has caught up, it will bind to port 50001 and start responding to requests. You can check if this happened by running
|
||||
|
||||
```
|
||||
sudo netstat -tlpn | grep 50001
|
||||
```
|
||||
|
||||
If there is no output, the port is ont bound yet and the server is still catching up. Check the logs for more info.
|
||||
|
||||
After the wallet server is ready, check that it responds to basic RPC calls:
|
||||
|
||||
```
|
||||
echo '{"id":1,"method":"server.version"}' | timeout 1 curl telnet://localhost:50001
|
||||
```
|
||||
|
||||
You should see a response like `{"jsonrpc": "2.0", "result": ["0.46.1", "0.0"], "id": 1}`. If you do, congratulations! You've set up your own wallet server.
|
||||
|
||||
|
||||
## Maintenance
|
||||
|
||||
### Stopping and Restarting
|
||||
|
||||
Use the usual docker-compose commands (`start`, `stop`, `pause`, etc) to control the servers. Run `docker-compose --help` to see the
|
||||
options.
|
||||
|
||||
|
||||
### Updating
|
||||
|
||||
To update to the latest wallet server release, run the following:
|
||||
```
|
||||
docker pull lbry/wallet-server:latest-release
|
||||
docker-compose down
|
||||
docker-compose up --detach
|
||||
```
|
||||
|
||||
### Resyncing
|
||||
|
||||
From time to time, we'll release an update that requires erasing the wallet server database and recreating it from scratch. The process is
|
||||
similar to an update, but causes the server to be down for much longer. Here's how to do it:
|
||||
```
|
||||
docker pull lbry/wallet-server:latest-release
|
||||
docker-compose down
|
||||
docker volume rm "$(whoami)_wallet_server"
|
||||
WALLET_SERVER_SNAPSHOT_URL= docker-compose up --detach
|
||||
```
|
||||
|
||||
## Get in touch
|
||||
|
||||
Whether you got to the end without a hiccup or you got stuck along the way, we want to hear from you. [Join our Discord](https://discord.gg/y3W9JuS) to get help, stay updated, and talk to other wallet server operators.
|
||||
Generated
+10961
File diff suppressed because it is too large.
Load diff
Reference in new issue
Block a user