Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert into mkdocs #24

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,6 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# MK Docs
site
7 changes: 0 additions & 7 deletions docs/develop/blockchain/transactions.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs/develop/lamden_js/overview.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Current Lamden Masternodes
sidebar_label: Masternode Information
---

# Current Lamden Masternodes

## Mainnet
> Blockexplorer [https://mainnet.lamden.io](https://mainnet.lamden.io)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ title: Lamden Masternode Webserver REST API
sidebar_label: Masternode REST API
---

# Lamden Masternode Webserver REST API


Lamden Masternodes run a webserver which allows anyone to easily interface with the Lamden Blockchain.

The webserver provides direct access to the network's state and is the single entry point for submitting transactions.

- List of <u>[Lamden Masternodes](/docs/develop/blockchain/current_masternodes)</u>.
- List of <u>[Lamden Masternodes](/blockchain/current_masternodes)</u>.

- Webserver <u>[sorce code](https://github.com/Lamden/lamden/blob/master/lamden/nodes/masternode/webserver.py)</u>.

Expand Down Expand Up @@ -482,7 +483,7 @@ Get the current nonce for a vk
### post transaction
**`POST` `/`**

POST transactions as `JSON strings` to the blockchain. Transactions can be submitted to any masternode but they must be submutted to the same masternode that provided the <u>[nonce](/docs/develop/blockchain/masternode_api#get-noncevk)</u>.
POST transactions as `JSON strings` to the blockchain. Transactions can be submitted to any masternode but they must be submutted to the same masternode that provided the <u>[nonce](/blockchain/masternode_api#get-noncevk)</u>.

#### JSON body
```json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Blockservice Config
sidebar_label: Blockservice Config
---

# Blockservice Config

All configuration is done by an ```.env``` file which you need to create in the root of the application folder. Some variables which are not be set will use default values.

### Lamden configuration items
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ title: Estimation Script Installation
sidebar_label: Estimation Script Installation
---

# Estimation Script Installation

This script is used for estimating stamps cost of a transaction and serves a socket server to communicate with Lamden Block Service.
Installing this script can ensure endpoint ```/stamps/estimation``` works. You can find it at [<u>here</u>](https://github.com/Lamden/stamp_estimation_script).

### Preparation
1.[<u>Mongodb</u>(version > 4.0)](httpv://www.mongodb.com/docs/manual/installation/)
1. [<u>Mongodb</u>(version > 4.0)](httpv://www.mongodb.com/docs/manual/installation/)
2. [<u>python 3.6.x</u>](https://www.python.org/) (should come with UBUNTU 18.04)
3. poetry installed. poetry is a package manager tool. More detail click [<u>here</u>](https://python-poetry.org/docs)
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Blockservice Events
sidebar_label: Events For Blockservice
---

# Blockservice Events

Blockservice currently supports publish / subscribe using websockets notifications. This allows users to wait for events instead of polling for them.

## Connect to websocket server
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ title: Blockservice Installation
sidebar_label: Blockservice Installation
---

# Blockservice Installation

### Preparation
1. [<u>Mongodb</u>(version > 4.0)](httpv://www.mongodb.com/docs/manual/installation/)
2. [<u>Nodejs and NPM</u>](https://nodejs.org/en/)
3. Python Estimation Script. Click [<u>here</u>](/docs/develop/blockservice/estimation_installation) to figure out how to install it.
3. Python Estimation Script. Click [<u>here</u>](/blockservice/estimation_installation) to figure out how to install it.

### Install
```
Expand All @@ -22,7 +24,7 @@ npm run start
```

### Configure
You can custom blockservice by creating/editing ```.env``` file at the root of the project folder. Click [<u>here</u>](/docs/develop/blockservice/config) to get more details.
You can custom blockservice by creating/editing ```.env``` file at the root of the project folder. Click [<u>here</u>](/blockservice/config) to get more details.

### Sync Chaindata (Optional)
The first time you run the block service, it will take long time to sync blocks data. In order to avoid waiting for so long, you can use
Expand All @@ -32,5 +34,5 @@ The first time you run the block service, it will take long time to sync blocks
```
npm run docs
```
Then you can open ```{host}:{port}/api-docs/``` to check the API documentation served at local. For details, please check at [<u>here</u>](/docs/develop/blockservice/config).
Then you can open ```{host}:{port}/api-docs/``` to check the API documentation served at local. For details, please check at [<u>here</u>](/blockservice/config).

Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Lamden Block Service Overview
sidebar_label: Overview
---

# Lamden Block Service Overview

# Lamden Block Service
A nodejs application for syncing and serving the Lamden Blockchain to a local app.
This application serves as starting point to be able to build an app on Lamden that requires easy access to current state and realtime updates.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Blockservice REST API
sidebar_label: REST API
---

# Blockservice REST API

Blockservice currently provides many APIs to allow user easily access to the on-chain data of Lamden.
The APIs are documented using Swagger. For details and examples, please check the documents you served at local or visit the online [<u>documents</u>](http://119.29.130.37:8999/api-docs/).

Expand Down
Binary file added docs/docs/img/charms.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/img/contract_ide.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading