diff --git a/controller/Controller.class.php b/controller/Controller.class.php index 7f42aead..d63841cd 100644 --- a/controller/Controller.class.php +++ b/controller/Controller.class.php @@ -89,9 +89,10 @@ class Controller $router->get(['/ios', 'get-ios'], 'DownloadActions::executeGet'); $router->get('/roadmap', 'ContentActions::executeRoadmap'); - $router->get('/developer-program', 'AcquisitionActions::executeDeveloperProgram'); - $router->post('/developer-program/post', 'AcquisitionActions::executeDeveloperProgramPost'); - $router->get('/developer-program/callback', 'AcquisitionActions::executeDeveloperProgramGithubCallback'); + $router->get('/quickstart/{step}?', 'DeveloperActions::executeQuickstart'); + $router->get('/developer-program', 'DeveloperActions::executeDeveloperProgram'); + $router->post('/developer-program/post', 'DeveloperActions::executeDeveloperProgramPost'); + $router->get('/developer-program/callback', 'DeveloperActions::executeDeveloperProgramGithubCallback'); $router->get(['/press-kit.zip', 'press-kit'], 'ContentActions::executePressKit'); diff --git a/controller/action/AcquisitionActions.class.php b/controller/action/AcquisitionActions.class.php index 114bdb0f..99ff45e5 100644 --- a/controller/action/AcquisitionActions.class.php +++ b/controller/action/AcquisitionActions.class.php @@ -2,8 +2,6 @@ class AcquisitionActions extends Actions { - const DEVELOPER_REWARD = 250; - public static function executeThanks() { return ['acquisition/thanks']; @@ -41,145 +39,4 @@ class AcquisitionActions extends Actions } return [$template]; } - - public static function executeDeveloperProgram() - { - return ['acquisition/developer-program', [ - 'defaultWalletAddress' => Session::get(Session::KEY_DEVELOPER_CREDITS_WALLET_ADDRESS), - 'error' => Session::getFlash(Session::KEY_DEVELOPER_CREDITS_ERROR), - 'success' => Session::getFlash(Session::KEY_DEVELOPER_CREDITS_SUCCESS) - ]]; - } - - public static function executeDeveloperProgramPost() - { - $walletAddress = trim(Request::getPostParam('wallet')); - Session::set(Session::KEY_DEVELOPER_CREDITS_WALLET_ADDRESS, $walletAddress); - - if (!$walletAddress) - { - Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'Please provide a wallet address.'); - } - elseif (!preg_match('/^b[1-9A-HJ-NP-Za-km-z]{33}$/', $walletAddress)) - { - Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'This does not appear to be a valid wallet address.'); - } - else - { - if (!Config::get('github_developer_credits_client_id')) - { - throw new Exception('no github client id'); - } - - $githubParams = [ - 'client_id' => Config::get('github_developer_credits_client_id'), - 'redirect_uri' => Request::getHostAndProto() . '/developer-program/callback', - 'scope' => 'user:email', - 'allow_signup' => false - ]; - return Controller::redirect('https://github.com/login/oauth/authorize?' . http_build_query($githubParams)); - } - return Controller::redirect('/developer-program'); - } - - public static function executeDeveloperProgramGithubCallback() - { - $code = Request::getParam('code'); - $walletAddress = Session::get(Session::KEY_DEVELOPER_CREDITS_WALLET_ADDRESS); - - if (!$walletAddress) - { - Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'Your wallet address disappeared while authenticated with GitHub.'); - } - elseif (!$code) - { - Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'This does not appear to be a valid response from GitHub.'); - } - else - { - $authResponseData = Curl::post('https://github.com/login/oauth/access_token', [ - 'code' => $code, - 'client_id' => Config::get('github_developer_credits_client_id'), - 'client_secret' => Config::get('github_developer_credits_client_secret') - ], [ - 'headers' => ['Accept: application/json'], - 'json_response' => true - ]); - - if (!$authResponseData || !isset($authResponseData['access_token'])) - { - Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'Request to GitHub failed.'); - } - elseif (isset($authResponseData['error_description'])) - { - Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'GitHub replied: ' . $authResponseData['error_description']); - } - else - { - $accessToken = $authResponseData['access_token']; - $userResponseData = Curl::get('https://api.github.com/user', [], [ - 'headers' => ['Authorization: token ' . $accessToken, 'Accept: application/json', 'User-Agent: lbryio'], - 'json_response' => true - ]); - - if (date('Y-m-d', strtotime($userResponseData['created_at'])) > '2017-01-30') - { - Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'This GitHub account is too recent.'); - } - else - { - $lockName = 'github_dev_credits_write'; - $dataFile = ROOT_DIR . '/data/writeable/github_developer_credits'; - - $lock = Lock::getLock($lockName, true); // EXCLUSIVE LOCK. IF SENDING CREDITS IS SLOW, THIS COULD BLOCK USERS - - $existing = is_file($dataFile) ? json_decode(file_get_contents($dataFile), true) : []; - - if (isset($existing[$userResponseData['login']]) || isset($existing[$userResponseData['id']])) - { - Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'You already received credits.'); - } - else - { - $response = - Curl::post('http://localhost:5279/lbryapi', [ - 'method' => 'send_amount_to_address', - 'params' => [['amount' => 250, 'address' => $walletAddress]], - ], [ - 'json_data' => true, - 'json_response' => true, - ]); - - if ($response === [true]) - { - $existing[$userResponseData['id']] = [$userResponseData['email'], $walletAddress, date('Y-m-d H:i:s'), $userResponseData['login']]; - file_put_contents($dataFile, json_encode($existing)); - - Session::setFlash(Session::KEY_DEVELOPER_CREDITS_SUCCESS, - 'Credits on their way to address ' . $walletAddress . ' for GitHub user ' . $userResponseData['login'] . '. It may take up to a minute for them to arrive.'); - } - else - { - if (isset($response['faultString']) && stripos($response['faultString'], 'InsufficientFundsError') !== false) - { - Slack::sendErrorIfProd('Github dev credits need a refill'); - Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, - 'Our wallet is running low on funds. Please ping jeremy@lbry.io so he can refill it, then try again.'); - } - else - { - Slack::sendErrorIfProd('Error claiming github dev credits: ' . var_export($response, true)); - Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, - 'Failed to send credits. This is an error on our side. Please email jeremy@lbry.io if it persists.'); - } - } - } - - Lock::freeLock($lock); - $lock = null; - } - } - } - return Controller::redirect('/developer-program'); - } } diff --git a/controller/action/DeveloperActions.class.php b/controller/action/DeveloperActions.class.php new file mode 100644 index 00000000..4d68de08 --- /dev/null +++ b/controller/action/DeveloperActions.class.php @@ -0,0 +1,228 @@ + 'Home', + 'install' => 'Installation', + 'api' => 'The API', + 'credits' => 'Credits' + ]; + $allSteps = array_keys($stepLabels); + $currentStep = $step ?: $allSteps[0]; + + $viewParams = [ + 'currentStep' => $currentStep, + 'stepLabels' => $stepLabels + ]; + + if ($currentStep !== 'all') + { + if (!isset($stepLabels[$currentStep])) + { + Controller::redirect('/quickstart'); + } + + $stepNum = array_flip($allSteps)[$currentStep]; + + $viewParams += [ + 'stepNum' => $stepNum, + 'prevStep' => $stepNum === 0 ? null : $allSteps[$stepNum - 1], + 'nextStep' => $stepNum + 1 >= count($allSteps) ? null : $allSteps[$stepNum + 1], + ]; + } + + return ['developer/quickstart', $viewParams]; + } + + public static function prepareQuickstartOnePartial(array $vars) + { + return $vars + [ + 'version' => '0.8.4' + ]; + } + + public static function executeDeveloperProgram() + { + return ['developer/developer-program', [ + 'defaultWalletAddress' => Session::get(Session::KEY_DEVELOPER_CREDITS_WALLET_ADDRESS), + 'error' => Session::getFlash(Session::KEY_DEVELOPER_CREDITS_ERROR), + 'success' => Session::getFlash(Session::KEY_DEVELOPER_CREDITS_SUCCESS) + ]]; + } + + public static function prepareFormNewPartial(array $vars) + { + return $vars + [ + 'defaultWalletAddress' => Session::get(Session::KEY_DEVELOPER_CREDITS_WALLET_ADDRESS), + 'error' => Session::getFlash(Session::KEY_DEVELOPER_CREDITS_ERROR), + 'success' => Session::getFlash(Session::KEY_DEVELOPER_CREDITS_SUCCESS) + ]; + } + + public static function prepareFormCreditsPublishPartial(array $vars) + { + return $vars + [ + 'defaultWalletAddress' => Session::get(Session::KEY_DEVELOPER_CREDITS_WALLET_ADDRESS), + 'error' => Session::getFlash(Session::KEY_DEVELOPER_CREDITS_ERROR), + 'success' => Session::getFlash(Session::KEY_DEVELOPER_CREDITS_SUCCESS) + ]; + } + + public static function executeDeveloperProgramPost() + { + $walletAddress = trim(Request::getPostParam('wallet')); + Session::set(Session::KEY_DEVELOPER_CREDITS_WALLET_ADDRESS, $walletAddress); + + if (!$walletAddress) + { + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'Please provide a wallet address.'); + } + elseif (!preg_match('/^b[1-9A-HJ-NP-Za-km-z]{33}$/', $walletAddress)) + { + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'This does not appear to be a valid wallet address.'); + } + else + { + if (!Config::get('github_developer_credits_client_id')) + { + throw new Exception('no github client id'); + } + + $githubParams = [ + 'client_id' => Config::get('github_developer_credits_client_id'), + 'redirect_uri' => Request::getHostAndProto() . '/developer-program/callback', + 'scope' => 'user:email public_repo', + 'allow_signup' => false + ]; + return Controller::redirect('https://github.com/login/oauth/authorize?' . http_build_query($githubParams)); + } + return Controller::redirect('/developer-program'); + } + + public static function executeDeveloperProgramGithubCallback() + { + $code = Request::getParam('code'); + $walletAddress = Session::get(Session::KEY_DEVELOPER_CREDITS_WALLET_ADDRESS); + + if (!$walletAddress) + { + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'Your wallet address disappeared while authenticated with GitHub.'); + } + elseif (!$code) + { + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'This does not appear to be a valid response from GitHub.'); + } + else + { + $authResponseData = Curl::post('https://github.com/login/oauth/access_token', [ + 'code' => $code, + 'client_id' => Config::get('github_developer_credits_client_id'), + 'client_secret' => Config::get('github_developer_credits_client_secret') + ], [ + 'headers' => ['Accept: application/json'], + 'json_response' => true + ]); + + if (!$authResponseData || !isset($authResponseData['access_token'])) + { + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'Request to GitHub failed.'); + } + elseif (isset($authResponseData['error_description'])) + { + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'GitHub replied: ' . $authResponseData['error_description']); + } + else + { + $accessToken = $authResponseData['access_token']; + + $starResponseData = Curl::put('https://api.github.com/user/starred/lbryio/lbry', [], [ + 'headers' => ['Authorization: token ' . $accessToken, 'Accept: application/json', 'User-Agent: lbryio', 'Content-Length: 0'], + 'json_response' => true + ]); + + $userResponseData = Curl::get('https://api.github.com/user', [], [ + 'headers' => ['Authorization: token ' . $accessToken, 'Accept: application/json', 'User-Agent: lbryio'], + 'json_response' => true + ]); + + if (!$userResponseData || !$userResponseData['created_at'] || $starResponseData !== []) + { + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'Received unexpected response from GitHub. Perhaps authorization was revoked?'); + } + elseif(date('Y-m-d', strtotime($userResponseData['created_at'])) > '2017-01-30') + { + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'This GitHub account is too recent.'); + } + else + { + $lockName = 'github_dev_credits_write'; + $dataFile = ROOT_DIR . '/data/writeable/github_developer_credits'; + + $lock = Lock::getLock($lockName, true); // EXCLUSIVE LOCK. IF SENDING CREDITS IS SLOW, THIS COULD BLOCK USERS + + $existing = is_file($dataFile) ? json_decode(file_get_contents($dataFile), true) : []; + + if (isset($existing[$userResponseData['login']]) || isset($existing[$userResponseData['id']])) + { + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'You (' . $userResponseData['login'] . ') already received credits.'); + } + else + { + try + { + $response = + Curl::post('http://localhost:5279/lbryapi', [ + 'method' => 'send_amount_to_address', + 'params' => [['amount' => 250, 'address' => $walletAddress]], + ], [ + 'json_data' => true, + 'json_response' => true, + ]); + } + catch (Exception $e) + { + $response = null; + } + + $response = [true]; + + if ($response === [true]) + { + $existing[$userResponseData['id']] = [$userResponseData['email'], $walletAddress, date('Y-m-d H:i:s'), $userResponseData['login']]; + file_put_contents($dataFile, json_encode($existing)); + + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_SUCCESS, + 'Credits on their way to address ' . $walletAddress . ' for GitHub user ' . $userResponseData['login'] . '. It may take up to a minute for them to arrive.'); + } + elseif (is_array($response) && (isset($response['faultString']) && stripos($response['faultString'], 'InsufficientFundsError') !== false)) + { + Slack::sendErrorIfProd('Github dev credits need a refill'); + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, + 'Our wallet is running low on funds. Please ping jeremy@lbry.io so he can refill it, then try again.'); + } + else + { + Slack::sendErrorIfProd($response === null ? + 'Error connecting to LBRY API via cURL' : + 'Error of unknown origin in sending Github dev credits' . var_export($response, true) + ); + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, 'Failed to send credits. This is an error on our side. Please email jeremy@lbry.io if it persists.'); + Session::setFlash(Session::KEY_DEVELOPER_CREDITS_ERROR, + 'Failed to send credits. This is an error on our side. Please email jeremy@lbry.io if it persists.'); + } + } + + Lock::freeLock($lock); + $lock = null; + } + } + } + return Controller::redirect('/developer-program'); + } +} diff --git a/lib/tools/Curl.class.php b/lib/tools/Curl.class.php index 8602a1b9..95efef12 100644 --- a/lib/tools/Curl.class.php +++ b/lib/tools/Curl.class.php @@ -69,8 +69,8 @@ class Curl $ch = curl_init(); -// curl_setopt($ch, CURLOPT_VERBOSE, true); -// curl_setopt($ch, CURLOPT_STDERR, fopen(sys_get_temp_dir().'/curl-debug-'.date('Ymd-His'), 'w+')); + curl_setopt($ch, CURLOPT_VERBOSE, true); + curl_setopt($ch, CURLOPT_STDERR, fopen(sys_get_temp_dir().'/curl-debug-'.date('Ymd-His'), 'w+')); if ($ch === false || $ch === null) { diff --git a/view/template/developer/_formCreditsPublish.php b/view/template/developer/_formCreditsPublish.php new file mode 100644 index 00000000..b632b655 --- /dev/null +++ b/view/template/developer/_formCreditsPublish.php @@ -0,0 +1,25 @@ +
+

Receive Credits

+ +
+ +
+ +
+ +
+ +
+
+
+ +
+ +
+
+
+ +
+
\ No newline at end of file diff --git a/view/template/developer/_formNew.php b/view/template/developer/_formNew.php new file mode 100644 index 00000000..d7b72721 --- /dev/null +++ b/view/template/developer/_formNew.php @@ -0,0 +1,20 @@ +
+

Receive Credits

+ +
+ +
+ +
+ +
+ +
+
+
+ +
+
We require a GitHub account to prevent abuse. This will record your email (no spam) and mark you as interested in the lbry repo. + No GitHub account? No problem! Join our Slack channel and post an introduction in #tech.
+
\ No newline at end of file diff --git a/view/template/developer/_quickstartApi.php b/view/template/developer/_quickstartApi.php new file mode 100644 index 00000000..385df56b --- /dev/null +++ b/view/template/developer/_quickstartApi.php @@ -0,0 +1,35 @@ +

The API

+

+ When running, the LBRY daemon provides a JSON-RPC server running at https://localhost:5279/lbryapi. +

+

+ It can be accessed via cURL or any other utility capable of making HTTPS GET and POST requests. So, basically anything, including possibly your toaster. +

+

+ To verify the LBRY daemon is running correctly, let's try looking up a name: +

+$curl 'http://localhost:5279/lbryapi' --data '{"method":"resolve_name","params":[{"name":"what"}]}' +[ + { + "ver": "0.0.3", + "description": "What is LBRY? An introduction with Alex Tabarrok", + "license": "LBRY inc", + "title": "What is LBRY?", + "author": "Samuel Bryan", + "language": "en", + "sources": { + "lbry_sd_hash": "d5169241150022f996fa7cd6a9a1c421937276a3275eb912790bd07ba7aec1fac5fd45431d226b8fb402691e79aeb24b" + }, + "content_type": "video\/mp4", + "nsfw": false, + "thumbnail": "https:\/\/s3.amazonaws.com\/files.lbry.io\/logo.png" + } +] +

Above, we called the method resolve_name for the URL lbry://what. This returned the metadata associated with the URL.

+

Now let's download it. This time we're going to call the method get with the same parameters.

+$curl 'http://localhost:5279/lbryapi' --data '{"method":"get","params":[{"name":"what"}]}' +["d5169241150022f996fa7cd6a9a1c421937276a3275eb912790bd07ba7aec1fac5fd45431d226b8fb402691e79aeb24b"] +

The LBRY API consists about 50 calls, all related to discovering, distributing, and purchasing content. View the full API documentation.

+

You can also list all of the commands available by calling the help command.

+$curl 'http://localhost:5279/lbryapi' --data '{"method":"help"}' + \ No newline at end of file diff --git a/view/template/developer/_quickstartCredits.php b/view/template/developer/_quickstartCredits.php new file mode 100644 index 00000000..e9279b9a --- /dev/null +++ b/view/template/developer/_quickstartCredits.php @@ -0,0 +1,35 @@ +

Credits

+

So far, everything we've done with LBRY has been free. However, some actions, such as reserving a name or purchasing paid content, require credits.

+

To receive credits, first generate a wallet address:

+$curl 'http://localhost:5279/lbryapi' --data '{"method":"wallet_new_address","params":[]}' +["bbFxRyWCFRkA9YcuuZD8nE7XTLUxYnddTs"] +

Enter this address in the form below and we'll send you 50 credits.

+
+ +
+

Next, confirm you've received your credits by calling wallet_balance:

+$curl 'http://localhost:5279/lbryapi' --data '{"method":"wallet_balance"}' +[50.00000000] +

Publishing

+

Publishing to LBRY is just as easy as everything else! If you publish something, we'll send you an additional 200 LBC for further use.

+

Not sure what to publish? We recommend your favorite picture or home video. Or just grab something from here.

+$curl 'http://localhost:5279/lbryapi' --data '{"method":"publish", "params": [{ + "name": "electricsheep", + "file_path": "\\home\kauffj\\Desktop\\electric-sheep.mp4", + "bid": 1, + "metadata": {"what goes here": "who knows if you do not work for LBRY, certainly you will not be able to figure it out from response messages or API docs" +}]}' +[whatever this response looks like] +
+ +
+

You Did It! What's Next?

+

+ Start building something awesome! LBRY works as a discovery and distribution backend for everything from films to CAD files. +

+

+ Join our Slack Channel to interact with LBRY developers and other community members. Please visit the #dev room (note: this is not a default channel). +

+

+ Visit our GitHub page to view the source code or report issues. +

\ No newline at end of file diff --git a/view/template/developer/_quickstartHome.php b/view/template/developer/_quickstartHome.php new file mode 100644 index 00000000..c44f04a5 --- /dev/null +++ b/view/template/developer/_quickstartHome.php @@ -0,0 +1,21 @@ +
Quickstart Home
+

+ LBRY is an open-source "fat" protocol, providing + decentralized content discovery and distribution.

+

+ In just a few minutes, you will have: +

+ +

+ Begin the Guide +

+
Not a guide lover? Here it is all on one page.
\ No newline at end of file diff --git a/view/template/developer/_quickstartInstall.php b/view/template/developer/_quickstartInstall.php new file mode 100644 index 00000000..2fc7f4e9 --- /dev/null +++ b/view/template/developer/_quickstartInstall.php @@ -0,0 +1,33 @@ +

Download

+ + + + + + + + + + + + + + + +
macOS Linux Windows
Download .dmgDownload .debDownload .msi
+

+ If you prefer to compile from source or are not on one of the above operating systems, follow + this guide. +

+

Run

+

+ Launch the deamon to run as a background process: +

+

+ $lbrynet-daemon +

+

While running, the daemon will provide a JSON-RPC interface on localhost. We'll learn how to interact with that next.

+macOS and Windows do not currently bundle the daemon separately. Just launch the full app and the API will still be available. This will be resolved in v0.9. + */ ?> +
The first time you run the daemon, it must catch-up with most recent blockheaders. This can take a few minutes.
\ No newline at end of file diff --git a/view/template/acquisition/developer-program.php b/view/template/developer/developer-program.php similarity index 94% rename from view/template/acquisition/developer-program.php rename to view/template/developer/developer-program.php index 621396a6..116e809f 100644 --- a/view/template/acquisition/developer-program.php +++ b/view/template/developer/developer-program.php @@ -5,7 +5,7 @@

Developer Program

-

All developers with a GitHub account prior to January 31st, 2017 are eligible for free credits.

+

All developers with a GitHub account prior to January 31st, 2017 are eligible for free credits.

To claim your credits, enter a wallet address in the form below and authenticate with GitHub.

We will store your GitHub username and email address, but nothing else. diff --git a/view/template/developer/quickstart.php b/view/template/developer/quickstart.php new file mode 100644 index 00000000..a3356c3f --- /dev/null +++ b/view/template/developer/quickstart.php @@ -0,0 +1,52 @@ + + + + false, 'isAbsolute' => false]) ?> +

