Setting up your workstation

This first guide will walk you through a step-by-step installation of the required tools to start developing with Symbol.

We will be using the test network, which uses the same technology and features of the future main public network. You can use the testnet to experiment with the offered Symbol’s transaction set in a live network without the loss of valuable assets.

Creating an account

An account is a deposit box where you can hold mosaics (tokens) and interact with them by announcing transactions.

Note

Symbol CLI requires Node.js 12 LTS to execute.

  1. Install Symbol CLI executing the following command in a new terminal:
npm install --global symbol-cli@0.19.2
  1. Generate a new account and save it as a profile.
symbol-cli account generate

Enter network type (MIJIN_TEST, MIJIN, MAIN_NET, TEST_NET): TEST_NET
Do you want to save the account? [y/n]: y
Enter Symbol Node URL. (Example: http://localhost:3000): http://api-01.ap-northeast-1.testnet-0951-v1.symboldev.network:3000/
Insert the profile name: testnet
Do you want to set the account as the default profile? [y/n]: y

Note

If the test network node is not working, you can use another node url from this list. You can also run your testnet node by following this guide.

  1. You should see the account credentials in your terminal.
Profile stored correctly
┌─────────────┬──────────────────────────────────────────────────────────────────┐
│ Property    │ Value                                                            │
├─────────────┼──────────────────────────────────────────────────────────────────┤
│ Address     │ TCVQ2R-XKJQKH-4RJZWG-DARWJ6-V4J4W7-F4DGH6-ZFAB                   │
├─────────────┼──────────────────────────────────────────────────────────────────┤
│ Public Key  │ 203...C0A                                                        │
├─────────────┼──────────────────────────────────────────────────────────────────┤
│ Private Key │ AAA...AAA                                                        │
└─────────────┴──────────────────────────────────────────────────────────────────┘

Note

The private key must be kept secret. Make sure your private key is backed up safely somewhere offline.

Getting test currency

To announce a transaction, the sender should pay a fee to provide an incentive to those who validate and secure the network and run the infrastructure. This cost is paid in symbol.xym mosaics, the default network currency of the public network.

Now that you have created your first account, try to request symbol.xym units from the testnet faucet. Navigate here, indicate the amount of symbol.xym you want to receive and the address, and click “CLAIM!”.

../_images/faucet.png

Note

If the default faucet is empty, try this other alternative faucet.

After the transaction gets confirmed, check if the account has received symbol.xym using the command-line tool.

symbol-cli account info --profile testnet

Balance Information
┌──────────────────┬─────────────────┬─────────────────┬───────────────────┐
│ Mosaic Id        │ Relative Amount │ Absolute Amount │ Expiration Height │
├──────────────────┼─────────────────┼─────────────────┼───────────────────┤
│ 05D6A80DE3C9ADCA │ 750.0           │ 750000000       | Never             │
└──────────────────┴─────────────────┴─────────────────┴───────────────────┘

Note

The faucet has a limited amount of symbol.xym and must be replenished before it dries. If you don’t need your test symbol.xym units anymore, please send them back to the account TA6W43-2Q3NHN-Q5HQSK-Q52XL7-MFJZQI-TJRYBI-LQGG.

Creating a project

Now that you have your account filled with symbol.xym units, it is the time to choose a programming language. Pick the one you feel most comfortable with, or follow your project requirements.

Then, create a folder for your new project and run the instructions for the selected language. If none of the languages fits your project, you can always query the blockchain directly using the REST gateway.

Note

Symbol SDK require Node.js 12 LTS to execute.

  1. Create a package.json file.
npm init
  1. Install Symbol SDK and RxJS library.
npm install symbol-sdk@0.19.2 rxjs
  1. Install globally TypeScript dependency:
npm install --global typescript
typescript --version
  1. Install ts-node to execute TypeScript files with node.
sudo npm install --global ts-node

Note

Symbol SDK requires Node.js 12 LTS to execute.

  1. Create a package.json file.
npm init
  1. Install Symbol SDK and RxJS library.
npm install symbol-sdk@0.19.2 rxjs

Note

Symbol SDK requires JDK 8 to execute.

  1. Open a new Java gradle project. Use your favourite IDE or create a project from the command line.
gradle init --type java-application
  1. Edit build.gradle to use Maven central repository.
repositories {
    mavenCentral()
}
  1. Add symbol-sdk as a dependency.
dependencies {
    compile "io.nem:symbol-sdk-vertx-client:0.19.0"
}
  1. Execute gradle build and gradle run to run your program.

Continue: Writing your first application.