Skip to content

Commit

Permalink
update links of documents
Browse files Browse the repository at this point in the history
  • Loading branch information
Soon Kuk Kang committed May 28, 2019
1 parent 96954ae commit a5327f1
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion sebak_command.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ permalink: /SEBAK-command/
---
---
# SEBAK command
To install `sebak` command, please check the [installation guide](./sebak_installation.md).
To install `sebak` command, please check the [installation guide](http://devteam.blockchainos.org/docs/SEBAK-installation/).

# Options
```sh
Expand Down
4 changes: 2 additions & 2 deletions sebak_deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To deploy the sebak network, the basic steps are mentioned below.

If you deployed network already, you should skip generating genesis block .

You can run SEBAK in standalone mode, please check [Running Standalone Mode](./sebak_deployment_standalone.md).
You can run SEBAK in standalone mode, please check [Running Standalone Mode](http://devteam.blockchainos.org/docs/SEBAK-deployment-standalone/).

The `network-id` is `this-is-test-sebak-network`.

Expand Down Expand Up @@ -48,7 +48,7 @@ INFO[10-29|14:57:28] genesis block created ...
successfully created genesis block
```

> You can also check the usage of `sebak key generate` in [SEBAK Commands](./sebak_command.md#sebak-genesis).
> You can also check the usage of `sebak key generate` in [SEBAK Commands](http://devteam.blockchainos.org/docs/SEBAK-command/#sebak-genesis).
You should make genesis block in every nodes

Expand Down
6 changes: 3 additions & 3 deletions sebak_deployment_standalone.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ By the nature of design, SEBAK should be deployed as composition of nodes and th

## Installation

Please follow the [Installation](./sebak_installation.md). If you are so busy and you already have golang (1.11 or higher) environment, do like this,
Please follow the [Installation](http://devteam.blockchainos.org/docs/SEBAK-installation/). If you are so busy and you already have golang (1.11 or higher) environment, do like this,

```sh
$ git clone https://github.com/bosnet/sebak.git /tmp/sebak-standalone
Expand All @@ -26,7 +26,7 @@ You will get the executable `./sebak`. You can use it to deploy.

## Deploy

> For the detailed deployment instruction, please check [Deploy Network](./sebak_deployment.md).
> For the detailed deployment instruction, please check [Deploy Network](http://devteam.blockchainos.org/docs/SEBAK-deployment/).
For standalone mode, SEBAK already prepared the special command, `self`. You can simply give only `self` in `--validators` option. Then you will get the standalone mode of SEBAK.

Expand Down Expand Up @@ -84,7 +84,7 @@ DBUG[10-07|13:47:20] parsed flags: module=main

## Testing

For usage of SEBAK commands, plese check [`sebak` commands](./sebak_command.md).
For usage of SEBAK commands, plese check [`sebak` commands](http://devteam.blockchainos.org/docs/SEBAK-command/).

### Creating Account

Expand Down
8 changes: 4 additions & 4 deletions sebak_for_exchanges.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ permalink: /SEBAK-for-exchange/

## Pre-required Instruction

Before access to Sebak public Testnet, BOScoin devteam strongly recommends to test in your local environment with [standalone mode](Running-Standalone-Mode) & [sebak-angelbot](https://github.com/spikeekips/sebak-angelbot).
Before access to Sebak public Testnet, BOScoin devteam strongly recommends to test in your local environment with [standalone mode](http://devteam.blockchainos.org/docs/SEBAK-deployment-standalone/) & [sebak-angelbot](https://github.com/spikeekips/sebak-angelbot).

In case of you have seen unexpected errors or have questions,

Expand All @@ -22,11 +22,11 @@ In case of you have seen unexpected errors or have questions,

### Sebak Installation

Please check [SEBAK installation](docs/SEBAK-installation/).
Please check [SEBAK installation](http://devteam.blockchainos.org/docs/SEBAK-installation/).

### Running Sebak on localhost (a.k.a 'standalone mode')

Please check contents in [standalone mode](docs/SEBAK-deployment-standalone/).
Please check contents in [standalone mode]http://devteam.blockchainos.org/docs/SEBAK-deployment-standalone/).

### Installation sebak-angelbot, the account creation tool

Expand All @@ -36,7 +36,7 @@ You can check specific information in the project page, [sebak-angelbot](https:/

#### How to create account using 'sebak-angelbot'?

- Running sebak node as [standalone](docs/SEBAK-deployment-standalone/) mode.
- Running sebak node as [standalone](http://devteam.blockchainos.org/docs/SEBAK-deployment-standalone/) mode.
- Execute sebak command `$ sebak key generate` as much as you want. this key pair will be used to create new account in sebak node. We recommend almost 100 keypair.
- Open text editor and put secret-keys line by line and save in `sources.txt` file.
- Running 'sebak-angelbot' in your localhost. In 'sebak-anglebot' command line options, we recommend `--secret-seed` to be secret seed of `genesis account`.
Expand Down
4 changes: 2 additions & 2 deletions sebak_testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ When you send a transaction, creating an account or sending a payment, *Testnet*
> ## Python SDK for sebak is here ; [sebak-pyutil](https://github.com/spikeekips/sebakpy-util)
> ## Javascript SDK for sebak is here ; [sebak-jsutil](https://github.com/bosnet/sebakjs-util)
> ## Creating accounts should use tool, [sebak-angelbot](https://github.com/spikeekips/sebak-angelbot).
> ## Sebak API documents is here ; [API docs](https://bosnet.github.io/sebak/api/).
> ## Sebak API documents is here ; [API docs](https://bosnet.github.io/docs/api/).
### Errors and Q&A
Please refer to this document, [When you saw the errors during testing](./sebak_I_find_errors_in_sebak_how_can_I_report).
Please refer to this document, [When you saw the errors during testing](http://devteam.blockchainos.org/docs/how-to-report-issue/).
4 changes: 2 additions & 2 deletions simple-guide-for-sebak-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ http://testnet-sebak.blockchainos.org/

Of course you can access when you opend above link aned to send transaction. However before send transaction, you must check SEBAK api at first.

Here is the [SEBAK API document](https://bosnet.github.io/sebak/api/).
Here is the [SEBAK API document](https://bosnet.github.io/docs/api/).

So We,BOScoin dev team, **stronly recommend** to test in your local enviroment. You can see the contents [How to test in your local enviroment](https://github.com/bosnet/sebak/wiki/Running-Standalone-Mode).
So We,BOScoin dev team, **stronly recommend** to test in your local enviroment. You can see the contents [How to test in your local enviroment](http://devteam.blockchainos.org/docs/SEBAK-deployment-standalone/).

At the moment, BOScoin dev team provide SDKs in Python and Javascript. Please check below repositories.

Expand Down
10 changes: 5 additions & 5 deletions tech_how_the_consensus_protocol_works.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ If the voting determines that the ballot is valid, all nodes confirm the transac
### `INIT`
1. The timer is set to TIMEOUT_INIT.
1. The steps to propose transactions are as follows.
* If the node is [proposer](how_to_select_the_proposer.md) of this round, it broadcasts a B(`INIT`, `YES`),
* If the node is [proposer](http://devteam.blockchainos.org/docs/how-to-select-the-proposer/) of this round, it broadcasts a B(`INIT`, `YES`),
* The ballot includes valid transactions(only hashes) or empty(If the transaction pool is empty).
* When the node broadcasts the ballot, the node goes to the next state.
* If the node is not `proposer`, it waits until receiving the B(`INIT`, `YES`).
Expand All @@ -86,7 +86,7 @@ If the voting determines that the ballot is valid, all nodes confirm the transac

### `SIGN`
1. The timer is reset to TIMEOUT_SIGN.
1. The node checks [the proposed ballot is valid](how_to_check_a_ballot_is_valid.md).
1. The node checks [the proposed ballot is valid](http://devteam.blockchainos.org/docs/how-to-check-a-ballot-is-valid/).
* If the proposed ballot is valid(or empty), the node broadcasts B(`SIGN`, `YES`).
* If the proposed ballot is invalid, the node broadcasts B(`SIGN`, `NO`).
* When the timer expires, the node hasn't sent a ballot in `SIGN` state yet, it broadcasts B(`SIGN`, `EXP`).
Expand All @@ -105,12 +105,12 @@ If the voting determines that the ballot is valid, all nodes confirm the transac

### `ALL-CONFIRM`
1. the node confirms and saves the block with proposed transactions even though it is empty.
1. the node filters [invalid transactions](how_to_check_a_ballot_is_valid.md#transaction-validation) in the transaction pool.
1. the node filters [invalid transactions](http://devteam.blockchainos.org/docs/how-to-check-a-ballot-is-valid/#transaction-validation) in the transaction pool.
1. It goes to `INIT` state with height + 1 and round 0.

### `INIT`
* If the node is `proposer`, it waits for [block time buffer](tech_how_to_calculate_block_time_buffer.md) and propose.
* If the node is `proposer`, it waits for [block time buffer](http://devteam.blockchainos.org/docs/how-to-calculate-block-time-buffer/) and propose.
* Else, it waits for `block time buffer` + TIMEOUT_INIT to receive proposed ballot.

## Transaction Protocol
1. [`Transaction Protocol`](how_transactions_are_shared.md) is a protocol for sharing transactions between the nodes.
1. [`Transaction Protocol`](http://devteam.blockchainos.org/docs/how-transactions-are-shared/) is a protocol for sharing transactions between the nodes.
2 changes: 1 addition & 1 deletion tech_how_to_check_a_ballot_is_valid.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ permalink: /how-to-check-a-ballot-is-valid/
---
# How to check a ballot is valid

A node must validate the ballot with transactions from proposer(Please refer to [How the consensus protocol works](./tech_how_the_consensus_protocol_works.md)). This is because only valid ballot must be agreed and confirmed.
A node must validate the ballot with transactions from proposer(Please refer to [How the consensus protocol works](http://devteam.blockchainos.org/docs/how-the-consensus-protocol-works/)). This is because only valid ballot must be agreed and confirmed.

## Ballot Structure

Expand Down
2 changes: 1 addition & 1 deletion tech_how_transactions_are_shared.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Transaction Protocol is used for sharing transactions.
* If well-formed, it goes to the next step.
* If malformed, it discards the transaction and stops this process.
1. If the same transaction is already in the transaction pool, it stops this process.
1. The node [validates](./tech_how_to_check_a_ballot_is_valid.md) the transaction.
1. The node [validates](http://devteam.blockchainos.org/docs/how-to-check-a-ballot-is-valid/) the transaction.
* If valid, it is stored in transaction pool.
* If invalid, it discards the transaction and stops this process.
1. The node broadcasts the transaction message to all nodes except for the sender.

0 comments on commit a5327f1

Please sign in to comment.