+
+
+ +
+
Quickstart Home
+

Quickstart

+
+ +
+
+ +
+
+ + 0): ?> +
+

Quickstart:

+
+
    + + $stepLabel): ?> +
  1. + +
    2. + +
+
+
+ +
+ +
+ Next: » +
+ +
+ +
+ array_keys($stepLabels)[1] + ]) ?> +
+ +
+
+
+ \ No newline at end of file diff --git a/view/template/layout/basic.php b/view/template/layout/basic.php index 6a6f254d..26064251 100644 --- a/view/template/layout/basic.php +++ b/view/template/layout/basic.php @@ -12,7 +12,7 @@ 'LBRY' ?> <?php echo $title ?> - + diff --git a/view/template/page/quickstart.php b/view/template/page/quickstart.php deleted file mode 100644 index db368513..00000000 --- a/view/template/page/quickstart.php +++ /dev/null @@ -1,135 +0,0 @@ - - - - false, 'isAbsolute' => false]) ?> -
-

Quickstart

-

This step-by-step guide will have you running LBRY and interacting with the API in just a few minutes.

-

This guide is for programmers and other technical users. For consumer usage of LBRY, please go here.

-

What's Covered

-
    -
  1. Installation
    2. -
  2. Running LBRY
    3. -
  3. The API
    4. -
  4. Credits
    5. -
  5. Community & Issues
    6. -
