@pillarwallet/pillarwallet-nodejs-sdk v1.48.1899

Pillar Wallet SDK

The Pillar Wallet SDK aims to make it easy for developers to get started using Pillar Wallet backend services.

Contents

• Getting started
• Config
• Response and Error
• Methods
  • Wallet Update
  • Wallet Register Auth Server
  • Wallet Register Address
  • Wallet Unregister Address
  • Smart Wallet Register
  • Asset Defaults
  • Asset Search
  • Asset List
  • Connection Invite
  • Connection v2 Invite
  • Connection Accept
  • Connection Reject
  • Connection v2 Reject
  • Connection Cancel
  • Connection v2 Cancel
  • Connection Block
  • Connection v2 Block
  • Connection Mute
  • Connection v2 Mute
  • Connection Disconnect
  • Connection v2 Disconnect
  • Connection Count
  • Connection Map Identity Keys
  • Connection Update Identity Keys
  • Notification List
  • Investments ICO List
  • Investments Deposit Request
  • User Create One Time Password
  • User Delete
  • User Delete Profile Image
  • User Info
  • User Info Smart Wallet
  • User Image by User Id
  • User Info By Id
  • User Profile Image
  • User Search
  • User Update
  • User Upload Profile Image
  • User Update Notification Preferences
  • User Username Search
  • User Validate (deprecated)
  • User v2 Validate
  • User Validate Email
  • User Validate Phone
  • User Support Hmac
  • Referral Send Invitation
  • Referral Generate Token
  • Referral List
• Tests
• Coding Style Guide
• Versioning
• License
• Acknowledgments

Get Started

Install the npm package:

npm i @pillarwallet/pillarwallet-nodejs-sdk

In your project:

const { PillarSdk } = require('@pillarwallet/pillarwallet-nodejs-sdk');

A quick note on versioning

During the pipeline process, we need to automatically ensure that our version number is unique. To do this, we replace the last patch digit of the package.json's version setting with the current circle CI build number. It's a bit of a hack but it means we don't need to think about the version number before committing + pushing.

For example, if you give us version=2.3.1, and this is picked up by circle's 492nd build job, your package is published as version=2.3.492

Config

IMPORTANT! Complete these steps to use this SDK:

1 - Create An Instance

Instantiate the Pillar SDK, then set the apiUrl (optional) and notificationsUrl (optional).

const pillarSdk = new PillarSdk({
  apiUrl: 'https://localhost:8080',
  notificationsUrl: 'https://localhost:8081',
  investmentsUrl: 'https://localhost:8082',
});

Input Parameters

2 - Register the Wallet

To use backend services, register the wallet:

pillarSdk.wallet.registerAuthServer(inputParams)

Register the wallet in the backend, create the UserProfile table, and register the wallet in BCX(Blockchain Explorer). Wallet can not be created without username.

const inputParams = {
  fcmToken: 'cMctpybZfwyFTyRJBo4omxpgoF2JWf-tlJc8fB0Swrq0z7',
  privateKey: '3eA19bddb978Db62344Ffba5d37Ba41C83C579173eA19bddb978Db62344Ffba5d37Ba41C83C57917',
  username: 'bob123',
};

Input Parameters

Expected Output

Response And Error

To get the response and error for these methods, use:

try {
 const response = await pillarSdk.wallet.registerAuthServer({
   fcmToken: 'cMctpybZfwyFTyRJBo4omxpgoF2JWf-tlJc8fB0Swrq0z7',
   privateKey: '3eA19bddb978Db62344Ffba5d37Ba41C83C579173eA19bddb978Db62344Ffba5d37Ba41C83C57917',
   username: 'bob123'
 });
 // Use successful response
} catch (e) {
 // Handle unsuccessful response
}

Methods

IMPORTANT! All methods return promises.

Wallet Update

pillarSdk.wallet.update(inputParams)

Updates Fcm Token in the backend.

Input Parameters

Expected Output

Wallet Register Auth Server

pillarSdk.wallet.registerAuthServer(inputParams)

Register the wallet in the backend, authentication server(OAuth), create the UserProfile table, and register the wallet in BCX(Blockchain Explorer). Wallet can not be created without username.

