Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tsirysndr/ost-sdk-go
OST Platform SDK for Go
https://github.com/tsirysndr/ost-sdk-go
blockchain-platform brand-tokens economy go ost sdk
Last synced: 28 days ago
JSON representation
OST Platform SDK for Go
- Host: GitHub
- URL: https://github.com/tsirysndr/ost-sdk-go
- Owner: tsirysndr
- License: mit
- Created: 2020-01-03T22:40:52.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-01-29T19:36:12.000Z (almost 5 years ago)
- Last Synced: 2023-03-08T05:43:29.927Z (almost 2 years ago)
- Topics: blockchain-platform, brand-tokens, economy, go, ost, sdk
- Language: Go
- Homepage: https://dev.ost.com/
- Size: 39.1 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OST Go SDK
OST Platform SDK for Go
## Introduction
OST is a complete technology solution enabling mainstream businesses
to easily launch blockchain-based economies without
requiring blockchain development.
At the core of OST is the concept of OST-powered Brand Tokens (BTs).
BTs are white-label cryptocurrency tokens with utility representations
running on highly-scalable Ethereum-based side blockchains,
backed by OST tokens staked on Ethereum mainnet. Within a business’s
token economy, BTs can only be transferred to whitelisted user addresses.
This ensures that they stay within the token economy.
The OST technology stack is designed to give businesses everything they need
to integrate, test, and deploy BTs. Within the OST suite of products, developers
can use OST Platform to create, test, and launch Brand Tokens backed by OST.
OST APIs and server-side SDKs make it simple and easy for developers to
integrate blockchain tokens into their apps.
## Requirements
Integrating an OST SDK into your application can begin as soon as you create an account
with OST Platform, requiring only three steps:
1. Sign-up on [https://platform.ost.com](https://platform.ost.com).
2. Create your Brand Token in OST Platform.
3. Obtain an API Key and API Secret from [https://platform.ost.com/mainnet/developer](https://platform.ost.com/mainnet/developer).
## Documentation
[https://dev.ost.com/](https://dev.ost.com/)
## Installation
```bash
> go get github.com/tsirysndr/ost-sdk-go
```
## Getting Started
Import the package into your project.
```Go
import "github.com/tsirysndr/ost-sdk-go"
```
Construct a new OST client, then use the various services on the client to access different parts of the OST API. For example:
```Go
// the latest valid API endpoint is "https://api.ost.com/mainnet/v2/"
config := ost.Config{
Endpoint: "",
ApiKey: "",
ApiSecret: "",
}
client := ost.NewClient(config)
```
## SDK Modules
If a user's private key is lost, they could lose access
to their tokens. To tackle this risk, OST promotes a
mobile-first approach and provides mobile (client) and server SDKs.
* The server SDKs enable you to register users with OST Platform.
* The client SDKs provide the additional support required for
the ownership and management of Brand Tokens by users so
that they can create keys and control their tokens.
### Users Module
To register users with OST Platform, you can use the services provided in the Users module.
Create a User with OST Platform:
```Go
r, _ := client.Users.Create()
res, _ := json.Marshal(r)
fmt.Println(string(res))
```
Get User Detail:
```Go
r, _ := client.Users.Get("b6504ca4-9263-4998-8036-c90e648c48de")
res, _ := json.Marshal(r)
fmt.Println(string(res))
```
Get Users List:
```Go
r, _ := client.Users.GetList()
res, _ := json.Marshal(r)
fmt.Println(string(res))
```
## Coverage
Currently the following services are supported:
- [x] Create User
- [x] Get User
- [x] List Users
- [x] Register Device
- [x] Get Device
- [ ] List Devices in the Economy
- [x] List Devices of a User
- [x] Get Session
- [ ] List Sessions in the Economy
- [x] List Sessions of a User
- [x] List All Rules
- [x] Get Price Point
- [x] Execute Company to User Transaction
- [x] Get Transaction
- [ ] List Transactions in the economy
- [x] List Transactions of a user
- [x] Get Balance
- [x] Get Token
- [x] Get Recovery Owner
- [x] Get Chain Information
- [ ] Get Device Manager
- [x] Get Available Base Token
- [ ] Create WebHook
- [ ] Get WebHook
- [ ] List WebHooks
- [ ] Update WebHook
- [ ] Delete WebHook
## Author
👤 **Tsiry Sandratraina**
* Twitter: [@tsiry_sndr](https://twitter.com/tsiry_sndr)
* Github: [@tsirysndr](https://github.com/tsirysndr)
## Show your support
Give a ⭐️ if this project helped you!