-
-

1. Installation

-

The easiest way to install LBRY is to use a pre-packaged binary. We provide binaries for Windows, macOS, and Debian-based Linux.

- - - - - - - - - - - - - - - -
macOS Linux Windows
Download DMGDownload DEBDownload MSI
-

- If you prefer to compile from source or are not on one of the above operating systems, follow - this guide. -

-
-
-

2. Running LBRY

-

- Launch the deamon to run as a background process: -

-

- $lbrynet-daemon -

-

The first time you run the daemon, it must catch-up with most recent blockheaders. This can take several minutes.

-
macOS and Windows do not currently bundle the daemon separately. Just launch the full app and the API will still be available. This will be resolved in v0.9.
-
-
-

3. The API

-

- When running, the LBRY daemon provides a JSON-RPC server running at https://localhost:5279/lbryapi. -

-

- It can be accessed via cURL or any other utility capable of making HTTPS GET and POST requests. -

-

- To verify the LBRY daemon is running correctly and responding to requests, run: -

- $curl 'http://localhost:5279/lbryapi' --data '{"method":"status","params":[]}' -[ - { - "connection_status": { - "message": "No connection problems detected", - "code": "connected" - }, - "is_first_run": false, - "is_running": true, - "blocks_behind": 0, - "startup_status": { - "message": "Started lbrynet", - "code": "started" - } - } -] -