Input Parameters

Expected Output

Wallet Register Address

pillarSdk.wallet.registerAddress(inputParams)

Register the specified blockchain address for notifications and for BCX monitoring

Input Parameters

Expected Output

Wallet Unregister Address

pillarSdk.wallet.unregisterAddress(inputParams)

Unregister the specified blockchain address for notifications and for BCX monitoring

Input Parameters

Expected Output

Asset Defaults

pillarSdk.asset.defaults(inputParams)

Returns a list of assets that are marked as default assets.

Input Parameters

Expected Output

JSON collection of objects with respective values:

Smart Wallet Register

pillarSdk.wallet.registerSmartWallet(inputParams)

Register a second wallet in the Backend and register in BCX.

Input Parameters

Expected Output

JSON collection of objects with respective values:

Asset Search

pillarSdk.asset.search(inputParams)

Returns a list of assets that contain the search criteria for name, token symbol, or smart contract hexadecimal address.

Input Parameters

Expected Output

JSON collection of objects with respective values:

Asset List

pillarSdk.asset.list(inputParams)

Returns the full list of assets.

Input Parameters

Expected Output

JSON collection of objects with respective values:

Connection Invite

pillarSdk.connection.invite(inputParams)

Creates a connection invitation for a user to create a relationship with another contact.

Input Parameters

Expected Output

Connection v2 Invite

pillarSdk.connectionV2.invite(inputParams)

Creates a connection invitation for a user to create a relationship with another contact.

Input Parameters

Expected Output

Connection Accept

pillarSdk.connection.accept(inputParams)

Accepts a connection invitation from another user.

Input Parameters

Expected Output

Connection v2 Accept

pillarSdk.connectionV2.accept(inputParams)

Accepts a connection invitation from another user.

Input Parameters

Expected Output

Connection Reject

pillarSdk.connection.reject(inputParams)

Rejects a connection invitation from another user.

Input Parameters

Expected Output

Connection v2 Reject

pillarSdk.connectionV2.reject(inputParams)

Rejects a connection invitation from another user.

Input Parameters

Expected Output

Connection Cancel

pillarSdk.connection.cancel(inputParams)

Cancels a connection invitation from another user.

Input Parameters

Expected Output

Connection v2 Cancel

pillarSdk.connectionV2.cancel(inputParams)

Cancels a connection invitation from another user.

Input Parameters

Expected Output

Connection Block

pillarSdk.connection.block(inputParams)

Blocks/unblocks a connection request from another user.

Input Parameters

Expected Output

Connection v2 Block

pillarSdk.connectionV2.block(inputParams)

Blocks/unblocks future communication from another contact.

Input Parameters

Expected Output

Connection v2 Blacklist

pillarSdk.connectionV2.blacklist(inputParams)

Adds/removes a user from another user's blacklist.

Input Parameters

Expected Output

Connection Mute

pillarSdk.connection.mute(inputParams)

Mutes/unmutes future communication from another contact.

Input Parameters

Expected Output

Connection v2 Mute

pillarSdk.connectionV2.mute(inputParams)

Mutes/unmutes future communication from another contact.

Input Parameters

Expected Output

Connection Disconnect

pillarSdk.connection.disconnect(inputParams)

Disconnects a connection between two users.

Input Parameters

Expected Output

Connection v2 Disconnect

pillarSdk.connectionV2.disconnect(inputParams)

Disconnects a connection between two users.

Input Parameters

Expected Output

Connection Count

pillarSdk.connection.count(inputParams)

Returns the number of connections a user has

Expected Output

Connection Map Identity Keys

pillarSdk.connection.mapIdentityKeys(inputParams)

Returns an array of user's connection mapped by identity keys

Expected Output

Connection Update Identity Keys

pillarSdk.connection.updateIdentityKeys(inputParams)

Updates the connection's identity keys

Expected Output

Notification List

pillarSdk.notification.list(inputParams);

Provides a list of notifications for a specific wallet user.

Input Parameters

Expected Output

JSON Notifications with respective values::

Investments ICO List

pillarSdk.investments.icoList(inputParams);

Fetch a list of ICOs for a given user.

Input Parameters

Expected Output

