Skip to content

Releasing version 2.0.0
Compare
Choose a tag to compare
@kedarchandrayan kedarchandrayan released this 28 Mar 13:29
· 2 commits to release-2.0 since this release
v2.0.0
b2a6364
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

OST APIs and Server Side SDKs make it simple and easy for developers to integrate brand tokens into their apps. The SDKs provide various methods for different services like users, tokens, transactions, wallet services corresponding to an end-user of the economy. They facilitate interaction between wallet SDK and openst-contracts to support a better UX for application users interacting with blockchain-based Brand Tokens. 

These SDKs are designed so that the server side components can support different approaches. They will be used for server to server interactions and they will be paired with the relevant wallet SDK. They can also be paired with your web application.  They expose the following features to establish the communication between the client company's server, wallet SDK and contracts are written under OpenST Protocol:

Economy User registration

User registration on OST platform via the server SDKs enables the servers to communicate user's related tasks information with the client company servers & OST wallet SDK. This is the first step towards creating a user's wallet.

User's device registration

To establish a relation between devices that a user owns to access the token economy and the user_id, the server SDKs enables registering a device against a user. Using this service the device public address is fetched from the user's device and processed to be included in the device manager (multisig) contract.

Recovery support

 Smart-contract enabled recovery of Brand Token wallets is achieved by combining

  • a 6 digit PIN from a user,
  • input from the client company and
  • one from OST (salt).

Using these inputs a recoveryKey is created that can be used to initiate a recovery request that authorizes a new device. 

OST Server side SDKs provide methods for fetching the "Salt" and communicating recovery or device authorization statuses.

Executing company-to-user transactions

In order to get the client company's economy started, the client company will have to transfer/distribute their brand tokens amongst the economy users. Server-side SDKs make it possible for the client company to execute company-to-user transactions.

Fetch Brand Token information

As the server SDKs facilitate interaction between openst-contracts and the client company servers, the client company can fetch addresses of all the contracts deployed for their economy on origin and auxiliary chains. They can also get information around the rules contracts deployed, the conversion rate set for the economy and the company token holder address.

What has changed from the previous release?

This release is a huge leap forward from the previous one and so a major version upgrade. A lot of entity definitions and API endpoints have changed due to which, post this release we will not be supporting previous versions of the APIs and SDKs. The following functionality has essentially been added:

  • Key management support
  • Recovery support
  • Multi-device support
Assets 2
Loading