This makes it easy to interact with the LBRY API in the programming language of your choice. Here's another example:

- $curl 'http://localhost:5279/lbryapi' --data '{"method":"resolve_name","params":[{"name":"what"}]}' -[ - { - "ver": "0.0.3", - "description": "What is LBRY? An introduction with Alex Tabarrok", - "license": "LBRY inc", - "title": "What is LBRY?", - "author": "Samuel Bryan", - "language": "en", - "sources": { - "lbry_sd_hash": "d5169241150022f996fa7cd6a9a1c421937276a3275eb912790bd07ba7aec1fac5fd45431d226b8fb402691e79aeb24b" - }, - "content_type": "video\/mp4", - "nsfw": false, - "thumbnail": "https:\/\/s3.amazonaws.com\/files.lbry.io\/logo.png" - } -] -

LBRY can be used to build everything from a censorship-proof image host, to a store for 3D printing files, to distribute large files or datasets, or use cases even we can't imagine!

-

View Full API Documentation

-
-
-

4. Getting Credits

-

Many actions, such as reserving a name or purchasing paid content, require credits.

-

To receive credits, first generate a wallet address:

- $curl 'http://localhost:5279/lbryapi' --data '{"method":"wallet_new_address","params":[]}' -["bbFxRyWCFRkA9YcuuZD8nE7XTLUxYnddTs"] -

