Compare commits

..
Author SHA1 Message Date
Bryan Lunduke cb6b72b5b2 Update overview.md
Removing the developer program link.
2021-06-09 13:54:07 -05:00
Florence Jay Munar 7dc4883bf6 Update icons 2021-06-07 10:18:14 -04:00
Alex Grin ddf43a087c Merge pull request #348 from lbryio/resync-docs
Explain how to resync ES and expand into two parts
2021-05-18 15:11:25 -04:00
Victor Shyba a3796248ee Explain how to resync ES and expand into two parts 2021-05-13 17:45:41 -03:00
Alex Grintsvayg 507f125727 a few edits 2021-04-20 16:49:30 -04:00
Victor ShybaandAlex Grin 7fecb9fcc1 Update wallet-server.md (#339)
Co-authored-by: Alex Grin <lyoshenka@users.noreply.github.com>
2021-04-19 15:21:17 -04:00
Alex Grintsvayg f282093d24 disable dev program 2021-03-29 09:42:52 -04:00
Thomas Zarebczan c00f03cbef Merge pull request #341 from ElectronEsq/patch-3
Missing rule added.
2021-03-18 12:01:54 -04:00
Thomas Zarebczan a0bc2572a8 Update developer-program.md 2021-03-18 11:45:12 -04:00
Thomas Zarebczan 3ea5e3d261 Update overview.md 2021-03-18 11:44:46 -04:00
Electron - Mark Firth 668e140978 Missing rule added.
Missing rule added.
2021-03-18 18:59:25 +10:00
Thomas Zarebczan 433d05776e Fix video links 2021-01-04 12:02:18 -05:00
johan456789 e024e7dab7 Update twitter link 2020-12-29 11:31:42 -05:00
Niko 16d59fbf66 Merge pull request #331 from kodxana/master
Fixed docker security
2020-09-28 14:38:49 -04:00
kodxana 91431922f5 Fixed docker security
Running docker as sudo is not the best security.
https://engineering.bitnami.com/articles/why-non-root-containers-are-important-for-security.html

Instead of running container as root add user to docker group and there will no need for using sudo.
2020-09-28 20:22:58 +02:00
Thomas Zarebczan ae4e43b466 Merge pull request #329 from edrochenski/patch-1
Clarify commit history requirement
2020-08-28 13:17:04 -04:00
Ed Rochenski 55d55ae0f8 Clarify commit history requirement 2020-08-28 12:25:17 -04:00
Thomas Zarebczan 0716a22357 Merge pull request #323 from pavelloz/npm-tasks-bail
Abort if previous task fail
2020-05-20 07:53:22 -04:00
Thomas Zarebczan 991331d2c2 Merge pull request #324 from keikari/patch-1
Update wallet address default values
2020-05-20 07:52:22 -04:00
keikari 59246be540 Update wallet address default values
I noticed that default wallet server addresses were old and didn't worked.
Updated values and added list of default servers into "Description", since listing them in "Default value" made page too wide on preview.
2020-05-17 12:37:12 +03:00
Paweł Kowalski cd1a2fc70a Abort if previous task fail 2020-05-16 11:34:12 +02:00
Thomas Zarebczan d7b71a0d1c Merge pull request #322 from eatdostacos/master
Some More LBRY.tech Small Changes
2020-05-01 13:55:35 -04:00
eatdostacos a6905a4e96 Consensus.md small changes
The title exactly.
2020-05-01 10:09:21 -07:00
eatdostacos b4e88a5396 Small Updates to claimtrie.md
See edits.
2020-05-01 10:04:15 -07:00
Thomas Zarebczan cd4034fa64 Merge pull request #321 from eatdostacos/patch-1
More General Improvements
2020-05-01 09:09:30 -04:00
eatdostacos 92005ee346 Change "sha256" to "SHA256"
Exactly the title.
2020-04-30 22:41:37 -07:00
eatdostacos 99804e5697 Corrected Some Things
Changed some text to make it sound better and be correct.
2020-04-30 22:34:08 -07:00
Thomas Zarebczan 5986a6a59a Merge pull request #320 from eatdostacos/patch-1
General Improvements
2020-05-01 01:20:49 -04:00
eatdostacos ecfdbecf2c Removed the "or," that didn't seem necessary
This bit of text didn't seem like it was needed at the LBRY Credits was already in parenthesizes showing that it is what LBC means.
2020-04-30 22:10:47 -07:00
eatdostacos 2d91e2dd1b "LBRY" Coin to "LBRY Credits"
For some reason it said LBRY Coin even though that has never been a thing. I also capitalized the C in Credits.
2020-04-30 21:56:31 -07:00
Thomas Zarebczan 0bdc1cf733 Merge pull request #318 from NetOperatorWibby/patch-1
Updates primary contact
2020-04-17 08:08:13 -04:00
netop://ウエハ dc118bdbf5 Updates primary contact
_I'm assuming your email address, Tom._
2020-04-16 22:31:24 -07:00
Thomas Zarebczan dc54ce1cf0 Merge pull request #317 from cassidypignatello/fix/code-style-errors
fixes eslint errors
2020-04-14 16:47:01 -04:00
Cassidy 7797f1f42c fixes eslint errors 2020-04-11 14:40:00 +07:00
Jeremy Kauffman f2833d4a8e add translating instructions 2020-03-24 19:14:04 -04:00
Jeremy Kauffman 7d67f6700f lbry-desktop is lbry.tv 2020-03-10 16:08:24 -04:00
Jeremy Kauffman 71d78c40d9 fix broken link 2020-02-28 17:26:01 -05:00
Niko Storni 15a8675bef fix playground 2020-02-26 19:23:25 +01:00
Thomas Zarebczan 72aad4a523 Merge pull request #314 from netapau/patch-1
Update repository-standards.md
2020-02-25 09:20:14 -05:00
Tony Simoes 6fb5915808 Update repository-standards.md
Asterisk 'Italics' inside 'url brackets' generates a 404.

See : [https://lbry.tech/resources/repository-standards](https://lbry.tech/resources/repository-standards).
2020-02-22 13:44:03 +01:00
James Goodrich 04bc129c8e Replaces broken ecosystem-overview links
The Reporting a Bug and Feature Requests sections contained broken links to the Ecosystem Overview. However, the steps containing the broken link were for identifying the correct repository. Therefore, the broken ecosystem-overview links were replaced with repository-overview links with additional updates to the linking text.

Fixes #305
2020-02-06 16:31:02 -05:00
Lex Berezhny b09820a315 Merge pull request #311 from lbryio/lbry_sdk_directory_refactor
lbry directory in lbry-sdk repo moved up one level
2020-01-02 14:27:12 -05:00
Lex Berezhny 32f64d704d lbry directory in lbry-sdk repo moved up one level 2019-12-31 19:20:37 -05:00
Iykury 0a51e2f652 Edit "There's literally 12^n of us." to be more correct 2019-12-30 13:27:36 -05:00
Alex Grintsvayg b260fc0624 wallet server maintenance instructions 2019-12-20 12:59:19 -05:00
Alex Grintsvayg 7b11a03e02 wallet server guide 2019-11-27 10:24:09 -05:00
Jeremy Kauffman 7963e5bdd4 no more web-daemon 2019-11-20 16:06:07 -05:00
Niko Storni 6ad1f91862 fix api endpoint 2019-11-14 17:53:04 -05:00
Niko Storni 167587081f add lockfile 2019-11-12 15:25:37 -05:00
Jeremy Kauffman 47da88fe2a update canonical url glossary 2019-11-11 15:41:32 -05:00
Sean Yesmunt fed52c65da Allow app to be run locally without github token 2019-10-29 18:46:01 -04:00
Thomas Zarebczan 0ec0dea55d Merge pull request #308 from sameshl/patch-1
Update repository-standards.md
2019-10-29 13:11:38 -04:00
Samesh Lakhotia dac8511d1f Update repository-standards.md
add determiner `a`
2019-10-29 22:36:46 +05:30
Thomas Zarebczan 362c14c83c Merge pull request #304 from colinfruit/md-link-typo
fix markdown typo in overview
2019-10-26 09:26:41 -04:00
Thomas Zarebczan 053aad7833 Merge pull request #303 from michizhou/patch-1
Fixed broken links and typos in documentation
2019-10-26 09:26:14 -04:00
Thomas Zarebczan 026bb01b81 Merge pull request #302 from vulongm/patch-1
Add "master" to list of tags
2019-10-26 09:25:53 -04:00
colinfruit e020eb3c13 fix markdown typo in overview 2019-10-24 22:53:06 -04:00
michizhou 1be0995bbf Fixed broken links and typos in documentation 2019-10-24 20:43:40 -04:00
Long Vu d8b37ed0e6 Add "master" to list of tags
Resolves #301
2019-10-24 16:39:26 -04:00
Thomas Zarebczan 1b56526711 Merge pull request #300 from ykris45/patch-5
fix broken link on LBRY Tech Repo
2019-10-15 12:16:24 -04:00
YULIUS KURNIAWAN KRISTIANTO 707f616224 Update edit-link.js 2019-10-15 20:11:34 +07:00
YULIUS KURNIAWAN KRISTIANTO 5277050c37 Update download-overview.md 2019-10-15 19:55:47 +07:00
YULIUS KURNIAWAN KRISTIANTO 698222cf32 Update download-overview-new.md 2019-10-15 19:55:19 +07:00
YULIUS KURNIAWAN KRISTIANTO 1c0888e0cf fix broken links and 404 link 2019-10-15 19:37:38 +07:00
Niko Storni 39ea483f08 fix resolution of claims 2019-09-23 23:01:28 +02:00
Niko Storni 6ae0984edf add trending call
use new resolve and trending
remove old trending func
2019-09-23 19:42:21 +02:00
Niko Storni d5932ce67c port resolve call to lbrytv 2019-09-23 19:27:04 +02:00
Thomas Zarebczan 777d9f0f83 Yolo fix to rewards
Will run locally if this doesn't work...
2019-09-12 14:48:54 -04:00
Thomas Zarebczan b3ae6ca0d6 remove auth settings 2019-09-12 12:10:16 -04:00
Thomas Zarebczan ebbcb02c87 Merge pull request #296 from lbryio/devprogram-fixes
Developer program fixes
2019-09-10 13:29:25 -04:00
netop://ウエハ cc965191f2 Better error messaging 2019-09-09 17:37:58 -05:00
netop://ウエハ 48190d18be Debugging 2019-09-09 16:59:22 -05:00
netop://ウエハ 201f8a4a09 Closes #291 2019-09-09 16:57:22 -05:00
netop://ウエハ ed6cfb239a Debugging 2019-09-09 15:55:32 -05:00
Thomas Zarebczan 7beeffd008 add short and canonical url definitions 2019-09-09 14:32:59 -04:00
Thomas Zarebczan 8bfeafa137 Merge pull request #295 from dittaeva/patch-1
Update contribute.md HTMl > HTML
2019-09-09 09:42:34 -04:00
Guttorm Flatabø 85226a20d0 Update contribute.md HTMl > HTML 2019-09-09 15:26:38 +02:00
Niko ee65417441 Merge pull request #294 from lbryio/fix_some_bugs
Fixed some bugs
2019-09-02 04:44:07 +02:00
Mark Beamer Jr 94136dbb69 Add console error for heroku log.
Fix bug where there was not check on undefined metadata.
Fix bug where claims from list trending are not part of a channel.
2019-09-01 22:33:36 -04:00
netop://ウエハ 5bc4650ad1 Merge pull request #290 from eggplantbren/patch-1
Add streaming_server to table of daemon settings
2019-08-25 20:20:24 -05:00
Brendon J. Brewer 741a672538 Add streaming_server to table of daemon settings
I guessed this option while trying to get LBRY to run when I connect to a VPN. Thought I'd add it to the page.
2019-08-26 13:04:14 +12:00
netop://ウエハ 5949bcb16e Closes #288 2019-08-21 12:54:17 -05:00
Niko Storni f66349d613 woops... one more 2019-08-06 22:58:53 +02:00
Niko Storni 753deb4723 remove unnecessary logging 2019-08-06 22:58:11 +02:00
Niko Storni 3e2e6afbc7 hide porn
fix missing imports
log better
2019-08-06 22:52:50 +02:00
Thomas Zarebczan 79f81d4267 add streaming options 2019-08-06 10:57:26 -04:00
netop://ウエハ 3e061dbf4b Hotfix: check for tag existence 2019-07-11 17:46:38 -05:00
netop://ウエハ 8b9ca4302b Merge pull request #283 from lbryio/versionable-apis
Versionable APIs
2019-07-11 17:27:36 -05:00
netop://ウエハ 4045de7c2c Removed commented code 2019-07-11 17:25:55 -05:00
netop://ウエハ 39bf3b56bc Linting 2019-07-11 17:09:36 -05:00
netop://ウエハ a6b7340e9d Done 2019-07-11 16:20:50 -05:00
netop://ウエハ 4b14cc1a73 Almost done 2019-07-10 16:48:45 -05:00
netop://ウエハ e260ae0e28 In progress 2019-07-10 12:34:19 -05:00
netop://ウエハ 0c496b33ae Visual fix for input on API pages 2019-07-08 14:30:37 -05:00
netop://ウエハ fda1e3d800 Updated deps 2019-07-08 14:04:25 -05:00
Thomas Zarebczan 05af3d76a0 Merge pull request #282 from lbryio/lbry_sdk_repo_rename
lbry repo was renamed to lbry-sdk
2019-06-20 23:46:48 -04:00
Lex Berezhny d673bd6395 lbry repo was renamed to lbry-sdk 2019-06-20 23:43:42 -04:00
52 changed files with 11878 additions and 427 deletions

No files matched your search

-1
View File
@@ -1 +0,0 @@
package-lock=false
+1 -2
View File
@@ -25,7 +25,6 @@
## Prerequisites
- [lbry/web-daemon](https://github.com/lbryio/web-daemon)
- [Node](https://nodejs.org) (version >= 10)
## Notes
@@ -61,4 +60,4 @@ We take security seriously. Please contact [security@lbry.com](mailto:security@l
[Our PGP key is here](https://keybase.io/lbry/key.asc) if you need it.
## Contact
The primary contact for this project is [Paul Anthony Webb](https://github.com/NetOperatorWibby) (paul+github@lbry.com).
The primary contact for this project is [Thomas Zarebczan](https://github.com/tzarebczan) (tom+github@lbry.com).
+2 -2
View File
@@ -10,9 +10,9 @@ import html from "choo/html";
// E X P O R T
export default () => html`
export default version => html`
<div class="api-content__body">
<h2>lbrycrd APIs</h2>
<h2>lbrycrd ${version}</h2>
<p>Methods and signatures provided by the <a href="/glossary#lbrycrd">lbrycrd</a> blockchain daemon are documented below. To build, download, or run lbrycrd, see the project <a href="https://github.com/lbryio/lbrycrd/blob/master/README.md">README</a>.</p>
</div>
+4 -4
View File
@@ -10,14 +10,14 @@ import html from "choo/html";
// E X P O R T
export default () => html`
export default version => html`
<div class="api-content__body">
<h2>lbry-sdk APIs</h2>
<p>Methods and signatures provided by the <a href="/glossary#lbry-sdk">lbry-sdk</a> daemon are documented below. To build, download, or run the daemon, see the project <a href="https://github.com/lbryio/lbry/blob/master/README.md">README</a>.</p>
<h2>lbry-sdk ${version}</h2>
<p>Methods and signatures provided by the <a href="/glossary#lbry-sdk">lbry-sdk</a> daemon are documented below. To build, download, or run the daemon, see the project <a href="https://github.com/lbryio/lbry-sdk/blob/master/README.md">README</a>.</p>
</div>
<div class="api-content__intro">
<p>You can find the repo for this API on GitHub:</p>
<pre><code>https://github.com/lbryio/lbry</code></pre>
<pre><code>https://github.com/lbryio/lbry-sdk</code></pre>
</div>
`;
+16 -9
View File
@@ -24,7 +24,7 @@ if (window.location.search.includes("?code=")) {
<p>To receive your LBC, you'll need a wallet address. While graphical wallets are available, the recommended path for engineers is to:</p>
<ol>
<li>Download <a href="https://github.com/lbryio/lbry/releases">the LBRY SDK</a>.</li>
<li>Download <a href="https://github.com/lbryio/lbry-sdk/releases">the LBRY SDK</a>.</li>
<li>Launch the command-line utility (<code>./lbrynet start</code>).</li>
<li>Run <code>./lbrynet address unused</code> and copy the <code>id</code> field.</li>
</ol>
@@ -56,33 +56,40 @@ function syncWithApi(data) { // eslint-disable-line no-unused-vars
const address = data.address;
const code = data.code;
if (code === null)
if (code === null) {
document.querySelector("developer-program").innerHTML =
"<p><strong>There was an issue with accessing GitHub's API. Please try again later.</strong></p>";
}
fetch(`https://api.lbry.com/reward/new?github_token=${code}&reward_type=github_developer&wallet_address=${address}`)
.then(response => response.json())
.then(result => {
switch(true) {
case result.error === "this reward is limited to 1 per person":
case result.error === "This reward is limited to 1 per person":
document.querySelector("developer-program").innerHTML =
"<p>You have already claimed this reward. This reward is limited to <strong>ONE</strong> per person. Your enthusiasm is appreciated.</p>";
break;
return;
case Boolean(result.error):
document.querySelector("developer-program").innerHTML =
`<p>${result.error}</p>`;
return;
case result.success:
result = result.data;
document.querySelector("developer-program").innerHTML =
`<p><strong>Success!</strong> Your wallet has been credited with ${result.reward_amount} LBC.</p><p>We have a great reference for the <a href="/api/sdk">LBRY SDK here</a> to help you get started.</p><p>You can see proof of this transaction on <a href="https://explorer.lbry.com/tx/${result.transaction_id}">our Blockchain Explorer</a>.</p>`;
break;
return;
default:
console.log(data); // eslint-disable-line no-console
console.info(data); // eslint-disable-line no-console
document.querySelector("developer-program").innerHTML =
"<p><strong>The LBRY API might be down. Please try again later.</strong></p>";
break;
"<p><strong>No success or error was received so the LBRY API might be down.<br/>Please try again later.</strong></p>";
}
})
.catch(() => {
.catch(error => {
console.error(error);
// Idk what the error would be (probably a 500) so let's just have this message
document.querySelector("developer-program").innerHTML =
"<p><strong>LBRY API is down. Please try again later.</strong></p>";
+6 -6
View File
@@ -249,15 +249,15 @@ curl --header <span class="token string">"Content-Type: application/json"</span>
}
const handleExamples = debounce(event => {
let exampleNumber;
const exampleNumber = parseInt(document.querySelector(".playground-navigation__example.active").dataset.example || 0);
const data = event.dataset;
if (!parseInt(document.querySelector(".playground-navigation__example.active").dataset.example)) return;
exampleNumber = parseInt(document.querySelector(".playground-navigation__example.active").dataset.example);
if (!exampleNumber || exampleNumber === 0)
return;
switch(data.action) {
case "choose claim":
fetchMetadata(exampleNumber, data.claimId);
fetchMetadata(exampleNumber, `${data.name}#${data.claimId}`);
if (document.querySelector(".playground-navigation__example:nth-child(3)").classList.contains("active"))
document.getElementById("fetch-claim-uri").value = event.dataset.name + "#" + event.dataset.claimId;
@@ -398,9 +398,9 @@ function updateCanvas(imageSource) {
if (imageSource) {
ctx.drawImage(imageSource, 0, 0, canvasWidth, canvasHeight);
img.src = imageSource.src;
} else {
} else
ctx.drawImage(img, 0, 0, canvasWidth, canvasHeight);
}
positionCanvasText(ctx, canvasHeight, canvasWidth);
}
+1 -1
View File
@@ -21,7 +21,7 @@ export default () => `
</span>
<div>
<span><a href="https://github.com/lbryio/lbry">lbrysdk</a></span>
<span><a href="https://github.com/lbryio/lbry-sdk">lbrysdk</a></span>
<span><a href="https://github.com/lbryio/types">lbryschema</a></span>
</div>
</h2>
+1 -2
View File
@@ -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>
+2 -2
View File
@@ -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/blob/master/docs/api.json";
githubUrl = "https://github.com/lbryio/lbry-sdk/blob/master/docs/api.json";
break;
default:
+1 -1
View File
@@ -31,7 +31,7 @@ const links = [
// title: "Join Our Team"
// },
{
href: "https://twitter.com/lbryio",
href: "https://twitter.com/LBRYcom",
image: "https://spee.ch/9c38db124b85736adbcca48cdf34877d2110bbcd/GeoShapes.png",
title: "Twitter"
},
-8
View File
@@ -68,11 +68,3 @@ export default (state, emit) => {
<script src="/assets/scripts/sockets.js"></script>
`;
};
// H E L P E R
String.prototype.capitalize = function() {
return this.charAt(0).toUpperCase() + this.slice(1);
};
+2 -2
View File
@@ -69,9 +69,9 @@ function navigation() {
<li
class="playground-navigation__example"
data-action="playground, example 3"
data-description="In the LBRY app, you can financially support your favorite creators by donating LBRY Coin (LBC). In this example, we are donating LBC in your stead."
data-description="In the LBRY app, you can financially support your favorite creators by donating LBRY Credits (LBC). In this example, we are donating LBC in your stead."
data-example="3"
data-success="<strong>Kudos</strong> You've just supported a creator with LBC (or, LBRY credits) with our own stash of LBC (you'd use your own IRL). You're basically saying, 'thanks for this great content, please continue!' and that's awesome. You're awesome."
data-success="<strong>Kudos</strong> You've just supported a creator with LBC (LBRY Credits) with our own stash of LBC (you'd use your own IRL). You're basically saying, 'thanks for this great content, please continue!' and that's awesome. You're awesome."
>
<button type="button">Support</button>
<span>Support creators on LBRY with a tip, on us!</span>
+5 -5
View File
@@ -9,11 +9,11 @@
"/resources/schema": "/spec#metadata",
"/resources/signing-claim": "/resources/claim-signing",
"/resources/uri": "/spec#urls",
"/resources/video-lbrysdk": "https://spee.ch/967f99344308f1e90f0620d91b6c93e4dfb240e0/lbrynet-dev-setup",
"/resources/video-lbrycrd": "https://spee.ch/5803b66dca7707584b36fe6b644f278fc39d1adf/intro-to-LBRYcrd",
"/resources/video-lbrydesktop": "https://spee.ch/7da73fc508ffc4ff8b2711e3c3950110430b0c5f/LBRYAppDesign",
"/resources/video-lbryandroid": "https://spee.ch/e781060bc708247f07afebc02d5f75cfba8e2c4b/video-2018-10-15053403",
"/tour": "/playground",
"/resources/video-lbryandroid": "https://odysee.com/video-2018-10-15053403:e",
"/resources/video-lbrycrd": "https://odysee.com/intro-to-LBRYcrd:5",
"/resources/video-lbrydesktop": "https://odysee.com/LBRYAppDesign:7",
"/resources/video-lbrysdk": "https://odysee.com/@lbrytech:1/lbrynet-dev-setup:9",
"/specification": "/spec",
"/tour": "/playground",
"/whitepaper": "/spec"
}
+1 -4
View File
@@ -1,4 +1 @@
<svg viewBox="0 0 245 240" xmlns="http://www.w3.org/2000/svg" fill="#222">
<path d="M104.4, 103.9c-5.7, 0 -10.2, 5 -10.2, 11.1c0, 6.1 4.6, 11.1 10.2, 11.1c5.7, 0 10.2, -5 10.2, -11.1c0.1, -6.1 -4.5, -11.1 -10.2, -11.1Zm36.5, 0c-5.7, 0 -10.2, 5 -10.2, 11.1c0, 6.1 4.6, 11.1 10.2, 11.1c5.7, 0 10.2, -5 10.2, -11.1c0, -6.1 -4.5, -11.1 -10.2, -11.1Z"/>
<path d="M189.5, 20l-134, 0c-11.3, 0 -20.5, 9.2 -20.5, 20.6l0, 135.2c0, 11.4 9.2, 20.6 20.5, 20.6l113.4, 0l-5.3, -18.5l12.8, 11.9l12.1, 11.2l21.5, 19l0, -179.4c0, -11.4 -9.2, -20.6 -20.5, -20.6Zm-38.6, 130.6c0, 0 -3.6, -4.3 -6.6, -8.1c13.1, -3.7 18.1, -11.9 18.1, -11.9c-4.1, 2.7 -8, 4.6 -11.5, 5.9c-5, 2.1 -9.8, 3.5 -14.5, 4.3c-9.6, 1.8 -18.4, 1.3 -25.9, -0.1c-5.7, -1.1 -10.6, -2.7 -14.7, -4.3c-2.3, -0.9 -4.8, -2 -7.3, -3.4c-0.3, -0.2 -0.6, -0.3 -0.9, -0.5c-0.2, -0.1 -0.3, -0.2 -0.4, -0.3c-1.8, -1 -2.8, -1.7 -2.8, -1.7c0, 0 4.8, 8 17.5, 11.8c-3, 3.8 -6.7, 8.3 -6.7, 8.3c-22.1, -0.7 -30.5, -15.2 -30.5, -15.2c0, -32.2 14.4, -58.3 14.4, -58.3c14.4, -10.8 28.1, -10.5 28.1, -10.5l1, 1.2c-18, 5.2 -26.3, 13.1 -26.3, 13.1c0, 0 2.2, -1.2 5.9, -2.9c10.7, -4.7 19.2, -6 22.7, -6.3c0.6, -0.1 1.1, -0.2 1.7, -0.2c6.1, -0.8 13, -1 20.2, -0.2c9.5, 1.1 19.7, 3.9 30.1, 9.6c0, 0 -7.9, -7.5 -24.9, -12.7l1.4, -1.6c0, 0 13.7, -0.3 28.1, 10.5c0, 0 14.4, 26.1 14.4, 58.3c0, 0 -8.5, 14.5 -30.6, 15.2Z"/>
</svg>
<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Discord</title><path d="M20.317 4.3698a19.7913 19.7913 0 00-4.8851-1.5152.0741.0741 0 00-.0785.0371c-.211.3753-.4447.8648-.6083 1.2495-1.8447-.2762-3.68-.2762-5.4868 0-.1636-.3933-.4058-.8742-.6177-1.2495a.077.077 0 00-.0785-.037 19.7363 19.7363 0 00-4.8852 1.515.0699.0699 0 00-.0321.0277C.5334 9.0458-.319 13.5799.0992 18.0578a.0824.0824 0 00.0312.0561c2.0528 1.5076 4.0413 2.4228 5.9929 3.0294a.0777.0777 0 00.0842-.0276c.4616-.6304.8731-1.2952 1.226-1.9942a.076.076 0 00-.0416-.1057c-.6528-.2476-1.2743-.5495-1.8722-.8923a.077.077 0 01-.0076-.1277c.1258-.0943.2517-.1923.3718-.2914a.0743.0743 0 01.0776-.0105c3.9278 1.7933 8.18 1.7933 12.0614 0a.0739.0739 0 01.0785.0095c.1202.099.246.1981.3728.2924a.077.077 0 01-.0066.1276 12.2986 12.2986 0 01-1.873.8914.0766.0766 0 00-.0407.1067c.3604.698.7719 1.3628 1.225 1.9932a.076.076 0 00.0842.0286c1.961-.6067 3.9495-1.5219 6.0023-3.0294a.077.077 0 00.0313-.0552c.5004-5.177-.8382-9.6739-3.5485-13.6604a.061.061 0 00-.0312-.0286zM8.02 15.3312c-1.1825 0-2.1569-1.0857-2.1569-2.419 0-1.3332.9555-2.4189 2.157-2.4189 1.2108 0 2.1757 1.0952 2.1568 2.419 0 1.3332-.9555 2.4189-2.1569 2.4189zm7.9748 0c-1.1825 0-2.1569-1.0857-2.1569-2.419 0-1.3332.9554-2.4189 2.1569-2.4189 1.2108 0 2.1757 1.0952 2.1568 2.419 0 1.3332-.946 2.4189-2.1568 2.4189Z"/></svg>

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 1.3 KiB

+1 -4
View File
@@ -1,4 +1 @@
<svg viewBox="0 0 245 240" xmlns="http://www.w3.org/2000/svg">
<circle cx="122.5" cy="120" r="87.5" fill="#222"/>
<path d="M180.833, 120c0, -7.061 -5.731, -12.792 -12.792, -12.792c-3.48, 0 -6.55, 1.33 -8.801, 3.581c-8.699, -6.242 -20.775, -10.336 -34.079, -10.847l5.833, -27.325l18.933, 3.991c0.205, 4.81 4.196, 8.699 9.108, 8.699c5.015, 0 9.108, -4.094 9.108, -9.108c0, -5.015 -4.093, -9.108 -9.108, -9.108c-3.582, 0 -6.652, 2.046 -8.085, 5.117l-21.184, -4.503c-0.614, -0.103 -1.228, 0 -1.74, 0.307c-0.511, 0.307 -0.818, 0.818 -1.023, 1.432l-6.447, 30.498c-13.612, 0.409 -25.79, 4.4 -34.591, 10.847c-2.252, -2.149 -5.424, -3.581 -8.801, -3.581c-7.062, 0 -12.793, 5.731 -12.793, 12.792c0, 5.219 3.071, 9.62 7.573, 11.667c-0.204, 1.228 -0.307, 2.558 -0.307, 3.889c0, 19.649 22.822, 35.511 51.068, 35.511c28.245, 0 51.067, -15.862 51.067, -35.511c0, -1.331 -0.102, -2.559 -0.307, -3.787c4.196, -2.047 7.368, -6.55 7.368, -11.769Zm-87.5, 9.108c0, -5.014 4.094, -9.108 9.109, -9.108c5.014, 0 9.108, 4.094 9.108, 9.108c0, 5.015 -4.094, 9.108 -9.108, 9.108c-5.015, 0 -9.109, -4.093 -9.109, -9.108Zm50.863, 24.05c-6.243, 6.243 -18.114, 6.652 -21.594, 6.652c-3.479, 0 -15.453, -0.512 -21.593, -6.652c-0.921, -0.921 -0.921, -2.456 0, -3.377c0.921, -0.921 2.456, -0.921 3.377, 0c3.889, 3.889 12.281, 5.321 18.319, 5.321c6.038, 0 14.327, -1.432 18.318, -5.321c0.921, -0.921 2.457, -0.921 3.378, 0c0.716, 1.023 0.716, 2.456 -0.205, 3.377Zm-1.638, -14.942c-5.014, 0 -9.108, -4.093 -9.108, -9.108c0, -5.014 4.094, -9.108 9.108, -9.108c5.015, 0 9.109, 4.094 9.109, 9.108c0, 5.015 -4.094, 9.108 -9.109, 9.108Z" fill="#fcfcfc"/>
</svg>
<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Reddit</title><path d="M12 0A12 12 0 0 0 0 12a12 12 0 0 0 12 12 12 12 0 0 0 12-12A12 12 0 0 0 12 0zm5.01 4.744c.688 0 1.25.561 1.25 1.249a1.25 1.25 0 0 1-2.498.056l-2.597-.547-.8 3.747c1.824.07 3.48.632 4.674 1.488.308-.309.73-.491 1.207-.491.968 0 1.754.786 1.754 1.754 0 .716-.435 1.333-1.01 1.614a3.111 3.111 0 0 1 .042.52c0 2.694-3.13 4.87-7.004 4.87-3.874 0-7.004-2.176-7.004-4.87 0-.183.015-.366.043-.534A1.748 1.748 0 0 1 4.028 12c0-.968.786-1.754 1.754-1.754.463 0 .898.196 1.207.49 1.207-.883 2.878-1.43 4.744-1.487l.885-4.182a.342.342 0 0 1 .14-.197.35.35 0 0 1 .238-.042l2.906.617a1.214 1.214 0 0 1 1.108-.701zM9.25 12C8.561 12 8 12.562 8 13.25c0 .687.561 1.248 1.25 1.248.687 0 1.248-.561 1.248-1.249 0-.688-.561-1.249-1.249-1.249zm5.5 0c-.687 0-1.248.561-1.248 1.25 0 .687.561 1.248 1.249 1.248.688 0 1.249-.561 1.249-1.249 0-.687-.562-1.249-1.25-1.249zm-5.466 3.99a.327.327 0 0 0-.231.094.33.33 0 0 0 0 .463c.842.842 2.484.913 2.961.913.477 0 2.105-.056 2.961-.913a.361.361 0 0 0 .029-.463.33.33 0 0 0-.464 0c-.547.533-1.684.73-2.512.73-.828 0-1.979-.196-2.512-.73a.326.326 0 0 0-.232-.095z"/></svg>

Before

Width:  |  Height:  |  Size: 1.6 KiB

After

Width:  |  Height:  |  Size: 1.2 KiB

+74 -47
View File
@@ -1,65 +1,39 @@
"use strict"; /* global document, Jets, window */
"use strict"; /* global document, Jets, send, window */
// NOTE:
// We declare `contentTag` and `jets` with `var` here so
// when a visitor toggles the API page version, they are
// not incorrectly declared multiple times via `let || const`
// Initiate search functionality
const contentTag = window.location.pathname.split("/").pop() === "sdk" ?
if (!contentTag)
var contentTag;
contentTag = window.location.pathname.split("/").pop() === "sdk" ?
".api-toc__section" :
"#toc";
let jets = new Jets({
if (!jets)
var jets;
jets = new Jets({
contentTag,
searchTag: "#input-search"
});
// Reset search on page load
document.getElementById("input-search").value = "";
// Activate search
document.getElementById("input-search").addEventListener("keyup", () => {
if (document.getElementById("input-search").value)
document.querySelector(".api-toc__search-clear").classList.add("active");
else
document.querySelector(".api-toc__search-clear").classList.remove("active");
});
// Cancel search
document.querySelector(".api-toc__search-clear").addEventListener("click", () => {
document.getElementById("input-search").value = "";
document.querySelector(".api-toc__search-clear").classList.remove("active");
jets.destroy();
reinitJets();
});
// Handle menu toggle for mobile
if (document.getElementById("toggle-menu")) {
document.getElementById("toggle-menu").addEventListener("click", () => {
document.querySelector("body").classList.toggle("disable-scrolling");
document.querySelector(".api-toc").classList.toggle("active");
});
// Handle menu toggle when clicking on commands
document.querySelectorAll(".api-toc__command a").forEach(command => {
command.addEventListener("click", () => {
document.querySelector("body").classList.remove("disable-scrolling");
document.querySelector(".api-toc").classList.remove("active");
});
});
}
// Code toggles
handleApiLanguageToggles("cli");
handleApiLanguageToggles("curl");
handleApiLanguageToggles("lbrynet");
handleApiLanguageToggles("python");
// H E L P E R S
function changeDocumentationVersion(desiredVersion) { // eslint-disable-line no-unused-vars
send({
message: "view different documentation version",
version: desiredVersion
});
}
function handleApiLanguageToggles(language) {
if (!document.getElementById(`toggle-${language}`))
return;
@@ -77,6 +51,59 @@ function handleApiLanguageToggles(language) {
});
}
function initializeApiFunctionality() { // eslint-disable-line no-unused-vars
// Reset search on page load
document.getElementById("input-search").value = "";
// Activate search
document.getElementById("input-search").addEventListener("keyup", () => {
if (document.getElementById("input-search").value)
document.querySelector(".api-toc__search-clear").classList.add("active");
else
document.querySelector(".api-toc__search-clear").classList.remove("active");
});
// Cancel search
document.querySelector(".api-toc__search-clear").addEventListener("click", () => {
document.getElementById("input-search").value = "";
document.querySelector(".api-toc__search-clear").classList.remove("active");
jets.destroy();
reinitJets();
});
// Handle menu toggle for mobile
if (document.getElementById("toggle-menu")) {
document.getElementById("toggle-menu").addEventListener("click", () => {
document.querySelector("body").classList.toggle("disable-scrolling");
document.querySelector(".api-toc").classList.toggle("active");
});
// Handle menu toggle when clicking on commands
document.querySelectorAll(".api-toc__command a").forEach(command => {
command.addEventListener("click", () => {
document.querySelector("body").classList.remove("disable-scrolling");
document.querySelector(".api-toc").classList.remove("active");
});
});
}
// Code toggles
handleApiLanguageToggles("cli");
handleApiLanguageToggles("curl");
handleApiLanguageToggles("lbrynet");
handleApiLanguageToggles("python");
// Ensure version selector shows correct version, even on page reloads
const currentValue = document.querySelector(".api-content__body h2").textContent.split(/\s/g).pop();
const { children } = document.querySelector(".api-toc__select");
for (const child of children) {
if (currentValue === child.text)
document.querySelector(".api-toc__select").selectedIndex = child.index;
}
}
function reinitJets() {
jets = new Jets({
contentTag,
+32 -15
View File
@@ -4,6 +4,7 @@
document.addEventListener("DOMContentLoaded", () => {
scrollToElementOnLoad();
initializeSmoothScroll();
// Automatically open external links in new tabs
document.querySelectorAll("a[href^=http]").forEach(anchor => {
@@ -39,25 +40,27 @@ if (
// Smooth scroll
document.querySelectorAll("a[href^='#']").forEach(anchor => {
if (anchor.classList.contains("no-smooth")) // Ignore smooth scroll functionality
return;
function initializeSmoothScroll() {
// Smooth scroll
document.querySelectorAll("a[href^='#']").forEach(anchor => {
if (anchor.classList.contains("no-smooth")) // Ignore smooth scroll functionality
return;
anchor.addEventListener("click", event => {
event.preventDefault();
anchor.addEventListener("click", event => {
event.preventDefault();
const element = event.target.href.split("#").pop()
.toLowerCase();
let elementOffset;
const element = event.target.href.split("#").pop()
.toLowerCase();
let elementOffset;
if (document.getElementById(element)) {
elementOffset = document.getElementById(element).offsetTop - 150;
window.scroll({ top: elementOffset, behavior: "smooth" });
history.pushState({}, "", `#${element}`); // Add hash to URL bar
}
if (document.getElementById(element)) {
elementOffset = document.getElementById(element).offsetTop - 150;
window.scroll({ top: elementOffset, behavior: "smooth" });
history.pushState({}, "", `#${element}`); // Add hash to URL bar
}
});
});
});
}
// Newsletter
document.getElementById("emailAddress").addEventListener("keyup", event => {
@@ -88,6 +91,20 @@ document.querySelector("[data-action='subscribe to newsletter']").onclick = () =
// H E L P E R S
function runScriptsInDynamicallyInsertedHTML(element, elementHTML) { // eslint-disable-line no-unused-vars
element.innerHTML = elementHTML;
Array.from(element.querySelectorAll("script")).forEach(oldScript => {
const newScript = document.createElement("script");
Array.from(oldScript.attributes)
.forEach(attr => newScript.setAttribute(attr.name, attr.value));
newScript.appendChild(document.createTextNode(oldScript.innerHTML));
oldScript.parentNode.replaceChild(newScript, oldScript);
});
}
function scrollToElementOnLoad() {
if (window.location.href.includes("#")) {
setTimeout(() => { // give page time to breathe
+21 -1
View File
@@ -1,4 +1,4 @@
"use strict"; /* global document, location, WebSocket, window */
"use strict"; /* global document, initializeSmoothScroll, location, runScriptsInDynamicallyInsertedHTML, WebSocket, window */
@@ -44,6 +44,26 @@ function initializeWebSocketConnection() {
window.location.href = data.url;
break;
case data.message === "replace html":
// create placeholder
var placeholder = document.createElement("div");
placeholder.setAttribute("id", "__placeholder"); // eslint-disable-line padding-line-between-statements
document.querySelector(data.selector).insertAdjacentElement("afterend", placeholder);
// remove original element
document.querySelector(data.selector).remove();
// add new element and remove placeholder
document.getElementById("__placeholder").insertAdjacentHTML("afterend", data.html);
document.getElementById("__placeholder").remove();
// make our scripts work
runScriptsInDynamicallyInsertedHTML(document.querySelector(data.selector), document.querySelector(data.selector).innerHTML);
// make smooth scroll work on our new content
initializeSmoothScroll();
break;
case data.message === "show result":
if (!data.example)
return;
+42 -15
View File
@@ -13,6 +13,8 @@ import stringifyObject from "stringify-object";
import messageSlack from "./slack";
import publishMeme from "./publish-meme";
import lbrytvAPI from "~helper/lbrytv-sdk";
import randomString from "./random-string";
import { send } from "~socket";
import uploadImage from "./upload-image";
@@ -55,10 +57,10 @@ export default async(data, socket) => {
let dataDetails = "";
let explorerNotice = "";
if (data.example === 1 && !data.claim || !data.method) return;
if (data.example === 1 && (!data.claim || !data.method)) return;
if (data.example === 2 && !data.data) return;
if (data.example === 2) dataDetails = data.data; // file upload
if (data.example === 3 && !data.claim || !data.method) return;
if (data.example === 3 && (!data.claim || !data.method)) return;
const claimAddress = data.claim;
const resolveMethod = data.method;
@@ -76,10 +78,10 @@ export default async(data, socket) => {
switch(true) {
switch(resolveMethod) {
// T I P
// E X A M P L E
case resolveMethod === "support_create":
case "support_create":
if (!approvedContentIdsForTipping.includes(claimAddress)) {
return send(socket, {
example: data.example,
@@ -103,7 +105,7 @@ export default async(data, socket) => {
// P U B L I S H
// E X A M P L E
case resolveMethod === "publish":
case "publish":
apiRequestMethod = "PUT";
// Required for publishing
@@ -155,9 +157,7 @@ export default async(data, socket) => {
message: "show result",
selector: `#example${data.example}-result`
});
}
catch(memePublishError) {
} catch(memePublishError) {
send(socket, {
details: "Meme publish failed",
message: "notification",
@@ -174,9 +174,7 @@ export default async(data, socket) => {
return;
}
}
catch(imageUploadError) {
} catch(imageUploadError) {
send(socket, {
details: "Image upload failed",
message: "notification",
@@ -198,10 +196,36 @@ export default async(data, socket) => {
// R E S O L V E
// E X A M P L E
case resolveMethod === "resolve":
case "resolve":
apiRequestMethod = "GET";
body.uri = claimAddress;
try {
const resolveResponse = await lbrytvAPI.resolve([claimAddress]);
if (socket) {
const renderedCode = prism.highlight(
stringifyObject(resolveResponse, { indent: " ", singleQuotes: false }),
prism.languages.json,
"json"
);
return send(socket, {
example: data.example,
html: raw(`
<h3>Response</h3>
${explorerNotice}
<pre><code class="language-json">${renderedCode}</code></pre>
`),
message: "show result",
selector: `#example${data.example}-result`
});
}
} catch(error) {
messageSlack({
message: "```" + error + "```",
title: "DAEMON ERROR: resolve"
});
}
break;
@@ -258,10 +282,13 @@ export default async(data, socket) => {
});
}
return response.body.result[Object.keys(response.body.result)[0]].claim;
}
// console.log("——");
// console.log(response.body.result[Object.keys(response.body.result)[0]]);
// console.log("——");
catch(error) {
return response.body.result[Object.keys(response.body.result)[0]];
} catch(error) {
console.error(error);
messageSlack({
message: "```" + error + "```",
pretext: "_Someone is going through the Playground and the daemon is not running_",
+18 -15
View File
@@ -16,16 +16,6 @@ import relativeDate from "~module/relative-date";
let octokit;
String.prototype.escape = function() {
const tagsToReplace = {
"&": "&amp;",
"<": "&lt;",
">": "&gt;"
};
return this.replace(/[&<>]/g, tag => tagsToReplace[tag] || tag);
};
// R E D I S
let client;
@@ -142,7 +132,7 @@ function generateEvent(event) {
rel="noopener noreferrer"
target="_blank"
title="View this comment on GitHub"
>${event.payload.issue.title.escape()}</a></em> in
>${escapeSpecialCharacters(event.payload.issue.title)}</a></em> in
`;
} else {
return `
@@ -153,7 +143,7 @@ function generateEvent(event) {
rel="noopener noreferrer"
target="_blank"
title="View this comment on GitHub"
>${event.payload.issue.title.escape()}</a></em> in
>${escapeSpecialCharacters(event.payload.issue.title)}</a></em> in
`;
}
@@ -171,7 +161,7 @@ function generateEvent(event) {
rel="noopener noreferrer"
target="_blank"
title="View this issue on GitHub"
>${event.payload.issue.title.escape()}</a></em> in
>${escapeSpecialCharacters(event.payload.issue.title)}</a></em> in
`;
case "PullRequestEvent":
@@ -188,7 +178,7 @@ function generateEvent(event) {
rel="noopener noreferrer"
target="_blank"
title="View this pull request on GitHub"
>${event.payload.pull_request.title.escape()}</a></em> in
>${escapeSpecialCharacters(event.payload.pull_request.title)}</a></em> in
`;
case "PullRequestReviewCommentEvent":
@@ -205,7 +195,7 @@ function generateEvent(event) {
rel="noopener noreferrer"
target="_blank"
title="View this comment on GitHub"
>${event.payload.pull_request.title.escape()}</a></em> in
>${escapeSpecialCharacters(event.payload.pull_request.title)}</a></em> in
`;
case "PushEvent":
@@ -346,6 +336,9 @@ function updateGithubFeed() {
const eventString = JSON.stringify(item);
client.zrank("events", eventString, (err, reply) => {
if (err)
return;
if (reply === null)
client.zadd("events", item.id, eventString, callback);
else
@@ -366,6 +359,16 @@ function updateGithubFeed() {
// H E L P E R
function escapeSpecialCharacters(contentToEscape) {
const tagsToReplace = {
"&": "&amp;",
"<": "&lt;",
">": "&gt;"
};
return contentToEscape.replace(/[&<>]/g, tag => tagsToReplace[tag] || tag);
}
function refToBranch(ref) {
if (ref)
return ref.replace("refs/heads/", "");
+113
View File
@@ -0,0 +1,113 @@
"use strict";
import messageSlack from "./slack";
const request = require("request");
const addSupport = function() {};
const publish = function() {};
const resolve = function(urls) {
return new Promise(function(resolve, reject) {
const options = {
method: "POST",
url: "https://api.lbry.tv/api/v1/proxy",
headers:
{
"Content-Type": "application/json"
},
body: {
method: "resolve",
params: { urls: urls }
},
json: true
};
request(options, function(error, response, daemonResponse) {
if (error) {
messageSlack({
message: "```" + error + "```",
title: "DAEMON ERROR: resolve"
});
return reject(new Error("DAEMON ERROR: resolve"));
}
if (Object.prototype.hasOwnProperty.call(daemonResponse, "error")) {
messageSlack({
message: "```" + daemonResponse.error + "```",
title: "DAEMON ERROR: resolve"
});
return reject(new Error("DAEMON ERROR: resolve"));
} else
return resolve(daemonResponse.result);
});
});
};
const getTrending = function() {
return new Promise(function(resolve, reject) {
const options = {
method: "POST",
url: "https://api.lbry.tv/api/v1/proxy",
headers:
{
"Content-Type": "application/json"
},
body:
{
method: "claim_search",
params:
{
page_size: 20,
page: 1,
no_totals: true,
any_tags:
["art",
"automotive",
"blockchain",
"comedy",
"economics",
"education",
"gaming",
"music",
"news",
"science",
"sports",
"technology"],
channel_ids: [],
not_channel_ids: [],
not_tags: ["porn", "nsfw", "mature", "xxx"],
order_by: ["trending_group", "trending_mixed"]
}
},
json: true
};
request(options, function(error, response, daemonResponse) {
if (error) {
messageSlack({
message: "```" + error + "```",
title: "DAEMON ERROR: trending"
});
return reject(new Error("DAEMON ERROR: trending"));
}
if (Object.prototype.hasOwnProperty.call(daemonResponse, "error")) {
messageSlack({
message: "```" + daemonResponse.error + "```",
title: "DAEMON ERROR: trending"
});
return reject(JSON.stringify(daemonResponse));
} else
return resolve(daemonResponse.result.items);
});
});
};
export default {
addSupport,
publish,
resolve,
getTrending
};
+15 -2
View File
@@ -4,7 +4,7 @@
// P A C K A G E S
import color from "colorette";
import * as color from "colorette";
import compress from "fastify-compress";
import cors from "cors";
import fastify from "fastify";
@@ -22,7 +22,20 @@ import redirects from "~data/redirects.json";
const server = fastify({
logger: {
level: "warn",
prettyPrint: process.env.NODE_ENV === "development" ? true : false
prettyPrint: process.env.NODE_ENV === "development",
redact: ["req.headers.authorization"],
serializers: {
req(req) {
return {
headers: req.headers,
hostname: req.hostname,
method: req.method,
remoteAddress: req.ip,
remotePort: req.connection.remotePort,
url: req.url
};
}
}
}
});
+13 -11
View File
@@ -16,16 +16,20 @@ function superscript(state, silent) {
const max = state.posMax;
const start = state.pos;
let found;
let content;
let token;
if (state.src.charCodeAt(start) !== 0x5E/* ^ */) return false;
if (silent) return false; // do not run pairs in validation mode
if (start + 2 >= max) return false;
if (state.src.charCodeAt(start) !== 0x5E/* ^ */)
return false;
if (silent)
return false; // do not run pairs in validation mode
if (start + 2 >= max)
return false;
state.pos = start + 1;
while (state.pos < max) {
while(state.pos < max) {
if (state.src.charCodeAt(state.pos) === 0x5E/* ^ */) {
found = true;
break;
@@ -39,7 +43,7 @@ function superscript(state, silent) {
return false;
}
content = state.src.slice(start + 1, state.pos);
const content = state.src.slice(start + 1, state.pos);
// do not allow unescaped spaces/newlines inside
if (content.match(/(^|[^\\])(\\\\)*\s/)) {
@@ -59,16 +63,14 @@ function superscript(state, silent) {
if (content.match(regexForIds)) {
const theLink = supText.match(regexForIds)[0].replace("(#", "").replace(")", "");
token.attrPush([ "id", theLink ]);
token.attrPush(["id", theLink]); // eslint-disable-line padding-line-between-statements
}
token = state.push("text", "", 0);
if (content.match(regexForIds)) {
const theText = supText.match(regexForTextBeforeLink)[0];
token.content = theText;
token.content = theText; // eslint-disable-line padding-line-between-statements
} else token.content = supText;
token = state.push("sup_close", "sup", -1);
@@ -84,6 +86,6 @@ function superscript(state, silent) {
// E X P O R T
module.exports = exports = function sup_plugin(md) {
module.exports = exports = function sup_plugin(md) { // eslint-disable-line camelcase
md.inline.ruler.after("emphasis", "sup", superscript);
};
+17 -19
View File
@@ -4,7 +4,7 @@
// P R O G R A M
const relativeDate = (undefined => {
const relativeDate = (() => {
const SECOND = 1000;
const MINUTE = 60 * SECOND;
const HOUR = 60 * MINUTE;
@@ -14,23 +14,23 @@ const relativeDate = (undefined => {
const MONTH = YEAR / 12;
const formats = [
[ 0.7 * MINUTE, "just now" ],
[ 1.5 * MINUTE, "a minute ago" ],
[ 60 * MINUTE, "minutes ago", MINUTE ],
[ 1.5 * HOUR, "an hour ago" ],
[ DAY, "hours ago", HOUR ],
[ 2 * DAY, "yesterday" ],
[ 7 * DAY, "days ago", DAY ],
[ 1.5 * WEEK, "a week ago" ],
[ MONTH, "weeks ago", WEEK ],
[ 1.5 * MONTH, "a month ago" ],
[ YEAR, "months ago", MONTH ],
[ 1.5 * YEAR, "a year ago" ],
[ Number.MAX_VALUE, "years ago", YEAR ]
[0.7 * MINUTE, "just now"],
[1.5 * MINUTE, "a minute ago"],
[60 * MINUTE, "minutes ago", MINUTE],
[1.5 * HOUR, "an hour ago"],
[DAY, "hours ago", HOUR],
[2 * DAY, "yesterday"],
[7 * DAY, "days ago", DAY],
[1.5 * WEEK, "a week ago"],
[MONTH, "weeks ago", WEEK],
[1.5 * MONTH, "a month ago"],
[YEAR, "months ago", MONTH],
[1.5 * YEAR, "a year ago"],
[Number.MAX_VALUE, "years ago", YEAR]
];
function relativeDate(input, reference) {
!reference && (reference = (new Date).getTime());
!reference && (reference = (new Date()).getTime());
reference instanceof Date && (reference = reference.getTime());
input instanceof Date && (input = input.getTime());
@@ -40,9 +40,8 @@ const relativeDate = (undefined => {
for (let i = -1; ++i < len;) {
const format = formats[i];
if (delta < format[0]) {
if (delta < format[0])
return format[2] === undefined ? format[1] : Math.round(delta / format[2]) + " " + format[1];
}
}
}
@@ -53,6 +52,5 @@ const relativeDate = (undefined => {
// E X P O R T
if (typeof module !== "undefined" && module.exports) {
if (typeof module !== "undefined" && module.exports)
module.exports = exports = relativeDate;
}
+14 -2
View File
@@ -55,15 +55,27 @@
}
}
.api-toc__select,
.api-toc__search-field {
width: 100%;
border-top: none;
border-right: none;
border-bottom: 1px solid $lbry-gray-1;
border-left: none;
}
.api-toc__select {
background-position-x: 95%;
}
.api-toc__search {
position: relative;
}
.api-toc__search-field {
width: 100%;
padding: 0.25rem calc(2rem + 4px) 0.25rem 0.75rem;
border-bottom: 1px solid $lbry-gray-1;
border-radius: 0; // TODO: Put this rule in components on inputs
font-size: 0.8rem;
line-height: 2rem;
+15
View File
@@ -3,6 +3,21 @@ developer-program {
input-submit {
padding-top: 0.5rem;
button {
color: $lbry-white;
padding-right: 1.5rem;
padding-left: 1.5rem;
transition: background-color 0.2s;
&:not(:hover) {
background-color: $lbry-black;
}
&:hover {
background-color: $lbry-teal-4;
}
}
}
.button {
+4 -2
View File
@@ -265,6 +265,7 @@
}
.playground-content__urlbar {
height: 2.5rem;
border: 1px solid $lbry-gray-1;
display: flex;
margin-bottom: 1rem;
@@ -289,6 +290,7 @@
input {
width: calc(100% - 9.5rem);
border: none;
font-size: 1rem;
&::placeholder {
@@ -299,12 +301,12 @@
span {
@include no-user-select;
width: 3.5rem;
width: 3.5rem; height: 2.5rem;
color: $lbry-gray-4;
cursor: default;
font-size: 1rem;
line-height: 2rem;
line-height: 2.4;
text-align: right;
}
}
+104 -96
View File
@@ -9,9 +9,12 @@ import html from "choo/html";
// U T I L S
import apiPage from "~view/api";
import fetchMetadata from "~helper/fetch-metadata";
import lbrytvAPI from "~helper/lbrytv-sdk";
import { generateGitHubFeed } from "~helper/github";
import messageSlack from "~helper/slack";
import { URL } from "url";
const githubAppId = process.env.GITHUB_APP_ID;
const githubAppSecret = process.env.GITHUB_APP_SECRET;
@@ -23,7 +26,7 @@ const githubAppSecret = process.env.GITHUB_APP_SECRET;
// P R O G R A M
export default (socket, action) => {
export default async(socket, action) => {
if (typeof socket !== "object" && typeof action !== "object")
return;
@@ -88,6 +91,22 @@ export default (socket, action) => {
newsletterSubscribe(action, socket);
break;
case action.message === "view different documentation version":
send(socket, {
element: "div",
html: await apiPage({
params: {
wildcard: action.version.split("-")[0]
},
tag: action.version.split("-")[1]
}),
message: "replace html",
parentElement: "main",
selector: ".__slate"
});
break;
default:
break;
}
@@ -99,56 +118,56 @@ export default (socket, action) => {
function generateContent(exampleNumber, displayTrendingContent) {
if (exampleNumber === 1) {
return getTrendingContent().then(response => {
if (!response || !response.success || response.success !== true || !response.data)
return "";
return lbrytvAPI.getTrending()
.then(response => {
const renderedContentCollection = [];
const urlsToResolve = [];
const rawContentCollection = [];
const renderedContentCollection = [];
const trendingContentData = response.data;
response.forEach(r => {
urlsToResolve.push(r.canonical_url);
});
lbrytvAPI.resolve(urlsToResolve)
.then(resolveResponse => {
if (resolveResponse !== null) {
const responses = Object.values(resolveResponse);
for (const data of trendingContentData)
rawContentCollection.push(fetchMetadata({
claim: data.url,
example: exampleNumber,
method: "resolve"
}));
for (const r in responses) {
const part = responses[r];
Promise.all(rawContentCollection).then(collection => {
for (const part of collection) {
try {
if (part.value && part.value.thumbnail.url) {
renderedContentCollection.push(`
<section class="playground-content__trend">
<figure
class="media__thumb"
data-action="choose claim"
data-claim-id="${part.claim_id}"
data-name=${part.name}
style="background-image: url(${makeImageSourceSecure(part.value.thumbnail.url)})">
</figure>
<div class="media__title">
${part.value.title || "Untitled"}
</div>
<div class="media__subtitle">
${part.signing_channel ? part.signing_channel.name : "Anon"}
</div>
</section>
`);
}
}
}
renderedContentCollection.push(`
<section class="playground-content__trend">
<figure
class="media__thumb"
data-action="choose claim"
data-claim-id="${part.name}"
${part.value.thumbnail.url.length ? `style="background-image: url(${makeImageSourceSecure(part.value.thumbnail.url)})"` : ""}
></figure>
<div class="media__title">
${part.value.title}
</div>
<div class="media__subtitle">
${part.channel_name}
</div>
</section>
`);
} catch(err) {
return; // TODO: Return nice error message
}
}
renderedContentCollection.push(`
<script>
document.getElementById("playground-example-description").innerHTML = document.querySelector("[data-action='playground, example 1']").dataset.description
</script>
`);
displayTrendingContent(renderedContentCollection.join(""));
<script>
document.getElementById("playground-example-description").innerHTML = document.querySelector("[data-action='playground, example 1']").dataset.description
</script>
`);
displayTrendingContent(renderedContentCollection.join(""));
})
.catch(error => {
console.error(error);
});
});
});
}
if (exampleNumber === 3) {
@@ -164,51 +183,49 @@ function generateContent(exampleNumber, displayTrendingContent) {
"minecraft-in-real-life-iron-man#758dd6497cdfc401ae1f25984738d024d47b50af",
"ethan-shows-kyle-warframe-skyvault#8a7401b88d5ed0376d98f16808194d4dcb05b284"
];
const rawContentCollection = [];
const renderedContentCollection = [];
for (const url of approvedUrls)
rawContentCollection.push(fetchMetadata({ claim: url, method: "resolve", example: 1 }));
lbrytvAPI.resolve(approvedUrls)
.then(resolveResponse => {
if (resolveResponse !== null) {
const responses = Object.values(resolveResponse);
return Promise.all(rawContentCollection).then(collection => {
for (const part of collection) {
if (
part &&
part.value &&
part.value.thumbnail.url &&
part.channel_name
) {
renderedContentCollection.push(`
<section class="playground-content__trend">
<figure
class="media__thumb"
data-action="choose claim"
data-claim-id="${part.claim_id}"
data-name=${part.name}
style="background-image: url(${makeImageSourceSecure(part.value.thumbnail.url)})">
</figure>
for (const r in responses) {
const part = responses[r];
<div class="media__title">
${part.value.title}
</div>
<div class="media__subtitle">
${part.channel_name}
</div>
</section>
`);
if (part.value && part.value.thumbnail.url) {
renderedContentCollection.push(`
<section class="playground-content__trend">
<figure
class="media__thumb"
data-action="choose claim"
data-claim-id="${part.claim_id}"
data-name=${part.name}
style="background-image: url(${makeImageSourceSecure(part.value.thumbnail.url)})">
</figure>
<div class="media__title">
${part.value.title || "Untitled"}
</div>
<div class="media__subtitle">
${part.signing_channel ? part.signing_channel.name : "Anon"}
</div>
</section>
`);
}
}
}
}
renderedContentCollection.push(`
<script>
document.getElementById("playground-example-description").innerHTML = document.querySelector("[data-action='playground, example 3']").dataset.description
</script>
`);
displayTrendingContent(renderedContentCollection.join(""));
});
renderedContentCollection.push(`
<script>
document.getElementById("playground-example-description").innerHTML = document.querySelector("[data-action='playground, example 3']").dataset.description
</script>
`);
displayTrendingContent(renderedContentCollection.join(""));
})
.catch(error => {
console.error(error);
});
}
}
@@ -349,15 +366,6 @@ function getGitHubUserToken(socket) {
});
}
async function getTrendingContent() {
try {
const response = await got("https://api.lbry.com/file/list_trending");
return JSON.parse(response.body); // eslint-disable-line padding-line-between-statements
} catch(error) {
return error;
}
}
function makeImageSourceSecure(url) {
if (!url || !url.length)
return url;
@@ -434,7 +442,7 @@ async function verifyGitHubToken(data, socket) {
const code = data.code;
try {
let result = await got.post(`https://github.com/login/oauth/access_token?client_id=${githubAppId}&client_secret=${githubAppSecret}&code=${code}`, { json: true });
const result = await got.post(`https://github.com/login/oauth/access_token?client_id=${githubAppId}&client_secret=${githubAppSecret}&code=${code}`, { json: true });
const response = {
address: data.address,
+119 -39
View File
@@ -7,6 +7,7 @@
import asyncHtml from "choo-async/html";
import dedent from "dedent";
import got from "got";
import Octokit from "@octokit/rest";
// U T I L S
@@ -14,31 +15,45 @@ import headerBlockchain from "~component/api/header-blockchain";
import headerSdk from "~component/api/header-sdk";
import redirects from "~data/redirects.json";
const blockchainApi = "https://raw.githubusercontent.com/lbryio/lbrycrd/master/contrib/devtools/generated/api_v1.json";
const cache = new Map();
const sdkApi = "https://raw.githubusercontent.com/lbryio/lbry/master/docs/api.json";
const filePathBlockchain = "/contrib/devtools/generated/api_v1.json";
const filePathSdk = "/docs/api.json";
const rawGitHubBase = "https://raw.githubusercontent.com/lbryio/";
const octokit = new Octokit({
auth: `token ${process.env.GITHUB_OAUTH_TOKEN}`
});
// E X P O R T
export default async(state) => {
// below is evil, I just inherited it -- Jeremy
const apilabel = state.params.wildcard === "sdk" ?
"SDK" :
state.params.wildcard.charAt(0).toLocaleUpperCase() + state.params.wildcard.substring(1);
const { tag } = state;
const { wildcard } = state.params;
const repository = wildcard === "sdk" ?
"lbry-sdk" :
"lbrycrd";
state.lbry = {
title: apilabel + " API Documentation",
description: "See API documentation, signatures, and sample calls for the LBRY " + apilabel + " APIs."
title: tag ? tag + " API Documentation" : "API Documentation",
description: "See API documentation, signatures, and sample calls for the LBRY APIs."
};
const tags = await getTags(repository);
const currentTag = tag && tag.length ? tag : tags[0];
try {
const apiResponse = await parseApiFile(state.params.wildcard);
const apiResponse = await parseApiFile({ repo: repository, tag: currentTag });
return asyncHtml`
<div class="__slate">
<aside class="api-toc">
<select class="api-toc__select" onchange="changeDocumentationVersion(value);">
${renderVersionSelector(wildcard, tags, tag)}
</select>
<div class="api-toc__search">
<input class="api-toc__search-field" id="input-search" placeholder="Search" type="search"/>
<div class="api-toc__search-clear" id="clear-search" title="Clear search query">&times;</div>
@@ -46,35 +61,37 @@ export default async(state) => {
</div>
<ul class="api-toc__commands" id="toc" role="navigation">
${apilabel === "SDK" ? createSdkSidebar(apiResponse) : createApiSidebar(apiResponse)}
${wildcard === "sdk" ? createSdkSidebar(apiResponse) : createApiSidebar(apiResponse)}
</ul>
</aside>
<section class="api-content">
<div class="api-documentation" id="toc-content">
<div></div>
<nav class="api-content__items">
${renderToggles(apilabel === "SDK")}
${renderCodeLanguageToggles(wildcard)}
</nav>
${createApiHeader(state.params.wildcard)}
${apilabel === "SDK" ? createSdkContent(apiResponse) : createApiContent(apiResponse)}
${createApiHeader(wildcard, currentTag)}
${wildcard === "sdk" ? createSdkContent(apiResponse) : createApiContent(apiResponse)}
</div>
</section>
<script src="/assets/scripts/plugins/jets.js"></script>
<script src="/assets/scripts/api.js"></script>
<script>
initializeApiFunctionality();
if (window.location.pathname === "/api/blockchain")
document.getElementById("toggle-cli").click();
else
document.getElementById("toggle-curl").click();
</script>
</div>
<script src="/assets/scripts/plugins/jets.js"></script>
<script src="/assets/scripts/api.js"></script>
<script>
if (window.location.pathname === "/api/blockchain")
document.getElementById("toggle-cli").click();
else
document.getElementById("toggle-curl").click();
</script>
`;
}
catch(error) {
} catch(error) {
const redirectUrl = redirects[state.href];
return asyncHtml`
@@ -134,13 +151,13 @@ function createApiContent(apiDetails) {
return apiContent;
}
function createApiHeader(slug) {
function createApiHeader(slug, apiVersion) {
switch(slug) {
case "blockchain":
return headerBlockchain();
return headerBlockchain(apiVersion);
case "sdk":
return headerSdk();
return headerSdk(apiVersion);
default:
break;
@@ -220,24 +237,61 @@ function createSdkSidebar(apiDetails) {
return apiSidebar;
}
async function parseApiFile(urlSlug) {
let apiFileLink;
async function getTags(repositoryName) {
const { data } = await octokit.repos.listTags({
owner: "lbryio",
repo: repositoryName
});
const tags = ["master"];
// NOTE:
// The versioning in our repos do not make sense so extra
// exclusion code is needed to make this work.
//
// Documentation is only available after specific versions.
switch(true) {
case (urlSlug === "blockchain"):
apiFileLink = blockchainApi;
case repositoryName === "lbry-sdk":
data.forEach(tag => {
if (tag.name >= "v0.52.0") tags.push(tag.name);
});
break;
case (urlSlug === "sdk"):
apiFileLink = sdkApi;
case repositoryName === "lbrycrd":
data.forEach(tag => {
if (
tag.name >= "v0.17.1.0" &&
tag.name !== "v0.3.16" &&
tag.name !== "v0.3.15" &&
tag.name !== "v0.3-osx" &&
tag.name !== "v0.2-alpha"
) tags.push(tag.name);
});
break;
default:
break;
}
if (!apiFileLink)
return Promise.reject(new Error("Failed to fetch API docs"));
return tags;
}
async function parseApiFile({ repo, tag }) {
let apiFileLink = `${rawGitHubBase}${repo}/${tag}`;
switch(true) {
case (repo === "lbrycrd"):
apiFileLink = `${apiFileLink}${filePathBlockchain}`;
break;
case (repo === "lbry-sdk"):
apiFileLink = `${apiFileLink}${filePathSdk}`;
break;
default:
return Promise.reject(new Error("Failed to fetch API docs"));
}
const response = await got(apiFileLink, { cache, json: true });
@@ -259,7 +313,7 @@ function renderArguments(args) {
<li class="api-content__body-argument">
<div class="left">
<strong>${arg.name}</strong><br/>
${arg.is_required === true ? "" : "<span>optional</span>" }<span>${arg.type}</span>
${arg.is_required === true ? "" : "<span>optional</span>"}<span>${arg.type}</span>
</div>
<div class="right">${typeof arg.description === "string" ? arg.description.replace(/</g, "&lt;").replace(/>/g, "&gt;") : ""}</div>
@@ -307,7 +361,33 @@ function renderReturns(args) {
return returnContent;
}
function renderToggles(onSdkPage) {
function renderVersionSelector(pageSlug, versions, desiredTag) {
const options = [
"<option disabled>Select a version</option>"
];
let optionIndex = 0;
versions.forEach(version => {
optionIndex++;
let selectedOption = false;
if (desiredTag && desiredTag === version)
selectedOption = true;
else if (optionIndex === 1)
selectedOption = true;
options.push(
`<option value="${pageSlug}-${version}"${selectedOption ? " selected" : ""}>${version}</option>`
);
});
return options;
}
function renderCodeLanguageToggles(pageSlug) {
const onSdkPage = pageSlug === "sdk";
return [
"<button class='api-content__item menu' id='toggle-menu'>menu</button>",
!onSdkPage ? "<button class='api-content__item' id='toggle-cli' type='button'>cli</button>" : "",
+1 -1
View File
@@ -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>
+1 -1
View File
@@ -37,7 +37,7 @@ export default (state, emit) => { // eslint-disable-line
const customMetadata = {};
for (const key in markdownFileDetails.attributes.meta) {
if (markdownFileDetails.attributes.meta.hasOwnProperty(key)) {
if (Object.prototype.hasOwnProperty.call(markdownFileDetails.attributes.meta, key)) {
customMetadata[Object.keys(markdownFileDetails.attributes.meta[key])[0]] =
markdownFileDetails.attributes.meta[key][Object.keys(markdownFileDetails.attributes.meta[key])[0]];
}
+6 -6
View File
@@ -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:
@@ -179,9 +179,9 @@ We do not currently have tooling available to build LBRY apps on iOS.
### SDK
The [LBRY SDK](https://github.com/lbryio/lbry) provides an API that enables easy access to all functionality of the LBRY network. Most applications will choose to use the SDK.
The [LBRY SDK](https://github.com/lbryio/lbry-sdk) provides an API that enables easy access to all functionality of the LBRY network. Most applications will choose to use the SDK.
You can download the latest version from the [releases page](https://github.com/lbryio/lbry/releases) or via the following URLs, which will always download the latest SDK for each operating system:
You can download the latest version from the [releases page](https://github.com/lbryio/lbry-sdk/releases) or via the following URLs, which will always download the latest SDK for each operating system:
| OS | URL |
| --- | --- |
@@ -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.
+14 -12
View File
@@ -22,25 +22,23 @@ 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) | 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/torba) | Python | An [[SPV]] (Simple Payment Verification) wallet. Bundled with [[lbry-sdk]].
| [wallet server](https://github.com/lbryio/lbry/tree/master/lbrynet/extras/wallet/server) | Protobuf, Python | The wallet server used by [[torba]]. | |
| [schema](https://github.com/lbryio/lbry/tree/master/lbrynet/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
--- | --- | --- | ---
| [lbry-desktop](https://github.com/lbryio/lbry-desktop) | JavaScript (ReactJS, Electron) | A graphical browser for the LBRY network for Windows, macOS, and Linux. [[lbry-desktop]] is built with [[lbry-sdk]]. | [Video](/resources/video-lbrydesktop)
| [lbry-android](https://github.com/lbryio/lbry-android) | JavaScript (ReactNative), Python (kivy) | A graphical browser for the LBRY network for Android. [[lbry-android]] is built with [[lbry-sdk]]. | [Video](/resources/video-lbryandroid)
| [lbry-desktop](https://github.com/lbryio/lbry-desktop) (and lbry.tv) | JavaScript (ReactJS, Electron) | A desktop browser for the LBRY network for Windows, macOS, and Linux as well as a web interface on lbry.tv. [[lbry-desktop]] is built with [[lbry-sdk]]. | [Video](/resources/video-lbrydesktop)
| [lbry-android](https://github.com/lbryio/lbry-android) | Java | A graphical browser for the LBRY network for Android. [[lbry-android]] uses [[lbry-sdk]] to interact with the network. | [Video](/resources/video-lbryandroid)
| [odysee-ios](https://github.com/lbryio/odysee-ios) | Swift | The Odysee IOS app. | |
| [lbry-redux](https://github.com/lbryio/lbry-redux) | JavaScript (Redux) | A common codebase for shared Redux logic between [[lbry-desktop]] and [[lbry-android]]. | |
| [spee.ch](https://github.com/lbryio/spee.ch) | JavaScript (Node, ReactJS, Express) | A web-based host for free LBRY content. Usable directly as a content link dump site or as a customized, standalone install. | |
| [lbrytv](https://github.com/lbryio/lbrytv) | Go | An API server for https://lbry.tv and https://odysee.com that reimplements some of the SDK APIs. | |
### Websites
| Domain | Language (Toolset) | What Is It
--- | --- | ---
| [lbry.tech](https://github.com/lbryio/lbry.tech) | JavaScript (Node, Choo) | You're on it.
| [lbry.com](https://github.com/lbryio/lbry.com) | PHP (vanilla) | A website for LBRY end-users and creators.
| [lbry.fund](https://github.com/lbryio/lbry.fund) | HTML | A website for receiving funding from LBRY, Inc.
### Auxiliary Services and Applications
| Domain | Language (Toolset) | What Is It
@@ -68,7 +66,7 @@ Several hundred extremely good-looking, wise and moral people, as well as our CT
Web and application designers are requested to be able to work directly on CSS in the project they'd be contributing to. Please follow the [Coding](#coding) instructions for any website or application you want to improve.
We're happy to provide assistance if you're used to working in HTMl and CSS but are having trouble getting started. Check out [our chat](https://chat.lbry.com) or [our forum](https://discourse.lbry.com).
We're happy to provide assistance if you're used to working in HTML and CSS but are having trouble getting started. Check out [our chat](https://chat.lbry.com) or [our forum](https://discourse.lbry.com).
## Writing
@@ -78,6 +76,10 @@ Most written content, and especially all technical writing, is checked into sour
1. Search for a quoted phrase of the content you want to change (or use the same technique to identify the folder to create a new document in).
1. Edit the content via the GitHub interface and submit it as a pull request.
### Translating
Translation work is primarily organized through the [LBRY Foundation](https://lbry.org). For the current instructions on participating, see [their article](http://wiki.lbry.org/Translations).
## Testing
If you want to contribute without getting directly into the code, one of the best ways you can contribute is testing.
@@ -88,7 +90,7 @@ A number of our code bases ([[lbrycrd]], [[lbry-sdk]], all applications, more...
- "Watch" the repo on GitHub. You will receive an email with release notes whenever a release candidate is out and you can [raise an issue](#raising-issues).
- Join the #early-testing channel in our [chat](https://chat.lbry.com).
- For the hardcore, run master from source and/or the latest builds from [build.lbry.com](http://build.lbry.com).
- For the hardcore, run master from source and/or the latest builds from [build.lbry.io](http://build.lbry.io).
Opening well-specified issues against release candidates or master builds is extremely useful in helping us create quality software.
@@ -105,7 +107,7 @@ If you're about to raise an issue because you've found a problem with LBRY, or y
A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
1. **Identify the correct repo**. See [ecosystem overview](#ecosystem-overview). While it's okay if you get this wrong, it's a big help to us if you get it right.
1. **Identify the correct repo**. See [repository overview](#repository-overview). While it's okay if you get this wrong, it's a big help to us if you get it right.
2. **Check if the issue exists**. Please do a quick search to see if the issue has been reported (or fixed), including closed tickets.
3. **Follow the instructions** - When you open an issue inside of GitHub, each repo contains a template for how to create a good bug report. Santa _loves_ people who follow it.
@@ -115,7 +117,7 @@ Well-specified bug reports save developers lots of time and are [appreciated](#a
Feature requests are welcome. Before you submit one be sure to:
1. **Identify the correct repo**. See [ecosystem overview](#ecosystem-overview).
1. **Identify the correct repo**. See [repository overview](#repository-overview).
2. **Use the Github Issues search** and check the feature hasn't already been requested. Be sure to include closed tickets.
3. **Consider whether it's feasible** for us to tackle this feature in the next 6-12 months. The LBRY team is currently stretched thin just adding basic functionality. If this is a nice to have rather than a need, it is probably more clutter than helpful.
4. **Make a strong case** to convince the project's leaders of the merits of this feature. Please provide as much detail and context as possible. This means explaining the use case and why it is likely to be common.
+1 -9
View File
@@ -2,12 +2,4 @@
title: Developer Program
---
LBRY offers a complimentary 100 LBC to qualified engineers to facilitate exploration, development, and testing.
To qualify you must:
- have a GitHub account that is at least 90 days old and
- have an active commit history
### Claim LBC
<DeveloperProgram/>
This has been disabled at the request of GitHub. We're exploring alternative mechanisms to validate that you are a developer.
+15 -7
View File
@@ -11,7 +11,7 @@ We encourage the submission of changes and additions to this glossary.
### Blob
The smallest unit of data in LBRY. Each blob is referenced by its [blob hash](#blob-hash), a SHA-384 hash of the blob contents. When files are uploaded to LBRY, they are split into blobs, which are then shared with other peers. See [Encoding](/spec#encoding) for more details.
The smallest unit of data in LBRY. Each blob is referenced by its [blob hash](#blob-hash), an SHA-384 hash of the blob contents. When files are uploaded to LBRY, they are split into blobs, which are then shared with other peers. See [Encoding](/spec#encoding) for more details.
### Blob Exchange Protocol
@@ -39,7 +39,11 @@ The sequence number of a block in the blockchain. The first block is at height 0
### Blockchain
An open, distributed ledger that records transactions in a verifiable and change-resistant way. The LBRY blockchain serves as an index of the content available on the network, a payment system and record of purchases for priced content, and a source if cryptographic publisher identities.
An open, distributed ledger that records transactions in a verifiable and change-resistant way. The LBRY blockchain serves as an index of the content available on the network, a payment system and record of purchases for priced content, and a source of cryptographic publisher identities.
### Canonical URL
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
@@ -110,7 +114,7 @@ A change to the consensus rules such that a block that would have been considere
### Hashrate
A measure of mining hardware performance expressed in hashes per second (GH/s). Click [here](https://www.tokens24.com/cryptopedia/basics/bitcoin-hash-rate) for more details.
A measure of mining hardware performance expressed in hashes per second (H/s). Click [here](https://www.tokens24.com/cryptopedia/basics/bitcoin-hash-rate) for more details.
### LBC
@@ -128,7 +132,7 @@ The SDK is three things:
- components that are not part of the spec but are useful for developing applications using the protocol
- a daemon that participates in the LBRY data network and provides an API for interacting with the protocol
See [the source code](https://github.com/lbryio/lbry) or [the API documentation](/api/sdk).
See [the source code](https://github.com/lbryio/lbry-sdk) or [the API documentation](/api/sdk).
### LBRY Credits
@@ -172,7 +176,7 @@ A file included with each LBRY project that contains basic information about tha
A long-running node that accepts blobs for upload and rehosts them on the network.
### Resolve (or URL Resolution)
### Resolve (or URL Resolution) {#resolve}
The process of translating a URL into the associated claim ID and metadata. See [Resolution](/spec#resolution) for details.
@@ -184,6 +188,10 @@ A definition of the structure of the metadata that is stored in claims in the bl
A scheme to validate transactions without storing the whole blockchain.
### Short URL
The shortest [URL](https://spec.lbry.com/#urls), not including the [channel](#channel), that will [resolve](#resolve) to the correct claim (i.e. lbry://cats#c, returning lbry://cats#ca43e2b6db155177564e574b09dfedc7588816ef or lbry://@cats#0 returning lbry://@cats#0893dbed95307c4b27aadbcb1cc6cb593810b3f9). This is determined on a first come, first serve basis on claim id collisions. A short URL with more than one identifier may change to include only a single identifier if the previous claim, which had the single identifier, is deleted.
### SPV
SPV is an abbreviation for [Simplified Payment Verification](#simplified-payment-verification).
@@ -218,7 +226,7 @@ A parallel LBRY blockchain, used for testing and development. Testnet is like [m
### Torba
An [SPV](#spv) wallet for the [blockchain](#blockchain). See the [source code](https://github.com/lbryio/torba).
An [SPV](#spv) wallet for the [blockchain](#blockchain). See the [source code](https://github.com/lbryio/lbry-sdk).
### Transaction
@@ -230,5 +238,5 @@ The fee paid to a miner for including a transaction in a block. Miners are incen
### Wallet
An application or a service that stores private keys and generates and signs transactions. Wallets do not store LBRY credits themselves (those are recorded as transactions in the global blockchain). "Storing LBC" usually means storing the private keys that control the credits.
An application or a service that stores private keys and generates and signs transactions. Wallets do not store LBRY Credits themselves (those are recorded as transactions in the global blockchain). "Storing LBC" usually means storing the private keys that control the credits.
-2
View File
@@ -11,8 +11,6 @@ What if anyone in the world could publish digital content, anyone else in the wo
That's a fancy sentence, so here's a plain one: we thought it'd be *damn **cool*** if there was a system that made it easy to discover and distribute as much of the world's information as possible but was owned and controlled by no one.
If you agree with us, feel free to join our [Developer Program](/developer-program) and we'll set you up with 100 LBC to get started.
<sub>^1(#footnote-1)^ In the information theoretic sense, LBRY facilitates distribution of all data, whether it be a video or a spreadsheet.</sub>
<sub>^2(#footnote-2)^ Accessible anywhere in the world on any internet-connected device.</sub>
+2 -2
View File
@@ -2,11 +2,11 @@ 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.
Data network operations are provided by the [lbrysdk](https://github.com/lbryio/lbry). This SDK also provides local wallet functionality and a set of APIs to facilitate building applications.
Data network operations are provided by the [lbrysdk](https://github.com/lbryio/lbry-sdk). This SDK also provides local wallet functionality and a set of APIs to facilitate building applications.
### Additional Resources
+2 -1
View File
@@ -17,4 +17,5 @@ description: Find the LBRY specification, API documentation, our Contributor's g
- [Claim Signing](/resources/claim-signing)
- [Regtest Setup](/resources/regtest-setup)
- [LBRY Android App Build Steps](/resources/android-build)
- [Lighthouse (search) API](https://lbryio.github.io/lighthouse)
- [Lighthouse (search) API](https://github.com/lbryio/lighthouse)
- [Run Your Own Wallet Server](/resources/wallet-server)
+3 -5
View File
@@ -4,7 +4,7 @@ description: Step-by-step build instructions for the LBRY Android App
---
### Introduction
This guide provides step-by-step instructions to setup and build the [LBRY Android App](https://lbry.com/android) for development purposes.
This guide provides step-by-step instructions to setup and build the [LBRY Android App](https://lbry.com/android) for development purposes.
#### Estimated Time
25 - 40 minutes
@@ -96,7 +96,7 @@ When this is complete, continue to [Building the App](#building-the-app).
After [preparing your environment](#setup-environment), complete the steps below.
##### 1. Install Crystax
Crystax NDK is required for building Python 3.7 for the mobile app and a number of native C / C++ modules and packages used by the app. Run the following commands to download and extract the NDK:
```
@@ -114,19 +114,17 @@ Clone the lbryio/lbry-android git repository:
git clone https://github.com/lbryio/lbry-android
cd lbry-android
cp buildozer.spec.sample buildozer.spec
cp p4a/pythonforandroid/bootstraps/lbry/templates/google-services.sample.json p4a/pythonforandroid/bootstraps/lbry/templates/google-services.json
```
The provided `buildozer.spec.sample` contains defaults provided you followed the environment setup exactly as described. If you altered the steps for your environment or you're encountering build trouble, check `buildozer.spec` to ensure everything is pointing in the right places.
##### 3. Install npm packages
Install the npm packages required for the app's React Native code, and create the app bundle:
Install the npm packages required for the app's React Native code:
```
cd app
npm install
./bundle.sh
cd ..
```
+1 -1
View File
@@ -3,7 +3,7 @@ title: API Wrappers
description: Find LBRY API wrappers for your favorite language.
---
This document contains a comprehensive list of all available API wrappers for the LBRY protocol and blockchain. API wrappers allow for easier integration of the LBRY APIs into your codebase. They still require you to run either the [LBRY protocol](https://github.com/lbryio/lbry) or the [LBRY blockchain](https://github.com/lbryio/lbrycrd).
This document contains a comprehensive list of all available API wrappers for the LBRY protocol and blockchain. API wrappers allow for easier integration of the LBRY APIs into your codebase. They still require you to run either the [LBRY protocol](https://github.com/lbryio/lbry-sdk) or the [LBRY blockchain](https://github.com/lbryio/lbrycrd).
Interested in creating one for a language not shown below? See our [bounties page](https://lbry.com/bounty/lbry-binding) for details.
+1 -1
View File
@@ -72,7 +72,7 @@ Reilly decodes and combines the claim address, the serialized claim value, and t
005a001a41080110011a309b70337f51fe9a4481504059b4220ad4f87378d59ecc87bd924c3f0f23da9442b9f75ffc091b65deefe92477a86a31ea2209766964
656f2f6d70342996b9a087c18456402b57cba6085b2a8fcc136d
Then he takes the sha256 of the combined string, giving:
Then he takes the SHA256 of the combined string, giving:
dea44974ace1893f304cae4073af06a7a6cbb209f97cf8ad5f322216f044304e
+4 -4
View File
@@ -20,14 +20,14 @@ You can read more on it [here](https://en.wikipedia.org/wiki/Trie), but for unde
Each block header holds an extra 256 bits value calculated out of the root node of the claim trie at that block height. It's called `nameclaimroot` and is influenced by all children nodes as we will see next. If a blockchain network peer disagrees that a claim name was accepted or who is the winner of each name, its `nameclaimroot` will differ and the block won't form the same chain as the ones that accepted the official rules. This is the same for the traditional Merkle root, which is the root of the [Merkle tree](https://bitcoin.org/en/glossary/merkle-tree), formed by transactions in a block.
## What's in a leaf?
The leaf currently holds the winner of that name. Its formed by the transaction hash, output number of the claim in that transaction and the height it was accepted.
The leaf currently holds the winner of that name. It's formed by the transaction hash, output number of the claim in that transaction and the height it was accepted.
### Generating the leaf hash
So, let's suppose that the winner claim of `mindblown` name was made at transaction output `1` of the transaction hash `67ad533eb2676c9d36bfa100092af5358de747e08ef928c0c54a8b3891c2b76b` and included in the Trie at height `102`.
1. The transaction hash is converted from [RPC byte order](https://bitcoin.org/en/glossary/rpc-byte-order) to [internal byte order](https://bitcoin.org/en/glossary/internal-byte-order).
2. The output number becomes a simple string.
3. The height becomes a big endian 64 bits value.
4. The node hash is calculated as the double sha-256 hash of the double sha-256 hash of the internal byte order representation of the transaction hash concatenated with the double sha-256 hash of the output number representation concatenated with the double sha-256 hash of the height.
4. The node hash is calculated as the double SHA-256 hash of the double SHA-256 hash of the internal byte order representation of the transaction hash concatenated with the double SHA-256 hash of the output number representation concatenated with the double SHA-256 hash of the height.
This is better represented in the simple python script below:
```python
@@ -54,8 +54,8 @@ print("leaf hash is {}".format(hexlify(hash_leaf(tx, nout, at_height)[::-1])))
Let's start with a ClaimTrie holding a single claim.
The claim is named `mindblown` and was included at block 102 with the same details as the last section. It's actually a real claim as [you can see in the block explorer](https://explorer.lbry.com/blocks/102). This block has the first claim ever, so the ClaimTrie was the simple case being explained in here.
We start with the leaf hash:
1. Hash the leaf hash using double sha-256.
2. For each character of the name (nodes of the trie), the hash of a node is the double sha-256 of the node's character concatenated with the children hash.
1. Hash the leaf hash using double SHA-256.
2. For each character of the name (nodes of the trie), the hash of a node is the double SHA-256 of the node's character concatenated with the children hash.
Continuing with the Python script from the last section, this is how to calculate the root of a claim trie holding a single name:
```python
+2 -2
View File
@@ -5,7 +5,7 @@ description: How does the LBRY blockchain achieve consensus? This resource page
LBRY uses [proof of work](https://en.bitcoin.it/wiki/Proof_of_work) as a [consensus mechanism](/spec#consensus), the same way that Bitcoin does.
LBRY has differences in hash function, block targeting, and difficult adjustment.
LBRY has differences in hash function, block targeting, and difficulty adjustment.
### Hash Mechanism
@@ -18,4 +18,4 @@ proof = sha256(sha256(left + right)) # concatenate the two halves, and double-s
### Block Targeting & Difficulty Adjustment
The targeted time of each Lbry block is 2.5 mintues (150 seconds). More information and links to source code [here](https://lbry.tech/spec#consensus).
The targeted time of each LBRY block is 2.5 mintues (150 seconds). More information and links to source code [here](https://lbry.tech/spec#consensus).
+9 -13
View File
@@ -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/blob/master/lbrynet/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
@@ -12,7 +12,7 @@ The easiest way to configure the settings is by editing the `daemon_settings.yml
Sample daemon_settings.yml file:
```
tcp_port: 3335
lbryum_servers: ['lbryumx1.lbry.com:50001','lbryumx2.lbry.com:50001']
lbryum_servers: ['spv11.lbry.com:50001','spv19.lbry.com:50001']
download_directory: 'c:\lbry\Downloads'
use_upnp: false
```
@@ -33,7 +33,7 @@ Configuration options are organized by their respective areas: Files, Wallet, Ne
| Setting | Format | Default value | Sample Values | Description |
|-------------------------------|---------|------------------------------------------------------|------------------------------------|---------------------------------------------------------------------------------------------------|
| blockchain_name | string | 'lbrycrd_main' | 'lbrycrd_regtest' | Blockchain network to connect to |
| lbryum_servers | list | ['lbryumx1.lbry.com:50001','lbryumx2.lbry.com:50001'] | ["mylbryum.lbry.com:50001] | SPV wallet server address |
| lbryum_servers | list | ['spv11.lbry.com:50001','spv19.lbry.com:50001'] | ["mylbryum.lbry.com:50001] | SPV wallet server address(Default servers are spv11-spv19) |
| wallet_dir | string | [varies by OS](https://lbry.com/faq/lbry-directories) | 'c:\lbry\lbryum\' | Wallet data location |
| max_key_fee | json | {'currency': 'USD', 'amount': 50.0} | {'currency': 'LBC', 'amount': 5.0} | Max payment allowed for content |
| wallet | string | 'lbryum' | 'lbrycrd' | Choice of wallet software, SPV (lbryum) vs full node (lbrycrd). Currently only lbryum supported |
@@ -42,7 +42,8 @@ Configuration options are organized by their respective areas: Files, Wallet, Ne
### Network
| Setting | Format | Default value | Sample Values | Description |
|----------------------------|---------|---------------------------|----------------------------|------------------------------------------------------------------------------------|
| api | string | localhost:5279 | 0:0:0:0:5280 | IP address and port the SDK API will listen on |
| api | string | localhost:5279 | 0:0:0:0:5280 | IP address and port the SDK API will listen on |
| streaming_server | string | localhost:5280 | 0:0:0:0:5280 | IP address and port the media/streaming server will listen on |
| cache_time | integer | 150 | 90 | How long to keep resolve data in cache |
| data_rate | float | 0.0001 | 0.05 | What LBC rate, per MB, to offer DHT data at (currently disabled in the protocol) |
| udp_port | integer | 4444 | 4445 | UDP port used to announce blobs |
@@ -62,16 +63,11 @@ Configuration options are organized by their respective areas: Files, Wallet, Ne
| node_rpc_timeout | integer | 5 | 10 | Time, in seconds, to allow connection over DHT |
| network_interface | string | 0:0:0:0 | 127.0.0.1 | Interface to use for the DHT and blob exchange |
| use_upnp | boolean | true | false | Attempt external port mapping via UPnP |
### Security
| Setting | Format | Default value | Sample Values | Description |
|----------------|---------|---------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------|
| allowed_origin | string | '' | '*' or localhost | IP address to allow API requests from |
| use_auth_http | boolean | false | true | See [authentication instructions](https://github.com/lbryio/lbry/blob/master/lbrynet/daemon/auth/server.py#L179) for details |
| streaming_get | boolean | false | true | Allow calling localhost:5280/get/claimname requests |
| save_files | boolean | true | false | Save files with each download |
| save_blobs | boolean | true | false | Save blobs with each download |
### Other
| Setting | Format | Default value | Sample Values | Description |
|--------------------|---------|---------------|--------------------------------|---------------------------------------------------------------------------------------------------------------|
| components_to_skip | list | [] | ['reflector','hash_announcer'] | Disable components, [see entire list here](https://github.com/lbryio/lbry/wiki/Component-Dependencies-Table) |
| components_to_skip | list | [] | ['reflector','hash_announcer'] | Disable components, [see entire list here](https://github.com/lbryio/lbry-sdk/wiki/Component-Dependencies-Table) |
| share_usage_data | boolean | true | false | Share analytics data |
+1 -1
View File
@@ -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
+1 -1
View File
@@ -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
+1 -1
View File
@@ -98,7 +98,7 @@ Alternatively, you can create a file `touch ~/.lbryum/config` and paste the foll
### lbry
Download source from [here](https://github.com/lbryio/lbry/releases), and run the following inside the environment:
Download source from [here](https://github.com/lbryio/lbry-sdk/releases), and run the following inside the environment:
```bash
cd lbry
pip2 install -r requirements.txt
+3 -3
View File
@@ -50,7 +50,7 @@ This document exists to introduce a project to a new visitor. It may also serve
### Contributing
* A single header labeled "Contributing" should appear as an h2
* This should be the same message: "Contributions to this project are welcome, encouraged, and compensated. For more details, see [CONTRIBUTING.md](*CONTRIBUTING.md*)”
* This should be the same message: "Contributions to this project are welcome, encouraged, and compensated. For more details, see *[CONTRIBUTING.md](CONTRIBUTING.md)*.”
* If CONTRIBUTING.md does not exist in the project, it should link to [https://lbry.com/faq/contributing](https://lbry.com/faq/contributing) (soon to be lbry.tech/contributing)
### (Additional Headings)
@@ -86,7 +86,7 @@ This document should cover the following:
* First, it should contain a single sentence: "This project follows the global contributing standards for all LBRY projects, to read those go < here >.”
* A "Code Overview" section explaining some basic design choices and how to begin stepping through the code. An example would be explaining that Daemon.py is the primary entry point for the daemon code, and one can begin to trace through the code by looking for jsonrpc_xxx, where xxx is one of the api calls listed [here](https://lbry.com/api)
* A "Testing" section explaining how to run tests and stating that tests are necessary
* Information on how to submit pull requests, and what to expect afterwards (e.g. a link to our [branching doc](https://github.com/lbryio/lbry/wiki/Branching-and-Merging), commands to run before submitting PR, tests must pass, changelog entry, etc). If you find this gets repetitive, it may be best to link to a global doc
* Information on how to submit pull requests, and what to expect afterwards (e.g. a link to our [branching doc](https://github.com/lbryio/lbry-sdk/wiki/Branching-and-Merging), commands to run before submitting PR, tests must pass, changelog entry, etc). If you find this gets repetitive, it may be best to link to a global doc
* Anything else a new visitor to a repository should know about contributing to that specific repository (linting, generating documentation, etc)
## LICENSE
@@ -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.
+1 -1
View File
@@ -14,7 +14,7 @@ Check out [our video tutorial](/resources/video-lbrydesktop) to setup the [Deskt
Check out [our video tutorial](/resources/video-lbryandroid) to setup the [Android app](https://github.com/lbryio/lbry-android) development environment.
## LBRY SDK
Check out [our video tutorial](/resources/video-lbrysdk) to setup the [LBRY SDK](https://github.com/lbryio/lbry) development environment.
Check out [our video tutorial](/resources/video-lbrysdk) to setup the [LBRY SDK](https://github.com/lbryio/lbry-sdk) development environment.
## LBRY Blockchain
Check out [our video tutorial](/resources/video-lbrycrd) to setup the [LBRY Blockchain](https://github.com/lbryio/lbrycrd) development environment.
+167
View File
@@ -0,0 +1,167 @@
# 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 16GB RAM, 100GB disk, and a fresh Ubuntu 18.04 install. Memory usage is flexible. 32 GB works best, but 16 GB is enough for a few clients.
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.
## Install lbrycrd
### Download and setup
Download the [latest release of lbrycrd](https://github.com/lbryio/lbrycrd/releases/latest).
Then, create a folder on your home directory called `.lbrycrd` and save the following to `.lbrycrd/lbrycrd.conf`:
```
txindex=1
server=1
daemon=1
rpcuser=lbry
rpcpassword=lbry
dustrelayfee=0.00000001
rpcworkqueue=128
```
Feel free to change the `rpcuser` or `rpcpassword`. If you do, you'll have to update the `DAEMON_URL` variable later on (in the docker-compose.yml file) to match the user/password you chose.
## Create a service (optional)
You can run lbrycrdd directly using `./lbrycrdd`. However, we recommend creatinga systemd service to manage the process for you.
Create a file at `/etc/systemd/system/lbrycrdd.service` with the following contents:
```
[Unit]
Description="LBRYcrd daemon"
After=network.target
[Service]
ExecStart=/home/<your_user>/lbrycrdd -datadir="/home/<your_user>/.lbrycrd"
User=<your_user>
Group=<your_user_group>
Restart=on-failure
KillMode=process
[Install]
WantedBy=multi-user.target
```
Then run `sudo systemctl daemon-reload`.
Now you can start and stop lbrycrd with `sudo service lbrycrdd start` and `sudo service lbrycrdd stop`.
## 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
sudo usermod -aG docker $USER
```
### 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
```
Make sure the user and password in the `DAEMON_URL` variable (the `lbry@lbry` part) in this docker-compose.yml matches thes user/password in your `~/.lbrycrd/lbrycrd.conf` file.
## Turn It On
### Start the servers
```
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
```
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.
To check Elastic search, there are two commands you can use:
```
curl localhost:9200 # get Elastic status
curl localhost:9200/claims/_count # check how many claims have been synced to Elastic
```
## 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 recreating one of the databases from scratch. Most of the time we will try to ensure there is an automatic migration, but even then, if you think the server has invalid data you can also try a resync.
The process is similar to an update, but causes the server to be down for much longer.
#### Main database
Holds the raw blockchain data and takes many hours (can take a day or two) to resync from scratch, so be sure to have a snapshot or try that last.
```
docker pull lbry/wallet-server:latest-release
docker-compose down
docker volume rm "$(whoami)_wallet_server"
WALLET_SERVER_SNAPSHOT_URL= docker-compose up --detach
```
#### Elasticsearch
ES does the indexing of claims from the main database. It should take around 30 minutes to resync on a fast machine.
```
docker pull lbry/wallet-server:latest-release
docker-compose down
docker volume rm "$(whoami)_es01"
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.
+10961
View File
File diff suppressed because it is too large. Load diff
+37 -36
View File
@@ -11,71 +11,72 @@
"author": "LBRY Team",
"dependencies": {
"@babel/polyfill": "^7.4.4",
"@inc/fastify-ws": "^1.1.0",
"@octokit/rest": "^16.28.0",
"@slack/client": "^5.0.1",
"async": "^3.0.1",
"async-es": "^3.0.1",
"choo": "^6.13.3",
"@inc/fastify-ws": "^2019.7.23",
"@octokit/rest": "^16.28.7",
"@slack/client": "^5.0.2",
"async": "^3.1.0",
"async-es": "^3.1.0",
"choo": "6.13.3",
"choo-async": "^0.1.1",
"choo-devtools": "^2.5.1",
"choo-devtools": "^3.0.0",
"choo-ssr": "^0.2.1",
"choo-websocket": "^2.0.0",
"colorette": "^1.0.8",
"colorette": "^1.1.0",
"cors": "^2.8.5",
"cron": "^1.7.1",
"date-format-lite": "^17.7.0",
"decamelize": "^3.2.0",
"dedent": "^0.7.0",
"dotenv": "^8.0.0",
"fastify": "~2.4.1",
"fastify": "~2.7.1",
"fastify-compress": "^0.10.0",
"fastify-helmet": "^3.0.0",
"fastify-static": "^2.4.0",
"fastify-helmet": "^3.0.1",
"fastify-static": "^2.5.0",
"front-matter": "^3.0.2",
"fs-exists-sync": "^0.1.0",
"got": "^9.6.0",
"graceful-fs": "^4.1.15",
"graceful-fs": "^4.2.1",
"link-module-alias": "^1.2.0",
"make-promises-safe": "^5.0.0",
"markdown-it": "^8.4.2",
"markdown-it": "^9.0.1",
"markdown-it-anchor": "^5.2.4",
"prismjs": "^1.15.0",
"prismjs": "^1.17.1",
"redis": "^2.8.0",
"slack-node": "^0.1.8",
"socket.io": "^2.2.0",
"stringify-object": "^3.3.0"
"stringify-object": "^3.3.0",
"request": "latest"
},
"description": "Documentation for the LBRY protocol and associated projects",
"devDependencies": {
"@babel/cli": "^7.4.4",
"@babel/core": "^7.4.5",
"@babel/cli": "^7.5.5",
"@babel/core": "^7.5.5",
"@babel/plugin-external-helpers": "7.2.0",
"@babel/plugin-proposal-class-properties": "7.4.4",
"@babel/plugin-proposal-class-properties": "7.5.5",
"@babel/plugin-proposal-decorators": "7.4.4",
"@babel/plugin-proposal-export-namespace-from": "7.2.0",
"@babel/plugin-proposal-function-sent": "7.2.0",
"@babel/plugin-proposal-export-namespace-from": "7.5.2",
"@babel/plugin-proposal-function-sent": "7.5.0",
"@babel/plugin-proposal-json-strings": "7.2.0",
"@babel/plugin-proposal-numeric-separator": "7.2.0",
"@babel/plugin-proposal-throw-expressions": "7.2.0",
"@babel/plugin-syntax-dynamic-import": "7.2.0",
"@babel/plugin-syntax-import-meta": "7.2.0",
"@babel/preset-env": "^7.4.5",
"@babel/register": "^7.4.4",
"@inc/eslint-config": "^1.1.3",
"@inc/sasslint-config": "^2019.5.7",
"@babel/preset-env": "^7.5.5",
"@babel/register": "^7.5.5",
"@inc/eslint-config": "^2019.7.23",
"@inc/sasslint-config": "^2019.7.23",
"@lbry/color": "^1.1.1",
"@lbry/components": "^2.7.2",
"eslint": "^5.16.0",
"husky": "^2.4.0",
"@lbry/components": "^2019.6.22",
"eslint": "^6.1.0",
"husky": "^3.0.2",
"nodemon": "^1.19.1",
"npm-run-all": "^4.1.5",
"pino-pretty": "^3.1.0",
"sass": "^1.21.0",
"pino-pretty": "^3.2.0",
"sass": "^1.22.9",
"sass-lint": "^1.13.1",
"snazzy": "^8.0.0",
"standardx": "^3.0.1",
"updates": "^8.1.0"
"standardx": "^4.0.0",
"updates": "^8.5.1"
},
"engines": {
"node": "10.2.x"
@@ -93,15 +94,15 @@
"private": true,
"scripts": {
"css": "sass --load-path=node_modules --update app/sass:app/dist --style compressed",
"format": "eslint '**/*.js' --fix --ignore-pattern '/app/dist/'",
"format": "eslint . --fix --ignore-pattern '/app/dist/'",
"postinstall": "link-module-alias",
"preinstall": "command -v link-module-alias; link-module-alias clean || true",
"start": "npm i; npm run css; NODE_ENV=production node index.js",
"preinstall": "command -v link-module-alias;link-module-alias clean || true",
"start": "npm i && npm run css && NODE_ENV=production node index.js",
"test": "run-s test:*",
"test:dependencies": "updates --update ./ --exclude prismjs",
"test:lint": "standardx --verbose | snazzy",
"test:sass": "sass-lint --config ./node_modules/@inc/sasslint-config/config.json --verbose --no-exit",
"watch": "npm run css; run-p watch:*",
"watch": "npm run css && run-p watch:*",
"watch:sass": "sass --load-path=node_modules --watch app/sass:app/dist --style compressed",
"watch:server": "NODE_ENV=development nodemon --ignore 'app/dist'"
},
@@ -110,5 +111,5 @@
"app/dist"
]
},
"version": "5.3.1"
"version": "5.3.2"
}