Investments Deposit Request

pillarSdk.investments.depositRequest(inputParams);

Request deposit account information/credentials from service provider.

Input Parameters

Expected Output

JSON Investments with respective values::

User Create One Time Password

pillarSdk.user.createOneTimePassword(inputParams);

Create a one-time password for email or phone store it on the user record, then send an email or sms to the wallet user.

Input Parameters

Expected Output

User Update

pillarSdk.user.update(inputParams);

Updates data elements on a wallet user.

Input Parameters

Expected Output

JSON collection of objects with respective values:

User Update Notification Preferences

pillarSdk.user.updateNotificationPreferences(inputParams);

Update notification preferences for given user.

Input Parameters

Expected Output

JSON object with respective values:

User Map Contacts Addresses

pillarSdk.user.mapContactsAddresses(inputParams);

Maps contacts smart wallet addresses for given user.

Input Parameters

Expected Output

JSON array with respective values:

User Image by User Id

 pillarSdk.user.imageByUserId(inputParams);

Get user's profile image using user's ID

Input Parameters

Expected Output

Redirects to an hosted image.

User Upload Profile Image

 pillarSdk.user.uploadProfileImage(inputParams);

Saves or updates user's profile image.

Input Parameters

Expected Output

User Profile Image

 pillarSdk.user.profileImage(inputParams);

Get user's profile image.

Input Parameters

Expected Output

Redirects to an hosted image.

User Info

pillarSdk.user.info(inputParams);

Retrieves information on an existing wallet user.

Input Parameters

Expected Output

JSON collection of objects with respective values:

User Info Smart Wallet

pillarSdk.user.infoSmartWallet(inputParams);

Retrieve information from a user and his wallets

Input Parameters

Expected Output

JSON collection of objects with respective values:

User Info by Id

 pillarSdk.user.infoById(inputParams);

Provides the user data by the target user id and users access keys

Input Parameters

Expected Output

User Search

pillarSdk.user.search(inputParams);

Provides a list of users that contain the search criteria for first or last name, and is not the current wallet user. Also checks if the search string term is at least two characters and if the user allows their profile to be searched.

Input Parameters

Expected Output

User Delete

 pillarSdk.user.delete(inputParams);

Removes a wallet user profile from the database.

Input Parameters

Expected Output

User Delete Profile Image

 pillarSdk.user.deleteProfileImage(inputParams);

Removes user profile Image from the database.

Input Parameters

Expected Output

HTTP status 204: No Content

User Username Search

pillarSdk.user.usernameSearch(inputParams);

Retrieve the userId of an existing wallet user or return not-found. Returns an error message if the username is Inappropriate.

Input Parameters

Expected Output

Expected Output for Inappropriate username

User Validate (deprecated)

pillarSdk.user.validate(inputParams);

Retrieve the id of an validated wallet user.

Input Parameters

Expected Output

User v2 Validate

pillarSdk.userV2.validate(inputParams, privateKey);

Validates a blockchain address, and returns user and wallet information

Input Parameters

Expected Output

User Validate Email

pillarSdk.user.validateEmail(inputParams);

Validate a one-time password sent via email.

Input Parameters

Expected Output

User Validate Phone

pillarSdk.user.validatePhone(inputParams);

Validate a one-time password sent via SMS.

Input Parameters

Expected Output

User Support Hmac

pillarSdk.user.supportHmac(inputParams);

Input Parameters

Expected Output

Referral List

pillarSdk.referral.list(inputParams);

Returns a list of referral invitations

Input Parameters

Expected Output

Referral Send Invitation

pillarSdk.referral.sendInvitation(inputParams);

Sends an invitation through Email or SMS

Input Parameters

Expected Output

Referral Generate Token

pillarSdk.referral.generateToken(inputParams);

Generates a referral token invitation

Input Parameters

Expected Output

Types

Asset

SocialMedia

ICO

ICOLink

Tests

Run the test:

npm test

or:

jest

Coding Style Guide

We use the TSLint Config Airbnb Style Guide.

Versioning

We use Swagger for versioning.

License

This project is licensed under the MIT license.

Acknowledgments

We use the Pillar Authentication SDK to create signatures.