Skip to content

Commit

Permalink
Update all links to exonum doc (#1108)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ilya Bogdanov authored and skletsun committed Sep 6, 2019
1 parent 39979ed commit 83c3d9d
Show file tree
Hide file tree
Showing 32 changed files with 56 additions and 56 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -21,7 +21,7 @@ You need to install the following dependencies:
* [Maven 3.5+](https://maven.apache.org/download.cgi).
* [Rust 1.36.0](https://www.rust-lang.org/).
To install a specific Rust version, use `rustup install 1.36.0` command.
* The [system dependencies](https://exonum.com/doc/version/0.11/get-started/install/) of Exonum.
* The [system dependencies](https://exonum.com/doc/version/0.12/get-started/install/) of Exonum.
You do _not_ need to manually fetch and compile Exonum.
__Important__: On Mac OS it is necessary to install RocksDB
package and to set the environment variable `ROCKSDB_LIB_DIR`.
Expand Down Expand Up @@ -109,12 +109,12 @@ Run `mvn clean -DcleanRust`.
The [Exonum Java Binding](exonum-java-binding) project is split into several modules.
Here are the main ones:
* [`core`](exonum-java-binding/core) contains the APIs to define and implement an
[Exonum service](https://exonum.com/doc/version/0.11/get-started/design-overview/#modularity-and-services).
[Exonum service](https://exonum.com/doc/version/0.12/get-started/design-overview/#modularity-and-services).
* [`core-native`](exonum-java-binding/core/rust) contains the glue code between Java and Rust.
* [`app`](exonum-java-binding/core/rust/exonum-java) is an application that runs a node with Java
and Rust services.
* [`common`](exonum-java-binding/common) provides common functionality to Exonum core
and light clients: [Exonum proofs](https://exonum.com/doc/version/0.11/get-started/design-overview/#proofs),
and light clients: [Exonum proofs](https://exonum.com/doc/version/0.12/get-started/design-overview/#proofs),
hashing and cryptographic operations, serialization support.
* [`exonum-service-archetype`](exonum-java-binding/service-archetype) implements an archetype
generating a template project of Exonum Java service.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -16,7 +16,7 @@ The following projects are available:

## Links
For more information see the relevant documentation on the tool:
- [What is Exonum?](https://exonum.com/doc/version/0.11/get-started/what-is-exonum/)
- [What is Exonum?](https://exonum.com/doc/version/0.12/get-started/what-is-exonum/)
- [Roadmap](ROADMAP.md)
- [Contribution Guide](CONTRIBUTING.md)
- [Code of Conduct](https://github.com/exonum/exonum/blob/master/CODE_OF_CONDUCT.md)
Expand Down
4 changes: 2 additions & 2 deletions exonum-java-binding/CHANGELOG.md
Expand Up @@ -55,7 +55,7 @@ the [migration guide](https://github.com/exonum/exonum-java-binding/blob/ejb/v0.
- `RawTransaction#fromMessage(TransactionMessage)`, which is mostly useful in tests,
where you might have a message but need it as a `RawTransaction` in some assertions.

[testkit-documentation]: https://exonum.com/doc/version/0.11/get-started/java-binding/#testing
[testkit-documentation]: https://exonum.com/doc/version/0.12/get-started/java-binding/#testing

### Changed
- Improved the throughput of transaction processing twofold. Java services on Exonum Java 0.7.0
Expand Down Expand Up @@ -116,7 +116,7 @@ The release is based on Exonum 0.11.
- `toOptional()` method to `EntryIndexProxy`. (#790)
- `getTransactionPool()` method to `Blockchain`. (#850)

[installation]: https://exonum.com/doc/version/0.11/get-started/java-binding/#installation
[installation]: https://exonum.com/doc/version/0.12/get-started/java-binding/#installation

### Changed
- Service HTTP APIs provided with `Service#createPublicApiHandlers` are now mounted
Expand Down
2 changes: 1 addition & 1 deletion exonum-java-binding/README.md
Expand Up @@ -9,7 +9,7 @@ With Exonum Java Binding you can define stateful Exonum Services in Java,
configure a network of nodes and run your services in it.

For more information see the relevant documentation on the tool:
- [User Guide](https://exonum.com/doc/version/0.11/get-started/java-binding/)
- [User Guide](https://exonum.com/doc/version/0.12/get-started/java-binding/)
- [Cryptocurrency Example Service](cryptocurrency-demo)

## License
Expand Down
Expand Up @@ -24,7 +24,7 @@
/**
* Blockchain Consensus algorithm parameters.
*
* <p>See <a href="https://exonum.com/doc/version/0.11/architecture/configuration/">Exonum configuration</a> for
* <p>See <a href="https://exonum.com/doc/version/0.12/architecture/configuration/">Exonum configuration</a> for
* Consensus configuration details.
*/
@AutoValue
Expand Down
Expand Up @@ -27,7 +27,7 @@
* Represents a blockchain configuration which is a set of values that determine
* the network access parameters of a node and behavior of the node while operating in the network.
*
* <p>See <a href="https://exonum.com/doc/version/0.11/architecture/configuration/">Exonum configuration</a> for
* <p>See <a href="https://exonum.com/doc/version/0.12/architecture/configuration/">Exonum configuration</a> for
* configuration details.
*
* <p>Services configuration parameters would be available after
Expand All @@ -51,7 +51,7 @@ public abstract class StoredConfiguration {
/**
* List of validators consensus and service public keys.
*
* @see <a href="https://exonum.com/doc/version/0.11/architecture/configuration/#genesisvalidator_keys">Validator keys configuration section</a>
* @see <a href="https://exonum.com/doc/version/0.12/architecture/configuration/#genesisvalidator_keys">Validator keys configuration section</a>
*/
@SerializedName("validator_keys")
public abstract List<ValidatorKey> validatorKeys();
Expand Down
4 changes: 2 additions & 2 deletions exonum-java-binding/core/rust/exonum-java/TUTORIAL.md
Expand Up @@ -10,7 +10,7 @@ location.
You also need a ready-to-use Exonum Java service. You can use
[cryptocurrency-demo][cryptocurrency-demo] as an example, and find information about
implementing your own Exonum service
in the [user guide](https://exonum.com/doc/version/0.11/get-started/java-binding/).
in the [user guide](https://exonum.com/doc/version/0.12/get-started/java-binding/).

[how-to-build]: https://github.com/exonum/exonum-java-binding/blob/master/CONTRIBUTING.md#how-to-build
[cryptocurrency-demo]: https://github.com/exonum/exonum-java-binding/tree/master/exonum-java-binding/cryptocurrency-demo
Expand All @@ -20,7 +20,7 @@ in the [user guide](https://exonum.com/doc/version/0.11/get-started/java-binding
### Step 1. Configure Environment

#### Services definition
Services must be defined in the [services.toml](https://exonum.com/doc/version/0.11/get-started/java-binding/#built-in-services)
Services must be defined in the [services.toml](https://exonum.com/doc/version/0.12/get-started/java-binding/#built-in-services)
file in order to be available in the network. The configuration file consists of two sections:
- The optional `system_services` section is used to enable built-in Exonum services. If
not specified - only Configuration service is enabled. Possible variants for the moment are:
Expand Down
Expand Up @@ -245,7 +245,7 @@ public StoredConfiguration getActualConfiguration() {
* Note that this pool represents the state as of the current snapshot, and its state is volatile
* even between block commits.
*
* @see <a href="https://exonum.com/doc/version/0.11/advanced/consensus/specification/#pool-of-unconfirmed-transactions">Pool of Unconfirmed Transactions</a>
* @see <a href="https://exonum.com/doc/version/0.12/advanced/consensus/specification/#pool-of-unconfirmed-transactions">Pool of Unconfirmed Transactions</a>
*/
public KeySetIndexProxy<HashCode> getTransactionPool() {
return schema.getTransactionPool();
Expand Down
Expand Up @@ -167,7 +167,7 @@ MapIndex<HashCode, TransactionLocation> getTxLocations() {
* Note that this pool represents the state as of the current snapshot, and its state is volatile
* even between block commits.
*
* @see <a href="https://exonum.com/doc/version/0.11/advanced/consensus/specification/#pool-of-unconfirmed-transactions">Pool of Unconfirmed Transactions</a>
* @see <a href="https://exonum.com/doc/version/0.12/advanced/consensus/specification/#pool-of-unconfirmed-transactions">Pool of Unconfirmed Transactions</a>
*/
KeySetIndexProxy<HashCode> getTransactionPool() {
return KeySetIndexProxy.newInstance(CoreIndex.TRANSACTIONS_POOL, dbView,
Expand Down
Expand Up @@ -79,7 +79,7 @@ void checkNoCopiesOfAppClasses(ClassLoader pluginClassloader) {
+ " 2. Does not specify its version (i.e., inherits it "
+ "from exonum-java-binding-bom)%n"
+ "See also: "
+ "https://exonum.com/doc/version/0.11/get-started/java-binding/#using-libraries",
+ "https://exonum.com/doc/version/0.12/get-started/java-binding/#using-libraries",
pluginClassloader, libraryCopies);
throw new IllegalArgumentException(message);
}
Expand Down
Expand Up @@ -27,9 +27,9 @@
public interface BlockCommittedEvent {

/**
* If this node is a <a href="https://exonum.com/doc/version/0.11/glossary/#validator">validator</a>,
* If this node is a <a href="https://exonum.com/doc/version/0.12/glossary/#validator">validator</a>,
* returns its identifier.
* If this node is an <a href="https://exonum.com/doc/version/0.11/glossary/#auditor">auditor</a>,
* If this node is an <a href="https://exonum.com/doc/version/0.12/glossary/#auditor">auditor</a>,
* it will return {@code OptionalInt.empty()}.
*/
OptionalInt getValidatorId();
Expand Down
Expand Up @@ -34,7 +34,7 @@ public interface Node {
* the {@linkplain #getPublicKey() node service key}, and then submits it into Exonum network.
* This node does <em>not</em> execute the transaction immediately, but broadcasts it to all
* the nodes in the network. Then each node verifies the transaction and, if it is correct,
* adds it to the <a href="https://exonum.com/doc/version/0.11/advanced/consensus/specification/#pool-of-unconfirmed-transactions">pool of unconfirmed transactions</a>.
* adds it to the <a href="https://exonum.com/doc/version/0.12/advanced/consensus/specification/#pool-of-unconfirmed-transactions">pool of unconfirmed transactions</a>.
* The transaction is executed later asynchronously.
*
* <p>Incorrect transactions (e.g., the payload of which cannot be deserialized by the target
Expand Down
Expand Up @@ -51,7 +51,7 @@ public interface Service {
* and is supposed to
* <ul>
* <li>(a) initialize the database schema of this service, and</li>
* <li>(b) provide an initial <a href="https://exonum.com/doc/version/0.11/architecture/services/#global-configuration">global configuration</a>
* <li>(b) provide an initial <a href="https://exonum.com/doc/version/0.12/architecture/services/#global-configuration">global configuration</a>
* of the service.</li>
* </ul>
*
Expand All @@ -62,7 +62,7 @@ public interface Service {
* @param fork a database fork to apply changes to. Not valid after this method returns
* @return a global configuration of the service, or {@code Optional.empty()} if the service
* does not have any configuration parameters.
* @see <a href="https://exonum.com/doc/version/0.11/architecture/services/#initialization-handler">Initialization handler</a>
* @see <a href="https://exonum.com/doc/version/0.12/architecture/services/#initialization-handler">Initialization handler</a>
*/
default Optional<String> initialize(Fork fork) {
return Optional.empty();
Expand Down Expand Up @@ -115,7 +115,7 @@ default List<HashCode> getStateHashes(Snapshot snapshot) {
* @param node a set-up Exonum node, providing an interface to access
* the current blockchain state and submit transactions
* @param router a router responsible for handling requests to this service
* @see <a href="https://exonum.com/doc/version/0.11/get-started/java-binding/#external-service-api">
* @see <a href="https://exonum.com/doc/version/0.12/get-started/java-binding/#external-service-api">
* Documentation on service API</a>
*/
void createPublicApiHandlers(Node node, Router router);
Expand Down
Expand Up @@ -48,6 +48,6 @@
* <p>Until this limitation is fixed, care must be taken when using this feature, because
* the identifiers are not checked.
*
* @see <a href="https://exonum.com/doc/version/0.11/architecture/storage/#table-types">Exonum indexes reference documentation</a>
* @see <a href="https://exonum.com/doc/version/0.12/architecture/storage/#table-types">Exonum indexes reference documentation</a>
*/
package com.exonum.binding.core.storage.indices;
Expand Up @@ -19,8 +19,8 @@
/**
* An Exonum transaction.
*
* @see <a href="https://exonum.com/doc/version/0.11/architecture/transactions">Exonum Transactions</a>
* @see <a href="https://exonum.com/doc/version/0.11/architecture/services">Exonum Services</a>
* @see <a href="https://exonum.com/doc/version/0.12/architecture/transactions">Exonum Transactions</a>
* @see <a href="https://exonum.com/doc/version/0.12/architecture/services">Exonum Services</a>
*/
@FunctionalInterface
public interface Transaction {
Expand All @@ -43,7 +43,7 @@ public interface Transaction {
/**
* Returns the information about this transaction in JSON format.
* For example, it is included in the blockchain explorer response to
* a <a href="https://exonum.com/doc/version/0.11/advanced/node-management/#transaction">
* a <a href="https://exonum.com/doc/version/0.12/advanced/node-management/#transaction">
* transaction</a> request as 'content.debug'.
*
* <p>By default, no information is provided. If needed, it can be easily implemented
Expand Down
Expand Up @@ -29,7 +29,7 @@
*
* <p>An external client will get the error code and description when requests a transaction
* status of a failed transaction. See
* <a href="https://exonum.com/doc/version/0.11/advanced/node-management/#transaction">the API endpoint documentation</a>
* <a href="https://exonum.com/doc/version/0.12/advanced/node-management/#transaction">the API endpoint documentation</a>
* for more information.
*
* @see com.exonum.binding.common.blockchain.TransactionResult
Expand Down
Expand Up @@ -33,9 +33,9 @@
*
* <p>This class is thread-safe.
*
* @see <a href="https://exonum.com/doc/version/0.11/get-started/java-binding/#installation">
* @see <a href="https://exonum.com/doc/version/0.12/get-started/java-binding/#installation">
* Exonum Java installation instructions</a>
* @see <a href="https://exonum.com/doc/version/0.11/get-started/java-binding/#testing">
* @see <a href="https://exonum.com/doc/version/0.12/get-started/java-binding/#testing">
* Build configuration to enable integration testing of Java services</a>
*/
public final class LibraryLoader {
Expand Down Expand Up @@ -123,7 +123,7 @@ private static String extraLibLoadErrorInfo() {
+ "containing %s library, where 'EXONUM_HOME' denotes the Exonum Java app "
+ "installation directory.%n"
+ "The code launching tests must usually set this property explicitly, see "
+ "https://exonum.com/doc/version/0.11/get-started/java-binding/#testing",
+ "https://exonum.com/doc/version/0.12/get-started/java-binding/#testing",
JAVA_LIBRARY_PATH_PROPERTY, BINDING_LIB_NAME);
} else {
String dynamicLibVar = dynamicLibrariesEnvVar();
Expand Down Expand Up @@ -160,7 +160,7 @@ private void checkLibraryVersion() {
+ " Native library version: %s%n"
+ "Check that the version of 'exonum-java-binding-core' matches the version of "
+ "the installed 'Exonum Java' application.%n"
+ "See https://exonum.com/doc/version/0.11/get-started/java-binding/#installation",
+ "See https://exonum.com/doc/version/0.12/get-started/java-binding/#installation",
BINDING_LIB_NAME, expectedLibVersion, nativeLibVersion);
logger.fatal(message);
throw new LinkageError(message);
Expand Down
4 changes: 2 additions & 2 deletions exonum-java-binding/cryptocurrency-demo/Readme.md
Expand Up @@ -25,7 +25,7 @@ Be sure you installed necessary packages:
- [Node.js with npm](https://nodejs.org/en/download/)
- [Exonum Java][ejb-installation] application.

[ejb-installation]: https://exonum.com/doc/version/0.11/get-started/java-binding/#installation
[ejb-installation]: https://exonum.com/doc/version/0.12/get-started/java-binding/#installation

#### Build and Run

Expand Down Expand Up @@ -71,7 +71,7 @@ $ npm start -- --port=6040 --api-root=http://127.0.0.1:7000 --explorer-root=http
Ready! Find demo at [http://127.0.0.1:6040](http://127.0.0.1:6040).

## See Also
- [Reference Documentation](https://exonum.com/doc/version/0.11/get-started/java-binding).
- [Reference Documentation](https://exonum.com/doc/version/0.12/get-started/java-binding).
- [Instructions][app-tutorial] explaining how to configure and run any Java service.

[app-tutorial]: https://github.com/exonum/exonum-java-binding/blob/master/exonum-java-binding/core/rust/exonum-java/TUTORIAL.md
Expand Up @@ -10,7 +10,7 @@
<img src="images/exonum.png" width="41" height="36" class="float-left mt-sm-1 mr-3" alt="">
<ul class="list-unstyled">
<li>Sources on <a href="https://github.com/exonum/exonum-java-binding/tree/master/cryptocurrency-demo" target="_blank">GitHub</a></li>
<li><a href="https://exonum.com/doc/version/0.11/" target="_blank">Exonum docs</a></li>
<li><a href="https://exonum.com/doc/version/0.12/" target="_blank">Exonum docs</a></li>
</ul>
</div>
</div>
Expand Down
6 changes: 3 additions & 3 deletions exonum-java-binding/doc/Migration_guide_0.4.md
Expand Up @@ -73,22 +73,22 @@ v0.4 provides access to some data stored by the framework in the database: trans
execution results; blocks; node configuration, etc — take a look at [`Blockchain`][blockchain-jd]
to see if it will simplify your service implementation.

[core-schema-docs]: https://exonum.com/doc/version/0.11/get-started/java-binding#core-schema-api
[core-schema-docs]: https://exonum.com/doc/version/0.12/get-started/java-binding#core-schema-api
[blockchain-jd]: https://exonum.com/doc/api/java-binding-core/0.4/com/exonum/binding/blockchain/Blockchain.html

### [Handle blockchain events][core-events-docs]
v0.4 also brings `Service#afterCommit` handler which is invoked by the blockchain after each
block commit. For example, a service can create one or more transactions if a specific condition
has occurred.

[core-events-docs]: https://exonum.com/doc/version/0.11/get-started/java-binding#blockchain-events
[core-events-docs]: https://exonum.com/doc/version/0.12/get-started/java-binding#blockchain-events

### [Sign and submit transactions][node-submit-docs]
The framework now provides a method to create a transaction message and sign it with the
_service key_. This allows service implementations to create new transactions and securely sign
them, e.g., in their event handlers. But use with care — each node has its own service keypair.

[node-submit-docs]: https://exonum.com/doc/version/0.11/get-started/java-binding#messages
[node-submit-docs]: https://exonum.com/doc/version/0.12/get-started/java-binding#messages

## Use example
See how the cryptocurrency service has changed since the last release to understand what
Expand Down
6 changes: 3 additions & 3 deletions exonum-java-binding/doc/Migration_guide_0.6.md
Expand Up @@ -41,7 +41,7 @@ public final class CryptocurrencyServiceModule extends AbstractServiceModule {
</details>

[abstract-service-module-javadoc]: https://exonum.com/doc/api/java-binding-core/0.6.0/com/exonum/binding/service/AbstractServiceModule.html
[dep-management-docs]: https://exonum.com/doc/version/0.11/get-started/java-binding/#dependencies-management
[dep-management-docs]: https://exonum.com/doc/version/0.12/get-started/java-binding/#dependencies-management

### Service Packaging Requirements

Expand Down Expand Up @@ -137,8 +137,8 @@ Highlights of the project build definition from the cryptocurrency demo

</details>

[using-libraries-docs]: https://exonum.com/doc/version/0.11/get-started/java-binding/#using-libraries
[how-to-build-docs]: https://exonum.com/doc/version/0.11/get-started/java-binding/#how-to-build-a-service-artifact
[using-libraries-docs]: https://exonum.com/doc/version/0.12/get-started/java-binding/#using-libraries
[how-to-build-docs]: https://exonum.com/doc/version/0.12/get-started/java-binding/#how-to-build-a-service-artifact

### Use Example

Expand Down
2 changes: 1 addition & 1 deletion exonum-java-binding/doc/Migration_guide_0.7.md
Expand Up @@ -23,4 +23,4 @@ network. See the [documentation][testkit-documentation] for more information and
The 0.7.0 [release page][release-page] for the changelog and pre-built binaries.

[release-page]: https://github.com/exonum/exonum-java-binding/releases/tag/ejb/v0.7.0
[testkit-documentation]: https://exonum.com/doc/version/0.11/get-started/java-binding/#testing
[testkit-documentation]: https://exonum.com/doc/version/0.12/get-started/java-binding/#testing

0 comments on commit 83c3d9d

Please sign in to comment.