Native Ramps SDK

Getting started

Installation

yarn add @consensys/native-ramps-sdk

or

npm install @consensys/native-ramps-sdk

Usage

import { NativeRampsSdk } from '@consensys/native-ramps-sdk'

// Initialize the SDK
const nativeRampsSdk = new NativeRampsSdk()

// Use the SDK methods

Version Management

To update the SDK version:

1. Update the version number in package.json:

   {
     "version": "1.0.1"
   }
   

2. Install dependencies to sync the version:

   npm install
   

The SDK automatically uses the version from package.json for all version-related functionality.

Local Development

For local development and testing of the SDK:

Building the SDK

1. Install dependencies:

   npm install
   

2. Build the SDK:

   npm run build
   

   This will:

   • Compile TypeScript files to JavaScript
   • Generate type declarations (.d.ts files)
   • Output everything to the dist/ directory

Testing Local Changes in Another Project

To test your local changes in another project without publishing:

1. Build the SDK (as shown above)

2. Copy the entire dist/ folder to your target project's node_modules/@consensys/native-ramps-sdk/ directory:

   # From your target project directory
   cp -r /path/to/native-ramps-sdk/dist/* ./node_modules/@consensys/native-ramps-sdk/dist/
   

3. Alternatively, you can use npm link for a more seamless development experience:

   # In the SDK directory
   npm link
   
   # In your target project directory
   npm link @consensys/native-ramps-sdk
   

Development Workflow

1. Make changes to the source code in src/
2. Run npm run build to compile your changes
3. Copy the updated dist/ files to your test project or use npm link
4. Test your changes in the target project
5. Repeat as needed

Other Useful Commands

• npm run test - Run tests
• npm run lint - Check code style
• npm run prettier - Format code
• npm run test:watch - Run tests in watch mode