diff --git a/_quickstart/accounts.md b/_quickstart/accounts.md new file mode 100644 index 0000000000000000000000000000000000000000..7ff9c241c7e1620b2163a11baecb90493d33050b --- /dev/null +++ b/_quickstart/accounts.md @@ -0,0 +1,12 @@ +--- +title: Accounts +position: 3 +exclude: true +--- + +On Hive, each account is identifiable by its unique username, as maximum of 16 bytes, characters. +Accounts are created by existing users or services who utilize blockchain resources to assign public keys to the username. + +You can find some of the signup/onboarding services on this page, [https://signup.hive.io](https://signup.hive.io) and claim your unique username now. + + diff --git a/_quickstart/authentication.md b/_quickstart/authentication.md index 68b56e33cd76b09568f317a4d4b6fccdd9693415..4d492bcdf45d799fe44e9467fb412cadd9796cf2 100644 --- a/_quickstart/authentication.md +++ b/_quickstart/authentication.md @@ -1,6 +1,6 @@ --- title: Authentication -position: 3 +position: 4 exclude: true --- #### User authentication @@ -32,7 +32,12 @@ Overview of steps that user experiences during Login/Authentication in your webs 3. Access token used by website or application to sign and broadcast transactions on blockchain. For more detailed instruction please follow [HiveSigner documentation](https://docs.hivesigner.com/). -HiveSigner SDK: [https://www.npmjs.com/package/hivesigner](https://www.npmjs.com/package/hivesigner) + +HiveSigner SDK: [https://www.npmjs.com/package/hivesigner](https://www.npmjs.com/package/hivesigner) + +HiveSigner tutorial: [JS/Node.js]({{ '/tutorials-javascript/hivesigner.html' | relative_url }}) + +---- #### HiveKeychain @@ -50,8 +55,13 @@ Hive Keychain is an extension for accessing Hive-enabled distributed application 3. Signature used from website/application to sign transactions going forward, every transaction should be signed by user. For more detailed instruction please follow [HiveKeychain documentation](https://github.com/hive-keychain/hive-keychain-extension/blob/master/documentation/README.md). + HiveKeychain SDK: [https://www.npmjs.com/package/keychain-sdk](https://www.npmjs.com/package/keychain-sdk) +Keychain tutorial: [JS/Node.js]({{ '/tutorials-javascript/hivesigner.html' | relative_url }}) + +---- + #### HiveAuth HiveAuth is decentralized solution for any application (either web, desktop or mobile) to easily authenticate diff --git a/_quickstart/choose_library.md b/_quickstart/choose_library.md index 99398e78c87f39bb544f564e71253b41b46a7cb3..d573eb15a9f383507bbf3bb1caf5debe8ec88002 100644 --- a/_quickstart/choose_library.md +++ b/_quickstart/choose_library.md @@ -1,6 +1,6 @@ --- title: SDK Libraries -position: 4 +position: 5 exclude: true --- #### Software development kits @@ -17,18 +17,25 @@ which could be beneficial for your Hive project. Pure JavaScript Hive crypto library for node.js and browsers. Can be used to construct, sign and broadcast transactions in JavaScript. +[`@hiveio/hive-js`](https://www.npmjs.com/package/@hiveio/hive-js) + + --- **DHive** - [https://gitlab.syncad.com/hive/dhive](https://gitlab.syncad.com/hive/dhive) -A Typescript Hive crypto library for node.js and browsers. +A Typescript Hive crypto library for node.js and browsers. Can be used to construct, sign and broadcast transactions in JavaScript. + +[`@hiveio/dhive`](https://www.npmjs.com/package/@hiveio/hive-js) --- -**Hive-TX-JS** - [https://github.com/mahdiyari/hive-tx-js](https://github.com/mahdiyari/hive-tx-js) +**Hive-TX** - [https://github.com/mahdiyari/hive-tx-js](https://github.com/mahdiyari/hive-tx-js) Lightweight JavaScript library for creating and signing transactions. Works with frameworks like Nativescript. This library is a solution to such cases when other libraries are not working. And also an alternative for *only* creating, signing, and broadcasting transactions. +[`hive-tx`](https://www.npmjs.com/package/hive-tx) + --- **Radiator** - [https://github.com/inertia186/radiator](https://github.com/inertia186/radiator) diff --git a/_quickstart/fetch_broadcast.md b/_quickstart/fetch_broadcast.md index ff174cb842170b9f7c8f181d750b1c9f8b1774b2..a04fa87a66618218846422877e95eeed644afd2d 100644 --- a/_quickstart/fetch_broadcast.md +++ b/_quickstart/fetch_broadcast.md @@ -1,6 +1,6 @@ --- title: Get and Set -position: 5 +position: 6 exclude: true --- #### Fetching data diff --git a/_tutorials-javascript/blog_feed.md b/_tutorials-javascript/blog_feed.md index 0d904e95c5d51cb224deb1abe23fd855863eb781..acddfe9f201c8d9d29981ce1b1cd162f23c130be 100644 --- a/_tutorials-javascript/blog_feed.md +++ b/_tutorials-javascript/blog_feed.md @@ -11,7 +11,7 @@ This tutorial pulls a list of the most recent five user's posts from the blockch ## Intro -Tutorial is demonstrates the typical process of fetching account blog posts. It is quite useful if you want to embedd your blog posts on your website these tutorial will help you achieve that goal as well. This tutorial will explain and show you how to access the **Hive** blockchain using the [@hivechain/dhive](https://gitlab.syncad.com/hive/dhive) library to build a basic blog list of posts filtered by a _tag_ +Tutorial is demonstrates the typical process of fetching account blog posts. It is quite useful if you want to embedd your blog posts on your website these tutorial will help you achieve that goal as well. This tutorial will explain and show you how to access the **Hive** blockchain using the [@hiveio/dhive](https://gitlab.syncad.com/hive/dhive) library to build a basic blog list of posts filtered by a _tag_ Also see: * [get_discussions_by_blog]({{ '/apidefinitions/#tags_api.get_discussions_by_blog' | relative_url }}) diff --git a/_tutorials-javascript/client_signing.md b/_tutorials-javascript/client_signing.md index e4122e0e47a17b4ee4bc81b7c56d13ffb717a400..08877c1a0f395a64031bb848848eb5b703add15b 100644 --- a/_tutorials-javascript/client_signing.md +++ b/_tutorials-javascript/client_signing.md @@ -31,7 +31,7 @@ Client side signing of transaction is yet another way of interacting with Hive b {% include local-testnet.html %} -Testnet and Production networks only differ with few settings which helps developers to switch their application from testnet to production. One of these settings is `addressPrefix` - string that is defined and will be in front of every public address on that chain/network. Another one is `chainId` - id of that network. By defining those parameters we are selecting Testnet and connecting to publicly available server with help of `@hivechain/dhive` library. First few lines of code in `public/app.js` gives you example of connection to different networks, testnet and production. +Testnet and Production networks only differ with few settings which helps developers to switch their application from testnet to production. One of these settings is `addressPrefix` - string that is defined and will be in front of every public address on that chain/network. Another one is `chainId` - id of that network. By defining those parameters we are selecting Testnet and connecting to publicly available server with help of `@hiveio/dhive` library. First few lines of code in `public/app.js` gives you example of connection to different networks, testnet and production. ```javascript opts.addressPrefix = 'TST'; diff --git a/_tutorials-javascript/getting_started.md b/_tutorials-javascript/getting_started.md index 00b3bcff7509601f2d246a4e32257b1a00b10d00..d2a399b56afb6f90977a6b9ed4ca309d65149c46 100644 --- a/_tutorials-javascript/getting_started.md +++ b/_tutorials-javascript/getting_started.md @@ -7,7 +7,7 @@ canonical_url: getting_started.html --- Full, runnable src of these tutorials can be downloaded as part of: [tutorials/javascript](https://gitlab.syncad.com/hive/devportal/-/tree/master/tutorials/javascript) (or download just the JavaScript tutorials: [devportal-master-tutorials-javascript.zip](https://gitlab.syncad.com/hive/devportal/-/archive/master/devportal-master.zip?path=tutorials/javascript)). -For Javascript tutorials, we will use the opensource library [@hivechain/dhive](https://gitlab.syncad.com/hive/dhive). +For Javascript tutorials, we will use the opensource library [@hiveio/dhive](https://gitlab.syncad.com/hive/dhive). ### Node.js diff --git a/_tutorials-javascript/hivesigner.md b/_tutorials-javascript/hivesigner.md index 953b222a8d6d90129a5d3193005953eba375dfc4..ce2868842e419001aff852478b4670c4e557ea5a 100644 --- a/_tutorials-javascript/hivesigner.md +++ b/_tutorials-javascript/hivesigner.md @@ -36,26 +36,26 @@ Learn more about [Hivesigner operations here](https://github.com/ecency/hivesign #### 1. Hivesigner Dashboard<a name="dashboard"></a> -Hivesigner is unified authentification system built on top of Hive. +Hivesigner is unified OAuth2 authentication system built on top of Hive. Layer to ensure easy access and setup for all application developers as well as secure way for users to interact with Hive apps. Setting up Hivesigner in your app is straight-forward process and never been this easy. Here are the steps that helps you to setup new app: -1a. Visit [Hivesigner Dashboard](https://hivesigner.com/profile) and login with your Hive credentials for your app +1a. Visit [Hivesigner Dashboard](https://hivesigner.com/profile) and login with your Hive credentials for **your app account** - +<img alt="hivesigner_login" height="auto" src="https://gitlab.syncad.com/hive/devportal/-/raw/master/tutorials/javascript/02_hivesigner/images/hivesigner_login.png" width="70%"/> 1b. You will see Account type, User and Application section, in Application section fill out details of App - +<img alt="hivesigner_dashboard" height="auto" src="https://gitlab.syncad.com/hive/devportal/-/raw/master/tutorials/javascript/02_hivesigner/images/account_type_application.png" width="70%"/> 1c. Give your app name, description, icon image link, website (if available) and Redirect URI(s) -Here is an example of [Esteem](https://esteem.app) form to give you idea how to fill form correctly. +Here is an example of [Ecency](https://ecency.com) form to give you idea how to fill form correctly. - +<img alt="hivesigner_myapps" height="auto" src="https://gitlab.syncad.com/hive/devportal/-/raw/master/tutorials/javascript/02_hivesigner/images/hivesigner_myapp.png" width="70%"/> Application name and description should give users clear understanding what permissions it requires and what is the purpose of the app. @@ -80,7 +80,7 @@ Now that `hivesigner` is initialized we can start authentication and perform sim #### 3. Login URL<a name="login-url"></a> -> `getLoginURL` function you see on the right side, returns login URL which will redirect user to sign in with Hivesigner screen. Successfull login will redirect user to Redirect URI or `callbackURL`. Result of successful login will return `access_token`, `expires_in` and `username` information, which application will start utilizing. +> `getLoginURL` function you see on the right side, returns login URL which will redirect user to sign in with Hivesigner screen. Successfull login will redirect user to Redirect URI or `callbackURL`. Result of successful login will return `access_token`, `expires_in` and `username` information, which application will start utilizing. Make sure to catch access_token parameter from callback URL and store locally until expiry, after expiry reached, request user to relogin to issue new access token. #### 4. Request token<a name="request-token"></a> @@ -103,6 +103,8 @@ Now that `hivesigner` is initialized we can start authentication and perform sim **That's all there is to it.** +To learn more about [Hivesigner SDK](https://github.com/ecency/hivesigner-sdk) or integration guide check [official Hivesigner docs](https://docs.hivesigner.com). + ### To Run the tutorial 1. `git clone https://gitlab.syncad.com/hive/devportal.git` diff --git a/tutorials/javascript/02_hivesigner/images/hivesigner_myapp.png b/tutorials/javascript/02_hivesigner/images/hivesigner_myapp.png index 7e30cf5c87498b6e8fe94c7cefcb1b964972e905..cd703420ad434e660420672ad03f963bebb54110 100644 Binary files a/tutorials/javascript/02_hivesigner/images/hivesigner_myapp.png and b/tutorials/javascript/02_hivesigner/images/hivesigner_myapp.png differ