Bitmunk Transaction Platform Tutorials

From DBWiki

Contents 1 Introduction 2 Documentation 3 Download 4 Build Process 4.1 Prerequisites 4.2 Build Steps 5 Running Bitmunk Personal Edition 5.1 Starting the Client 5.2 Creating a Sandbox Account 5.3 Logging In 5.4 Performing a Purchase 6 Generating documentation 6.1 Prerequisites 6.2 Build Steps 7 More Information

Introduction

The Bitmunk Transaction Platform is a set of software used to provide digital content sales and distribution services to content creators, online stores, bloggers and website operators. The software is provided under an open source license for non-commercial purposes to help those that would want to use or extend the software the ability to do so. A different commercial-use license is available for companies that want to modify/extend the software for their own purposes.

We are always trying to help the little guy. If you would like to use the Bitmunk Transaction Platform technology in your start-up but cannot afford the commercial license - talk to us. We have been known to do very favorable deals with start-ups - sometimes striking near-term royalties completely or entering purely profit-sharing deals.

Documentation

Full documentation is provided for the entire Bitmunk software stack. You can browse the latest documentation latest documentation online.

Download

The source code for the Bitmunk Transaction Platform can be downloaded from this site.

Build Process

The build process has been made to be as simple and straightforward as possible. Follow the next steps and you should be able to build the system with relative ease.

Prerequisites

• An up-to-date Linux distribution that supports Java 5.0.
• Apache Ant - anything later than version 1.6.5 should be installed.
• GNU Autoconf - The latest version of GNU Autoconf should be installed.

Build Steps

1. Download and untar the source code distribution.

   tar jxvf bitmunk-2.0-source.tar.bz2

2. Enter the Bitmunk source directory.

   cd bitmunk-2.0-source/bitmunk/

3. Run GNU Autoconf in the source directory.

   autoconf

4. Run the generated configure script.

   ./configure

5. Make the necessary symbolic links for building.

   make links

6. Build all of the source code.

   ant clean build

The code should compile cleanly and you will be left with many jar files and a couple of script files. You can see which jar files were generated by running the following command.

find . -name "*\.jar"

Running Bitmunk Personal Edition

Starting the Client

1. Build the source code as directed on this page.
2. Enter the Bitmunk client source directory.

   cd bitmunk-2.0-source/bitmunk/BitmunkClient

3. Run the autoupdater script. This will launch Bitmunk Personal Edition.

   ./autoupdater

Creating a Sandbox Account

A sandbox website has been created so that you may create a test account, create fake money and play around with the system without the fear of causing any financial harm to yourself or anybody else on the network. To create and verify your account you must perform the following steps:

1. Create an account on the sandbox website.
2. Log into the sandbox website.
3. Verify your account information. You may use fake information for all of the fields as none of it is checked. You must:
   1. Fill out a name, and address (this information can be fake).
   2. Check the "I'm over 18" checkbox.
   3. Your fake credit card number needs to be exactly 16 numbers in length. For example: 1254458656852154.
   4. Your expiration date should be in the future.
4. Deposit money into your account. Again, this entire process is faked and no real money ever changes hands. Put about $100 in your account. Congratulations - you're rich!

Logging In

Once you have created your sandbox account through the website, you can log into the client. To log in, you must have started the client. You can then use the username and password you used to log into the website. When you log in for the first time, a profile is created for you in the bitmunk-2.0-source/bitmunk/BitmunkClient/profiles directory. DO NOT LOSE this profile as it contains your private key. Without it you cannot perform any SOAP calls or use the Bitmunk sandbox in any way.

Performing a Purchase

To perform a test purchase from the sandbox sales servers, do the following:

1. Log into Bitmunk Personal Edition.
2. Click on "Browse or Search" in the Welcome screen.
3. Enter "bitmunk" in the search box and click "Search".
4. Select "Bitmunk Squad Theme Song" and click "List Sellers".
5. Select the first seller "bitmunk-sales" and click "Select Seller".
6. Once the contract has been negotiated, click "Buy".
7. The download/decrypt phase will complete and the final MP3 file will be placed in your bitmunk-2.0-source/bitmunk/BitmunkClient/BitmunkWares directory.

Generating documentation

All classes contain very detailed documentation. Doxygen is used to generate the documentation.

Prerequisites

• Doxygen - The latest version of doxygen is required to generate the documentation.

Build Steps

1. Change your working directory to the source distribution directory.

   cd bitmunk-2.0-source/bitmunk/

2. Run doxygen.

   rm -rf docs/api-java; mkdir -p docs/api-java; doxygen docs/api.java.doxygen

More Information

If you would like to learn more about what is included in the Bitmunk source code distribution, you can peruse the Bitmunk class overview online. The Digital Bazaar Core class overview may also be of interest.