Bitseal - Revision history

AyrA: added external template

2014-10-19T11:11:45Z

added external template

JonathanCoe: Removed duplicate text

2014-10-16T10:38:14Z

Removed duplicate text

JonathanCoe: Big update to include all API commands and errors

2014-10-16T10:33:05Z

Big update to include all API commands and errors

JonathanCoe: Created page

2014-10-16T09:56:23Z

Created page

New page

Bitseal is a Bitmessage client for Android, currently in Beta.

=== Bitseal Server ===

The Bitseal server code can be found at: (https://github.com/JonathanCoe/bitseal-server)

The Bitseal server application is a slightly modified version of PyBitmessage: (https://github.com/bitmessage/pybitmessage)

See also Bitseal's main respository: (https://github.com/JonathanCoe/bitseal)

=== Instructions for setting up bitseal-server ===

1) Download the zip file of the source code from Github

2) Extract the source code files to the desired location on your server

3) Run bitmessagemain.py

4) After a few seconds, stop PyBitmessage. PyBitmessage will have created a keys.dat file, which you can now use to specify your API settings

5) Open the keys.dat file. You can find its location using this reference: https://bitmessage.org/wiki/Keys.dat

6) Add the following lines to the "bitmessagesettings" section of the keys.dat file, replacing the port number, username, and password values as appropriate:

daemon = true 
apienabled = true 
apiport = YOUR_API_PORT_NUMBER 
apiinterface = 0.0.0.0 
apiusername = YOUR_API_USERNAME 
apipassword = YOUR_API_PASSWORD 

7) Save and close the keys.dat file

8) Ensure that your server's firewall is set up allowing incoming + outgoing TCP connections on port 8444 (PyBitmessage default) and the API port you specified in the keys.dat file

9) Run bitmessagemain.py

10) Open Bitseal and add your server's URL, API username, and API password via the 'Server Settings' page

11) Done!

=== Bitseal Server API ===
Required arguments are denoted inside < and > Optional arguments are inside [ and ].
{|class="wikitable"
! Command !! Parameters !! Minimum Version !! Description
|-
| add || <integer> <integer> || 0.2.7 || returns the sum of the integers. Used as a simple test of the API.
|-
|}

==== API errors ====

Here are the various error codes and messages you might see. Parts of the error messages in BLOCK_CAPITALS are variable fields that will change based on the data involved in the error.

{|class="wikitable"
! Error Number!! Message
|-
| 000 || API Error 000: 'I need NUMBER_OF_PARAMETERS parameters!'
|-
| 001 || API Error 001: 'Decode error - DECODE_EXCEPTION_MESSAGE. Had trouble while decoding string: YOUR_STRING'
|-
| 002 || API Error 002: 'The address version cannot be less than ADDRESS_VERSION_NUMBER'
|-
| 003 || API Error 003: 'Address versions above ADDRESS_VERSION_NUMBER are currently not supported'
|-
| 004 || API Error 004: 'The length of hash should be 20 bytes (encoded in hex and thus 40 characters).'
|-
| 005 || API Error 005: 'The length of tag should be 32 bytes (encoded in hex and thus 64 characters).'
|-
|}

← Older revision		Revision as of 11:11, 19 October 2014
Line 1:		Line 1:
		+	{{Template:External}}
		+
		+
	Bitseal is a Bitmessage client for Android, currently in Beta.		Bitseal is a Bitmessage client for Android, currently in Beta.

← Older revision		Revision as of 10:38, 16 October 2014
Line 1:		Line 1:
	Bitseal is a Bitmessage client for Android, currently in Beta.		Bitseal is a Bitmessage client for Android, currently in Beta.

−	~~=== Bitseal Server ===~~

−	~~The Bitseal server code can be found at: (https://github.com/JonathanCoe/bitseal-server)~~
−
−	~~The Bitseal server application is a slightly modified version of PyBitmessage: (https://github.com/bitmessage/pybitmessage)~~
−
−	~~See also Bitseal's main respository: (https://github.com/JonathanCoe/bitseal)~~
−
−
−	~~=== Instructions for setting up bitseal-server ===~~
−
−	~~1) Download the zip file of the source code from Github~~
−
−	~~2) Extract the source code files to the desired location on your server~~
−
−	~~3) Run bitmessagemain.py~~
−
−	~~4) After a few seconds, stop PyBitmessage. PyBitmessage will have created a keys.dat file, which you can now use to specify your API settings~~
−
−	~~5) Open the keys.dat file. You can find its location using this reference: https://bitmessage.org/wiki/Keys.dat~~
−
−	~~6) Add the following lines to the "bitmessagesettings" section of the keys.dat file, replacing the port number, username, and password values as appropriate:~~
−
−	~~daemon = true <br>~~
−	~~apienabled = true <br>~~
−	~~apiport = YOUR_API_PORT_NUMBER <br>~~
−	~~apiinterface = 0.0.0.0 <br>~~
−	~~apiusername = YOUR_API_USERNAME <br>~~
−	~~apipassword = YOUR_API_PASSWORD <br>~~
−
−	~~7) Save and close the keys.dat file~~
−
−	~~8) Ensure that your server's firewall is set up allowing incoming + outgoing TCP connections on port 8444 (PyBitmessage default) and the API port you specified in the keys.dat file~~
−
−	~~9) Run bitmessagemain.py~~
−
−	~~10) Open Bitseal and add your server's URL, API username, and API password via the 'Server Settings' page~~
−
−	~~11) Done!~~
−
−
−	~~Bitseal is a Bitmessage client for Android, currently in Beta.~~
−
−
−	~~=== ===~~
	== Bitseal Server ==		== Bitseal Server ==

@@ Line 2: / Line 2: @@
 === Bitseal Server ===
 The Bitseal server code can be found at: (https://github.com/JonathanCoe/bitseal-server)
@@ Line 45: / Line 90: @@
 Required arguments are denoted inside < and >  Optional arguments are inside [ and ].
 {|class="wikitable"
-! Command !! Parameters !! Minimum Version !! Description
+! Command !! Parameters !! On Success Returns !! On Failure Returns !! Description
 |-
-| add || <integer> <integer> || 0.2.7 || returns the sum of the integers. Used as a simple test of the API.
+| add || <integer> <integer> || An integer which is the sum of the two parameters || An API error || Returns the sum of the integers. Used as a simple test of the API.
 |-
 |}
@@ Line 70: / Line 125: @@
 |-
 | 005 || API Error 005: 'The length of tag should be 32 bytes (encoded in hex and thus 64 characters).'
 |-
 |}