ariari-accounts-sdk

Ariari Accounts SDK library

Ariari Accounts SDK is a JavaScript library for Ariari Accounts API implementation.

Quick Start

Installation

Using npm:

$ npm install ariari-accounts-sdk

Usage

Initialization

const accountsApiSdk = require('ariari-accounts-sdk');
const accountsApi = new AriariAccountsSdk();

Create a new company

const data = {
   publicKey: 'GC2Z...JXNU',
   domain: 'www.foo-domain.com',
}

accountsApi.company.create(data) # returns the newly created object company

• data
  Object with mandatory params containing the information to create a new company. Required: true
  • publicKey
    From the /.well-known/stellar.toml file that matches the domain. Required: true
  • domain
    Of the company to be created. Required: true

Authenticate a company

const secret = 'SAAN...OLJ2';

accountsApi.company.login(secret) # returns the authentication token for a company

• secret
  Secret key that matches the public key used to create a new company. Required: true

Create a new account

const customId = 'foo';

accountsApi.account.create(customId) # returns the newly created object account

• customId
  Custom label that will allow easier identification of the newly created account. Required: false

Authenticate an account

const id = '123';
const customId = 'foo';
const publicKey = 'GC2Z...JXNU';

accountsApi.account.login({ id }) # returns the authentication token for an account
accountsApi.account.login({ customId }) # returns the authentication token for an account
accountsApi.account.login({ publicKey }) # returns the authentication token for an account

The user must provide either the id, public key or customId of the account to be authenticated.

• id
  ID of the account to be authenticated. Required: false
• customId
  Custom ID of the account to be authenticated. Required: false
• publicKey
  Public key of the account to be authenticated. Required: false

Sign a transaction

const transaction = 'AAAA...AAAA==';

accountsApi.account.signTransaction(transaction) # returns the signed transaction

• tx
  Transaction XDR to be signed by the desired account. Required: true

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.