@sorosan-client/react

The Sorosan SDK for React

Welcome to the Sorosan SDK (React), your key to unlocking a seamless development experience on the Stellar network. The Sorosan SDK (React) empowers developers to tap into the full potential of Stellar with unparalleled ease. As we embark on this exciting journey together, be sure to stay tuned for our upcoming features and releases. Give us a star and watch our progress to stay in the loop!

For usage in other node or web applications, check out @sorosan-client/core.

Install

To use as a module in a Node.js project

1. Install it using npm:

npm install --save @sorosan-client/react

2. require/import it in your JavaScript/Typescript:

// layout.tsx or app.tsx
import { SorosanProvider } from '@sorosan-client/react'

export default function Component() {
    const { sdk } = useSorosan();

    return (
        // Currently only support futurenet and testnet
        <SorosanProvider network="futurenet | tesnet">
            {children}
        </SorosanProvider>
    )
}

3. use useSorosanSDK() hook to load in SDK in components

// Component.tsx
import { useState } from "react";
import { useSorosanSDK } from '@sorosan-client/react';

export const Component = () => {
    const { sdk } = useSorosanSDK();

    // ...
};

To use as a module locally

1. Clone this repo

git clone https://github.com/sorosan/sorosan-client-react

1. Install packages and build

cd sorosan-sdk-react
npm i
npm run build

This should generate a dist/ where you can use SorosanProvider in React app

Testing

npm run test

Documentation

Documentation source for repo can be found here

Others

• Sorosan App
• Documentation
• Core SDK
• Sample App using Sorosan SDK