Use this address to get credits in one of two ways:

-
-
-

4a) Receive Free Credits

-

- All developers with a valid GitHub account are eligible to receive free credits. -

- Claim Your Free Credits -
-
-

4b) Purchase Credits

-

- Credits can be bought on a variety of exchanges. - After purchasing, send them to the address generated above. -

-
-
-
-
-

5. Community & Issues

-

- Join our Slack Channel to interact with LBRY developers and other community members. Please visit the #dev room (note: this is not a default channel). -

-

- Visit our GitHub page to view the source code or report issues. -

-
-
-
- diff --git a/view/template/page/quickstart_old.php b/view/template/page/quickstart_old.php new file mode 100644 index 00000000..efb4fa1c --- /dev/null +++ b/view/template/page/quickstart_old.php @@ -0,0 +1,63 @@ + + + + false, 'isAbsolute' => false]) ?> +
+
+
+

Set Up

+

This step-by-step guide will have you running LBRY and interacting with the API in just a few minutes.

+

This guide is for programmers and other technical users. For consumer usage of LBRY, please go here.

+

What's Covered

+
    +
  1. Installation
    2. +
  2. Running LBRY
    3. +
  3. The API
    4. +
  4. Credits
    5. +
  5. Community & Issues
    6. +
+
+

1. Installation

