FIMKrypto: NXT spinoff 30s blocks, POW-like rewards
Java JavaScript Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.settings Eclipse settings Dec 30, 2015
changelogs-fim 0.6.4 changelog Feb 16, 2016
changelogs Build readme and changelog updates Jun 3, 2015
conf Filter out hikari messages from log Feb 16, 2016
contrib File mode Feb 8, 2016
html Remove nxt client files Oct 9, 2015
installer File mode Feb 8, 2016
lib Blockchain replicator - mysql version Feb 16, 2016
logs Create the logs folder by the installer since it is need when working… Jun 3, 2015
resource Fix opening wallet from tray icon and log system.out and err messages… Apr 13, 2015
src Virtual order matcher and result filtering improvements Mar 4, 2016
test/java/nxt Merge tag '1.5.10' into merge-1.5.10 Sep 20, 2015
testlib Unit test prototype Sep 14, 2014
.classpath Update classpath include mysql jdbc connectors Feb 16, 2016
.gitattributes Maintain Unix new lines for .sh files + indentation Jan 25, 2015
.gitignore Merge tag '1.5.10' into merge-1.5.10 Sep 20, 2015
.project Remove bower_components Aug 14, 2014
3RD-PARTY-LICENSES.txt GPL, developer agreement and license info May 26, 2015
COPYING.txt GPL, developer agreement and license info May 26, 2015
DEVELOPERS-GUIDE.md Replaced all HTML containing translation strings for security reasons May 13, 2015
FIM_Wallet.url Update FIM_Wallet.url Jun 30, 2014
HEADER Copyright header Dec 30, 2015
LICENSE.txt GPL, developer agreement and license info May 26, 2015
OPERATORS-GUIDE.md updated docker files (not tested) and moved to contrib May 30, 2015
README.txt Update README Jan 19, 2016
USERS-GUIDE.md added initial versions of DEVELOPERS-GUIDE.md, OPERATORS-GUIDE.md, US… Nov 8, 2014
compile.sh Update compile script to use new GPG identity Feb 16, 2016
compile_with_keystore.sh Include update script with secure compiler Feb 16, 2016
gpl-2.0.txt Include gpl text Jan 19, 2016
h2.sh File mode Feb 8, 2016
h2_test.sh File mode Feb 8, 2016
h2_unit_test.sh File mode Feb 8, 2016
jar.sh File mode Feb 8, 2016
javadoc.sh File mode Feb 8, 2016
mint.bat File mode Feb 8, 2016
mint.sh File mode Feb 8, 2016
package.sh File mode Feb 8, 2016
release-package.sh File mode Feb 8, 2016
run-desktop.sh File mode Feb 8, 2016
run-tests.sh File mode Feb 8, 2016
run-tor.sh File mode Feb 8, 2016
run.bat File mode Feb 8, 2016
run.sh File mode Feb 8, 2016
update_fimk.sh FIMK update script Jan 28, 2016
win-compile.sh File mode Feb 8, 2016
win-javadoc.sh File mode Feb 8, 2016
win-package.sh File mode Feb 8, 2016
win-release-package.sh File mode Feb 8, 2016
win-run-tests.sh File mode Feb 8, 2016

README.txt

/******************************************************************************
 * Copyright © 2014-2016 FIMK Developers                                      *
 ******************************************************************************/

Welcome to FIMK.

FIMK is open source software and based on NXT 
(https://bitbucket.org/JeanLucPicard/nxt/overview). 

This is FIMK version 0.6.0 which is based on NXT 1.5.10.

FIMK 0.6.0 is a mandatory update, you must update to this version before:

                    Jan 18th 2016 - 21.00 GMT

Running the FIMK software:

Dependencies: Java 8 or later needs to be installed first. Only the Oracle JVM
has been tested and supported.

There is no installation needed. Unpack the zip package to a directory of your choice
and it will be populated with the lompsa.exe client and fim server directory.

RUNNING THE SERVER:

Execute the run.sh script if using Linux,
or run.bat if using Windows. This will start a java server process, which will
begin logging its activities to the console. The initialization takes a few
seconds. When it is ready, you should see the message 
"FIM server 0.6.0 (based on NXT 1.5.10) started successfully". 

THROUGH THE WEB BROWSER:

Run the server first. Open a browser, without stopping the java process, and go to
http://localhost:7886 , where the FIMK UI should now be available. 

Warning: It is better to use only latin characters and no spaces in the path
to the fim installation directory, as the use of special characters may result
in permissions denied error in the browser, which is a known jetty issue.

Customization:

There are many configuration parameters that could be changed, but the defaults
are set so that normally you can run the program immediately after unpacking,
without any additional configuration. To see what options are there, open the
conf/nxt-default.properties file. All possible settings are listed, with
detailed explanation. If you decide to change any setting, do not edit
nxt-default.properties directly, but create a new conf/nxt.properties file
and only add to it the properties that need to be different from the default
values. You do not need to delete the defaults from nxt-default.properties, the
settings in nxt.properties override those in nxt-default.properties. This way,
when upgrading the software, you can safely overwrite nxt-default.properties
with the updated file from the new package, while your customizations remain
safe in the nxt.properties file.

Technical details:

The FIMK software is a client-server application. It consists of a java server
process, the one started by the run.sh script, and a javascript user interface
run in a browser. To run a node, forge, update the blockchain, interact with
peers, only the java process needs to be running, so you could logout and close
the browser but keep the java process running. If you want to keep forging, make
sure you do not click on "stop forging" when logging out. You can also just
close the browser without logging out.

The java process communicates with peers on port 7864 tcp by default. If you are
behind a router or a firewall and want to have your node accept incoming peer
connections, you should setup port forwarding. The server will still work though
even if only outgoing connections are allowed, so opening this port is optional.

The user interface is available on port 7886. This port also accepts http API
requests which other FIMK client applications could use.

The blockchain is stored on disk using the H2 embedded database, inside the
fim_db directory. When upgrading, you should not delete the old fim_db
directory, upgrades always include code that can upgrade old database files to
the new version whenever needed. But there is no harm if you do delete the
fim_db, except that it will take some extra time to download the blockchain
from scratch.

In addition to the default user interface at http://localhost:7886 , the
following urls are available:

http://localhost:7886/test - a list of all available http API requests, very
useful for client developers and for anyone who wants to execute commands
directly using the http interface without going through the browser UI.

http://localhost:7886/test?requestType=<specificRequestType> - same as above,
but only shows the form for the request type specified.