SDK Integration

Initialize SDK

Suggest Edits

Account

Liminal is currently invite-only with concierge onboarding. Please Request Access here to get on-boarded on Liminal.

You will receive an onboarding kit with credentials that will provide you access to the Liminal platform so you can start integrating digital assets into your application.

Steps to get integrate Liminal SDK

  1. Request API and SDK access
  2. Onboarding Installation
  3. Quicking Onboarding and Create Wallet Using liminal CLI
  4. Start integrating wallets in your application

SDK - CLI Initialization

Prerequisites to complete the setup by using SDK CLI utility:-

➝ Ubuntu 20.04 LTS Version
➝ AWS CLI, GIT, NPM, NodeJS14 Installed
➝ JavaScript / TypeScript Environment Empty Project
➝ AWS Account with Programmatic Access Keys, KMS Access( To Create New Keys ), and Access to ➝ Create EC2, RDS, and Security Groups.

Requirements for an EC2 Instance:-

➝ Application and OS Image ➝ Ubuntu Server 20.04 LTS (HVM) - SSD Volume Type.
➝ Instance Type ➝ t3.medium.
➝ Network Settings ➝ Allow both HTTP and HTTPS traffic.
➝ Storage ➝ 10 GB.

Follow the below steps to create your first wallet and start doing transaction

Request API and SDK access

Once Access is granted, the download SDK Button gets enabled as shown below:

Then, Click on the download button, and the SDK is now downloaded on your Local Machine :

Now, Click on Generate API Keys dropdown and then on Generate Key :

After Clicking, Client ID and Secret ID are generated.

NOTE:- Client ID and Client Secret ID are generated Once. Please Store it Carefully

Onboarding Installation

Click on the Below Recipe: -

  1. For Ubuntu Machines
🦉
SDK Onboarding (Ubuntu Machines)
Open Recipe
  1. For Mac Machines
🦉
SDK Onboarding (Mac Machines)
Open Recipe

Quick Onboarding and Create Wallet Using liminal CLI

Let's Create an Ethereum(ETH) Wallet both WIthdrawal and Deposit using CLI :

Prerequisites :

Keeping the following handy may be of good help :

  1. CLIENT ID and CLIENT SECRET ID
  2. KMS key (To Sign Transactions)

Now, let's start the CLI 

npm run start:cli

Now, the first step is to setup the provider :

For AWS, select Quick Onboarding -AWS, then enter your AWS KEY ID, and then Enter:

Then, add your AWS Secret Access Key and then Enter:

Then, Region Name and then Enter:

Then, Output format and then Enter:

For New, Select Add new AWS KMS Key and Enter :

Then enter Aws Region and Enter. Now Select Environment (test/prod):

Now Enter your Client ID and Secret ID which were created when you generated API in the Dev Section :

Then, Signer keys will be generated in your infrastructure, and then enter 'y' when asked to continue :
Note: Liminal will not generate any client keys in our infrastructure.

Now, Once Public Signer keys are generated, it will take to the Main Menu. Select Generate Wallet now

Then, Select Wallet Type - Withdrawal :

Now, select the coin for which you want to make a wallet (In this case, ETH ):

Now, The Wallet is created and asks " Do you want to create another chain wallet [y/n] ? ", type n and press Enter. And it will take you to the Main Menu again.

Now, that the withdrawal wallet is created. We will go for the creation of the Deposit Wallet.

Before, creating the deposit Wallet, we need to do the MPC Server Setup as ETH Deposit requires the MPC server to be created.

After you have created the withdrawal wallet, then you click on "n", to come back to Main Menu :

Then click on the Quick Onboarding MPC :

Then, Click on the page down/page up arrow to see the input fields to enter your MPC credentials:

The following four credentials are to be provided:-

  1. URL =>"MPC_URL"
  2. userID =>"MPC_USER_ID"
  3. Password =>"MPC_PASSWORD"
  4. Public Key =>"MPC_PUBLIC_KEY"

Then, Signer keys will be generated in your infrastructure, and then enter 'y' when asked to continue :
Note: Liminal will not generate any client keys in our infrastructure.

Now, After MPC Setup, we can generate a deposit wallet. Now on Main Menu, Click on Generate Wallet:

Then Click on Deposit :

Now, select the coin for which you want to make a wallet (In this case, ETH ):

Now, your Deposit Wallet is also ready.

Yipee !!! Now, Both Deposit and Withdrawal Wallets are created and ready for a transaction.

Note :
-> UTXO-Based Coins Wallet Address is not displayed though created, in case of non-UTXO-based coins Wallet Address is displayed.
-> For each type of coin chain, only two wallets can be created i.e. One Deposit Wallet and One Withdrawal Wallet. Trying to create another wallet for the same chain will show the following response creating no Wallet:

The step-by-step wallet creation process can also be followed here

https://www.youtube.com/watch?v=iZxhKjUEnK8

Updated 4 months ago