https://github.com/rairprotocol/rair-sdk
Simple developer SDK for RAIRprotocol
https://github.com/rairprotocol/rair-sdk
Last synced: about 1 year ago
JSON representation
Simple developer SDK for RAIRprotocol
- Host: GitHub
- URL: https://github.com/rairprotocol/rair-sdk
- Owner: rairprotocol
- License: apache-2.0
- Created: 2024-09-27T15:23:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-24T14:55:17.000Z (about 1 year ago)
- Last Synced: 2025-04-24T15:42:06.246Z (about 1 year ago)
- Language: TypeScript
- Size: 82 KB
- Stars: 1,633
- Watchers: 1
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Deploying Vibe Frontend Quickly
Clone this repository on your own GitHub account and deploy it to Netlify:
[](https://app.netlify.com/start/deploy?repository=https://github.com/rairprotocol/rair-sdk)
# rair-sdk
Simple developer SDK for RAIRprotocol. Note: Before you start you need an Admin NFT which can be minted here using Metamask and a small amount of Base Gas. If you need Base Gas please reach out to us. https://rairprotocol.xyz/collection/0x2105/0xfc3666266d129504dd6c713f9bce107747ae4aee/0/0
## Getting started
```
npm install @rair-protocol/sdk
```
After installing, you can import and initialize the SDK:
```ts
import { RairSDK } from "@rair-protocol/sdk";
const settings = {
serverURL, // URL for backend. Default sandbox URL to try if you haven't deployed your own backend rair-node yet http://35.226.25.117:5000
socketURL, // URL for socket. http://35.226.25.117:8080
};
export const rairSDK = new RairSDK(settings);
```
After Initializng the SDK here are the first things you can do to get a working dApp
## 1. Empty dApp with Authentication working (default frontend)
Follow these steps below to deploy our existing sample application
```ts
const getChallenge = async (userAddress: Hex, ownerAddress?: Hex) => {
const responseData = await rairSDK.auth.getChallenge({ // use getChallenge from auth folder
userAddress: userAddress,
intent: "login",
ownerAddress: ownerAddress || userAddress,
});
return responseData.response;
};
```
All requests what you need to use you can find in `src/API`
Some example:
For user lists
```ts
const { data } = await rairSDK.users.listUsers();
```
Request with arguments
```ts
const responseData = await rairSDK.notifications.listNotifications({
pageNum: pageNum,
});
```
To use the SDK you need to use rairSDK(exported above), select the desired file with requests and select the request
Example:
file - `src/API/users`
request - `findUserByUserAddress`
Result:
```ts
const userDataResponse = await rairSDK.users.findUserByUserAddress({
publicAddress: loginData.userAddress,
});
```
`publicAddress` is a required argument in this request
## 2. Example of deploying your own frontend that interacts with our SDK to make a new dApp
Demo project for rair sdk - https://github.com/rairprotocol/rair-official-library/tree/main/demo-rair-sdk
make `git clone https://github.com/rairprotocol/rair-official-library/tree/main/demo-rair-sdk` and `yarn` and `yarn start`