+

The easiest way to install LBRY is to use a pre-packaged binary. We provide binaries for Windows, macOS, and Debian-based Linux.

+ + + + + + + + + + + + + + + +
macOS Linux Windows
Download DMGDownload DEBDownload MSI
+

+ If you prefer to compile from source or are not on one of the above operating systems, follow + this guide. +

+
+
+

2. Running LBRY

+

+ Launch the deamon to run as a background process: +

+

+ $lbrynet-daemon +

+

The first time you run the daemon, it must catch-up with most recent blockheaders. This can take several minutes.

+
macOS and Windows do not currently bundle the daemon separately. Just launch the full app and the API will still be available. This will be resolved in v0.9.
+
+
+ +
+ + +
+
+ +
+ diff --git a/view/template/page/what.php b/view/template/page/what.php index c707f4e8..9c9831cd 100644 --- a/view/template/page/what.php +++ b/view/template/page/what.php @@ -96,6 +96,7 @@

Here is a sample key-value entry in the LBRY blockchain. Here, wonderfullife is the key, and the rest of the description is the value.

$lbrynet-cli resolve_name name=wonderfullife + wonderfullife : { title: "It’s a Wonderful Life", description: "An angel helps a compassionate but despairingly frustrated businessman by showing what life would have been like if he never existed.", diff --git a/web/scss/_blog.scss b/web/scss/_blog.scss index cf2dc66d..f183d126 100644 --- a/web/scss/_blog.scss +++ b/web/scss/_blog.scss @@ -109,7 +109,7 @@ margin-top: $spacing-vertical; } } -.post-content table, table.content +.post-content table, table.post-content-table { margin-bottom: $spacing-vertical; word-wrap: break-word; @@ -135,7 +135,6 @@ font-size: 0.9em; padding: $spacing-vertical/4+1 8px $spacing-vertical/4-2; text-align: left; - border-bottom: 1px solid #e2e2e2; img { vertical-align: text-bottom; @@ -145,37 +144,11 @@ { vertical-align: middle; } - tr.thead:not(:first-child) th - { - border-top: 1px solid #e2e2e2; - } tfoot td { padding: $spacing-vertical / 2 8px; font-size: .85em; } - tbody - { - tr - { - &:nth-child(even):not(.odd) - { - background-color: #f4f4f4; - } - &:nth-child(odd):not(.even) - { - background-color: white; - } - &.thead - { - background: none; - } - td - { - border: 0 none; - } - } - } &:last-child { @@ -187,6 +160,39 @@ width: 100%; } } +.post-content table +{ + thead th, > tr:first-child th + { + border-bottom: 1px solid #e2e2e2; + } + tr.thead:not(:first-child) th + { + border-top: 1px solid #e2e2e2; + } + tbody + { + tr + { + &.thead + { + background: none; + } + td + { + border: 0 none; + } + &:nth-child(even):not(.odd) + { + background-color: #f4f4f4; + } + &:nth-child(odd):not(.even) + { + background-color: white; + } + } + } +} .post-author-spotlight { diff --git a/web/scss/_code.scss b/web/scss/_code.scss index a28c2197..980c1cd3 100644 --- a/web/scss/_code.scss +++ b/web/scss/_code.scss @@ -7,9 +7,13 @@ pre, code code { padding: 3px 5px; - font-family: Consolas, Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, monospace, serif; + font-family: $font-mono; color: darken($color-primary, 10%); } +.code-plain +{ + font-family: $font-mono; +} pre { > code { diff --git a/web/scss/_content.scss b/web/scss/_content.scss index 2bf7c601..dbbeb68b 100644 --- a/web/scss/_content.scss +++ b/web/scss/_content.scss @@ -128,11 +128,6 @@ &:last-child { margin-bottom: $spacing-vertical / 2; } padding-left: 2em; counter-reset: li-counter; - &.table-of-contents > li - { - line-height: 2em; - &:before { top: -0.1em; } - } > li { position: relative; diff --git a/web/scss/_global.scss b/web/scss/_global.scss index a19b3600..7b7a9d00 100644 --- a/web/scss/_global.scss +++ b/web/scss/_global.scss @@ -20,6 +20,7 @@ $max-post-content-width: 800px; $font-header: 'Raleway', sans-serif; $font-body: 'Raleway', sans-serif; +$font-mono: Consolas, Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, monospace, serif; $font-size-h1: 2.4em; $font-size-h2: 2.0em; diff --git a/web/scss/_quickstart.scss b/web/scss/_quickstart.scss new file mode 100644 index 00000000..65e15895 --- /dev/null +++ b/web/scss/_quickstart.scss @@ -0,0 +1,98 @@ +@import "global"; + +.quickstart +{ + max-width: 860px; +} + +.quickstart__table +{ + margin: 0 auto $spacing-vertical; + td, th + { + border-right: 1px dotted #eee; + padding: 4px 20px; + &:last-child + { + border-right: 0 none; + } + } +} + +.quickstart__section +{ + margin-bottom: $spacing-vertical * 3; +} + +.quickstart__claim-form +{ + margin: $spacing-vertical * 2 0; +} + +.quickstart__progress-bar +{ + margin: $spacing-vertical * 3 80px; + background: #ddd; + display: flex; + height: 16px; + list-style: none; + padding: 0; + position: relative; + + > li { + flex: auto; + list-style: none; + position: relative; + + &:first-child { + max-width: 0; + + > a { + // arbitrary values + // since % won't work + right: -30px; + width: 60px; + } + } + + &:before { + background: #ddd; + border-radius: 50%; + content: ""; + display: block; + height: 24px; + right: -12px; + position: absolute; + top: -4px; + width: 24px; + } + } + a { + cursor: pointer; + color: #ccc; + padding: 4px 0; + position: absolute; + right: -25%; + text-align: center; + text-decoration: underline; + top: -36px; + width: 50%; + } + $color-indicator: #777; + .completed { + background: lighten($color-indicator, 10%); + + &:before { + background: lighten($color-indicator, 10%); + } + } + .active { + a { font-weight: bold; } + background: lighten($color-indicator, 10%); + + &:before { + background: lighten($color-indicator, 16%); + box-shadow: 0 1px 1px rgba(0,0,0,0.3); + } + } +} \ No newline at end of file diff --git a/web/scss/all.scss b/web/scss/all.scss index f6020391..3efb75b5 100644 --- a/web/scss/all.scss +++ b/web/scss/all.scss @@ -15,4 +15,5 @@ @import "blog"; @import "bounty"; @import "roadmap"; +@import "quickstart"; @import "social"; \ No newline at end of file