Compare commits

...
Author SHA1 Message Date
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
32 changed files with 521 additions and 282 deletions

No files matched your search

+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 -8
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,9 +56,10 @@ 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())
@@ -67,22 +68,29 @@ function syncWithApi(data) { // eslint-disable-line no-unused-vars
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 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>";
return;
}
})
.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>";
+5 -5
View File
@@ -249,11 +249,11 @@ 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":
@@ -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 -1
View File
@@ -31,7 +31,7 @@ export default pagePath => {
break;
case "/api/sdk":
githubUrl = "https://github.com/lbryio/lbry/blob/master/docs/api.json";
githubUrl = "https://github.com/lbryio/lbry-sdk/blob/master/lbry/docs/api.json";
break;
default:
-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);
};
+3 -3
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-lbryandroid": "https://spee.ch/e781060bc708247f07afebc02d5f75cfba8e2c4b/video-2018-10-15053403",
"/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-lbrysdk": "https://spee.ch/967f99344308f1e90f0620d91b6c93e4dfb240e0/lbrynet-dev-setup",
"/specification": "/spec",
"/tour": "/playground",
"/whitepaper": "/spec"
}
+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;
+10 -11
View File
@@ -55,10 +55,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;
@@ -155,9 +155,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 +172,7 @@ export default async(data, socket) => {
return;
}
}
catch(imageUploadError) {
} catch(imageUploadError) {
send(socket, {
details: "Image upload failed",
message: "notification",
@@ -258,10 +254,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/", "");
+14 -1
View File
@@ -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;
}
}
+59 -31
View File
@@ -9,9 +9,11 @@ import html from "choo/html";
// U T I L S
import apiPage from "~view/api";
import fetchMetadata from "~helper/fetch-metadata";
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 +25,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 +90,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;
}
@@ -107,47 +125,58 @@ function generateContent(exampleNumber, displayTrendingContent) {
const renderedContentCollection = [];
const trendingContentData = response.data;
for (const data of trendingContentData)
for (const data of trendingContentData) {
rawContentCollection.push(fetchMetadata({
claim: data.url,
example: exampleNumber,
method: "resolve"
}));
}
Promise.all(rawContentCollection).then(collection => {
for (const part of collection) {
try {
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>
Promise.all(rawContentCollection)
.then(collection => {
for (const part of collection) {
if (part && part.value.tags && part.value.tags.includes("mature"))
continue;
if (part === undefined)
continue;
try {
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__title">
${part.value.title}
</div>
<div class="media__subtitle">
${part.channel_name}
</div>
</section>
`);
} catch(err) {
return; // TODO: Return nice error message
<div class="media__subtitle">
${part.signing_channel ? part.signing_channel.name : "Anon"}
</div>
</section>
`);
} catch(err) {
console.error(err);
return; // TODO: Return nice error message
}
}
}
renderedContentCollection.push(`
renderedContentCollection.push(`
<script>
document.getElementById("playground-example-description").innerHTML = document.querySelector("[data-action='playground, example 1']").dataset.description
</script>
`);
displayTrendingContent(renderedContentCollection.join(""));
});
displayTrendingContent(renderedContentCollection.join(""));
})
.catch(error => {
console.error(error);
return null;
});
});
}
@@ -176,8 +205,7 @@ function generateContent(exampleNumber, displayTrendingContent) {
if (
part &&
part.value &&
part.value.thumbnail.url &&
part.channel_name
part.value.thumbnail.url
) {
renderedContentCollection.push(`
<section class="playground-content__trend">
@@ -194,7 +222,7 @@ function generateContent(exampleNumber, displayTrendingContent) {
</div>
<div class="media__subtitle">
${part.channel_name}
${part.signing_channel.name || "Anon"}
</div>
</section>
`);
@@ -434,7 +462,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,
+131 -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,48 @@ 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 = "/lbry/docs/api.json";
const rawGitHubBase = "https://raw.githubusercontent.com/lbryio/";
if (!process.env.GITHUB_OAUTH_TOKEN) // No point in rendering this page
throw new Error("Missing GitHub token");
const octokit = new Octokit({
auth: `token ${process.env.GITHUB_OAUTH_TOKEN}`
});
// 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 +64,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 +154,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 +240,70 @@ 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 = [];
// 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.38.0" &&
tag.name !== "v0.38.0rc7" &&
tag.name !== "v0.38.0rc6" &&
tag.name !== "v0.38.0rc5" &&
tag.name !== "v0.38.0rc4" &&
tag.name !== "v0.38.0rc3" &&
tag.name !== "v0.38.0rc2" &&
tag.name !== "v0.38.0rc1"
) tags.push(tag.name);
});
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 +325,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 +373,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
@@ -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]];
}
+2 -2
View File
@@ -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 |
| --- | --- |
+5 -5
View File
@@ -22,10 +22,10 @@ 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 ([[torba]]), and contains an implementation of the LBRY data network. | [Video](/resources/video-lbrysdk)
| [torba](https://github.com/lbryio/lbry-sdk) | Python | An [[SPV]] (Simple Payment Verification) wallet. Bundled with [[lbry-sdk]].
| [wallet server](https://github.com/lbryio/lbry-sdk/tree/master/lbry/lbry/wallet/server) | Protobuf, Python | The wallet server used by [[torba]]. | |
| [schema](https://github.com/lbryio/lbry-sdk/tree/master/lbry/lbry/schema) | Protobuf, Python | Defines the structure of the metadata stored in the LBRY blockchain. | |
### Official Applications
| Application | Language (Toolset) | What Is It | Intro Video
@@ -68,7 +68,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
+11 -3
View File
@@ -41,6 +41,10 @@ The sequence number of a block in the blockchain. The first block is at height 0
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.
### Canonical URL
Similar to the [Short URL](#short-url) but for claims that are signed by channels, both the channel Short URL and claim Short URL are returned (i.e. lbry://@LBRY-Social#d/two#f. A canonical URL will change if the channel is updated, therefore its less permanent than a Short URL which is less permanent than the [Permanent URL](https://spec.lbry.com/#urls).
### Chainquery
A tool that stores blockchain data in an SQL database, keeps the database up-to-date as the blockchain grows, and provides an API to access the data using standard SQL queries.
@@ -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
+1 -1
View File
@@ -6,7 +6,7 @@ At this level:
- [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
+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.
+8 -5
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/lbry/conf.py).
## Daemon settings configuration
@@ -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,18 @@ 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 |
| 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 |
### 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 |
| use_auth_http | boolean | false | true | See [authentication instructions](https://github.com/lbryio/lbry-sdk/blob/master/lbrynet/daemon/auth/server.py#L179) for details |
### 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
@@ -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
+1 -1
View File
@@ -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
+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.
+35 -35
View File
@@ -11,36 +11,36 @@
"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",
@@ -48,34 +48,34 @@
},
"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 +93,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 +110,5 @@
"app/dist"
]
},
"version": "5.3.1"
"version": "5.3.2"
}