Getting Started

How to set up RAILGUN Wallet SDK for your crypto wallet

Installation

You may install the Wallet SDK and Shared Models with npm or yarn. We are currently making major improvements to the latest versions of the SDKs. For now, please use the stable versions listed below.

npm install @railgun-community/wallet@10.1.2 @railgun-community/shared-models@7.3.1

-or-

yarn add @railgun-community/wallet@10.1.2 @railgun-community/shared-models@7.3.1

RAILGUN uses a custom Ethers v6 fork which includes some features that make balance scanning and transactions more reliable.

yarn add github:Railgun-Community/ethers.js#v6.7.10

Next steps

In the following steps, we'll cover Wallet SDK initialization:

1. Start the RAILGUN Privacy Engine

2. Build a persistent store for artifact downloads

3. Load the prover for each platform

4. Add networks and RPC providers

5. Set up a debug logger