wallaby-cash
v2.2.2
Published
The SDK leverages Wallaby API as a gateway to web3 and the blockchain.
Readme
Wallaby Cash SDK
The SDK leverages Wallaby API as a gateway to web3 and the blockchain.
Overview
The SDK currently supports the following blockchains:
- Algorand
- Aptos
- Avalanche
- Base
- Binance chain
- Bitcoin
- Bsc
- Canton
- Ethereum
- Hedera
- Injective
- Polygon
- Polymesh
- Sei
- Sui
Install the SDK
npm install wallaby-cash@latestClient 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()Generated API
The wallaby-sdk-js includes automatically generated TypeScript types from the API Swagger specification:
- Types are generated automatically during build process from
https://staging-testnet.wallaby.cash/swagger-json - Generated files location:
src/generated/ - Error codes included: All API error codes are available as TypeScript enums
- Local development: Use
npm run generate:types:localto generate from localswagger.json - Custom API endpoint: Set
WALLABY_SWAGGER_URLenvironment variable
