subject and message must be encoded in base64. TTL is only available in PyBitmessage version 0.4.5 and higher. TTL is specified in seconds values outside the bounds of 3600 to 2419200 will be moved to be within those bounds. If used, the encodingType must be set to 2 this is included for forwards compatibility. subject and message must be encoded in base64 which may optionally include line breaks. msgid is encoded in hex just like in the getAllInboxMessages function. Returns a simple message saying that the message was trashed assuming it ever even existed. Returns a list of objects with these properties: The base64 encoding Bitmessage uses includes line breaks including one on the end of the string. The msgid is the same as the hash of the message (analogous to the TXID in Bitcoin) thus it should be given in hex as that is the de facto standard. Optionally sets the specific message to have a read status of 'read' (bool). Returns a list of msgids of all Inbox messages with there properties: The msgid is the same as the hash of the message (analogous to the TXID in Bitcoin) thus it is shown in hex as that is the de facto standard. read (integer representing binary state (0 or 1)).Warning: At present, Bitmessage gets confused if you use both this API command and the UI to make addresses at the same time.ĭoes not include trashed messages. streamNumber must be set to 1 as this is the only one currently supported. addressVersionNumber should be set to 3 or 4 as these are the only ones currently supported. Similar to createDeterministicAddresses except that the one address that is returned will not be added to the Bitmessage user interface or the keys.dat file. Warning: At present, Bitmessage gets confused if you use both the API and the UI to make addresses at the same time. This list will be empty if the addresses already existed.
totalDifficulty and smallMessageDifficulty default to 1. Using zero for each of these fields is recommended. addressVersionNumber and streamNumber may be set to 0 which will tell Bitmessage to use the most up-to-date addressVersionNumber and the most available streamNumber. Similar to createRandomAddress except that you may generate many addresses in one go. Warning: At present, Bitmessage gets confused if you use both the API and the UI to make an address at the same time. Note that even if you don't ask for it, there is still a 1 in 256 chance that you will get an address with an 18 byte RIPE hash so if you actually need an address with a 19 byte RIPE hash for some reason, you will need to check for it. Using False is recommended if you are running some sort of website and will be generating a lot of addresses. This is the same setting as the "Do extra work to make the address 1 or 2 characters shorter" in the user interface. eighteenByteRipe is a boolean telling Bitmessage whether to generate an address with an 18 byte RIPE hash(as opposed to a 19 byte hash). Ĭreates one address using the random number generator. This is called listAddresses 2 because 'listAddresses' is obsolete. Lists all addresses shown on the Your Identities tab. Used as a simple test of the API.ĭisplays the message in the status bar on the GUI Required arguments are denoted inside Optional arguments are inside. In order to connect with the remote copy of PyBitmessage, these settings must match those in PyBitmessage's "keys.dat" file.Ī more complete example can be found in the api_client.py file in the PyBitmessage source code.
Bitmessage alias password#
In this example, the username is "username", the password is "password", the IP address of the server running PyBitmessage is 105.168.1.0 (a random example), and the port number which PyBitmessage has been configured to listen on is 8442.
Bitmessage alias how to#
The following Python code offers a demonstration of how to create a client that can connect to the PyBitmessage API. To access the Bitmessage API from a remote location, change the apiinterface value from 127.0.0.1 to 0.0.0.0.
Be sure your program doesn't crash when given newer arguments introduced in the future as this list will likely expand. One of these arguments will be passed to your program: startingUp, newMessage, newBroadcast.
Note that the values "username" and "password" below are merely examples, and should be replaced by values that cannot feasibly be guessed:Īdditionally, you may optionally include an additional entry which will specify a program which Bitmessage will run when certain events occur. To enable the API, copy and paste these lines into the bitmessagesettings section of the keys.dat file.
0 kommentar(er)
