aorbit-sdk v1.0.26

Aorbit SDK

This repository contains most of the packages that make up the upper layers of the Aorbit platform. If you want to build on top of this platform,

An SDK for interacting with the Aorbit program.

*We currently support TypeScript.

Table of Contents:

• Getting Started
• Getting Help
• Contributing

Getting Started

How To Install

Set up the .env file

# Network
NETWORK = "devnet"

# Endpoint
MAINNET_RPC_ENDPOINT="https://api.mainnet.solana.com"
TESTNET_RPC_ENDPOINT=""
DEVNET_RPC_ENDPOINT="https://api.devnet.solana.com"
LOCALHOST_RPC_ENDPOINT="http://127.0.0.1:8899"

# IPFS Endpoint
IPFS_WEBSITE_LINK="https://ipfs.io/ipfs"
IPFS_LOCATION_LINK="http://localhost:5001/api/v0"

# Program Address
MAINNET_PROGRAM_ADDRESS=""
TESTNET_PROGRAM_ADDRESS=""
DEVNET_PROGRAM_ADDRESS="9VEY22sboDBLCCzXN3gQcUN4o1UM3zfzchNtpZN8GFow"
LOCALHOST_PROGRAM_ADDRESS=""

# Mnemonic For Testing
PAYER_MNEMONIC=""
DEST_MNEMONIC=""

In the Browser

To use the SDK in the browser, simply add the following script tag to your HTML pages:

<script src=""></script>

In Node.js

The preferred way to install the AORBIT SDK for Node.js is to use the npm package manager for Node.js. Simply type the following into a terminal window:

npm install aorbit-sdk

In React Native

To use the SDK in a react native project, first install the SDK using npm:

npm install aorbit-sdk

Then within your application, you can reference the react native compatible version of the SDK with the following:

var IMPL = require('aorbit-sdk');

or

import { IMPL } from 'aorbit-sdk';

Usage with TypeScript

The AORBIT SDK for JavaScript bundles TypeScript definition files for use in TypeScript projects and to support tools that can read .d.ts files.

Our goal is to keep these TypeScript definition files updated with each release for any public api.

Getting Help

The best way to interact with our team is through GitHub.

You can open an issue and choose from one of our templates for bug reports, feature requests or guidance.

You may also find help on community resources such as StackOverFlow with the tag #aorbit-sdk.

If you have a support plan with AORBIT Support, you can also create a new support case.

Contributing

We welcome community contributions and pull requests. See CONTRIBUTING.md for information on how to set up a development environment and submit code.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE and NOTICE.txt for more information.