wallaby-cash v1.7.4

Getting started

Overview

The SDK leverages Wallaby API as a gateway to web3 and the blockchain.

The SDK currently supports the following blockchains:

• Algorand
• Avalanche
• Bitcoin
• Ethereum
• Polygon

Install the SDK

  npm install wallaby-cash

Client Initialization

After installing the library, you can then import and use the SDK.

Some configuration params are optional depending on the endpoint. apiKey, baseUrl and clientAuthToken are always required, while userId and accessToken are only required for certain endpoints.

To initialize the Wallaby client, simply import the Wallaby class and pass the config object.

To understand how to generate and use the clientAuthToken you can refer to authentication docs here.

Example:

import { Wallaby } from 'wallaby-cash';

const config = {
	apiKey: "071b51027b412a1b8fcttt73684d25mi"
	baseUrl: "https://dev-testnet.wallaby.cash",
  clientAuthToken: `eyJhbGciOiJSUzI1NiJ9.  eyJleHRlcm5hbFVzZXJJZCI6IjU0MDc1ZWNmLWE3MjktNDUxNy05NmE1LTZkMzcwNzFmYTEzZSIsImV4cGlyYXRpb24iOiIyMDIzLTA0LTI1VDExOjU4OjExLTA1OjAwIiwiaGFzaF9zdHJpbmciOiIxOGU4ZDY1NWJmNjUwYmJkZWFlNWEzNjBkMTU1M2Q5YWVkYjU1MjI4NGYxOWZmMDViMzgxZWI0ZjcxNDA2MjQ2In0.jnsGd-H0rBXLQVHLKq2yMNLcvlDKOg1i863czVPLg0sDaO6hDLIez2zfhsEvGAZQCbYKWIAj7KmuCIFLGL5B74eu-__d_OzO2fTGJthzud-MlWcWAjXYnHjGS6WCZ5M_D_i-kyZow9N9SmSX4ccdFV4yPmQVYojqDqBAWlVXddU`,
  userId: "54075ecf-a729-4517-96a5-6d37071fa13e",
}

const wallaby = new Wallaby(config)

/**
 *  This will return all domains supported by wallaby (i.e auth, wallets, merchants, ...)
*	  Then it can be called like the example below
*/

wallaby.auth.refreshAccessToken()
wallaby.wallets.getTokenBalance()
wallaby.transactions.transfer()
wallaby.system.getSupportedBlockchains()

Dependencies

Required packages and functions used:

• eth-crypto: v2.6.0 (Latest)

  • createIdentity: Generates public/private key pair. Which are called clientAuthPubKey and clientAuthPrivKey in wallaby. To differentiate them from wallaby’s key pair. Which are called wallabyAuthPubKey and wallabyAuthPrivKey
  • hash: It uses keccak256 function to hash the message string coming from wallaby.
  • sign: It generates a signature from a hashed message (with client public key) and the client private key
  • encryptWithPublicKey: Encrypts a string (in our case the seed-phrase) using the public key.
  • decryptWithPrivateKey: decrypts a string (in our case the seed-phrase) with the private key.
  • publicKeyByPrivateKey: Generates the public key using the private key.

• crypto-js v4.1.1 (latest)

  • AES used to encrypt the private key with the password.
• axios v1.3.4 (latest)
  • create: used to instantiate an axios instance.