Celsius Js Sdk Versions Save

[1.0.0] - 2022-03-08

Added

• Functionalities:
  • Added functionality to http-client for sending PUT requests. Kudos to @ptlls
• Methods:
  • CelsiusInstance.getSupportedCountries(userSecret) that returns the list of countries supported by Celsius.
  • CelsiusInstance.health(message) checks the health of the server. Kudos to @andreujuanc
  • CelsiusInstance.getKycVerificationStatus(userId, userSecret) checks the KYC status, similar to existing getKycStatus method, but takes also userId as a parameter and returns a response containing property status which shows the status of KYC and reason which states the reason for the status if needed.
  • CelsiusInstance.startKycVerification(userId, documentType, userDocuments, userSecret) starts the KYC verification same as existing verifyKyc method, but it doesn't create the user, but rather receives an existing user's id - userId as a parameter
  • CelsiusInstance.createUser(user) which returns userId which can be used to manipulate user info and starting KYC verification. Also, the user_token property will be used as userSecret
  • CelsiusInstance.updateUser(userId, user, userSecret)
  • CelsiusInstance.updateUserEmail(email, userSecret)
  • CelsiusInstance.confirmTermsOfUse(termsOfUseId, confirmationDate, userSecret) use to accept the latest terms of use. Kudos to @ptlls
• Types:
  • CreateUser with properties first_name, last_name, middle_name?, email?, title?, date_of_birth, citizenship, country, state?, city, zip, street, building_number?, flat_number, itin?, national_id?, ssn?, gender, user_token
  • UpdateUser with properties first_name, last_name, middle_name?, email?,title?, date_of_birth, citizenship,country,state?,city,zip, street,building_number?,flat_number?,itin?, national_id?, ssn?, gender,
  • UpdateEmail with email property, for updating user email.
  • CreateUserResponse with properties userId, userToken
  • SupportedCountriesResponse with properties alpha2, alpha3, countryCallingCodes, currencies emoji, ioc, languages, name and status
  • KYCStatusResponse with properties status and reasons

Updated

• Updated methods:
  • getInterestRates return type changed to Promise<InterestRates[]> . Kudos to @barathvk
  • getTransactionSummary, pagination options parameter changed from PaginationOptions to CelsiusPaginationOptions. Kudos to @crypto-diplodocus and @rbayliss
  • getCoinTransactions, pagination options changed from PaginationOptions to CelsiusPaginationOptions. Kudos to @crypto-diplodocus and @rbayliss
• Updated types:
  • added coin property to CelsiusWithdrawOptions
• Updated dependencies:
  • Bump nokogiri from 1.10.8 to 1.12.5
  • Bump path-parse from 1.0.6 to 1.0.7
  • Bump addressable from 2.5.2 to 2.8.0
  • Bump hosted-git-info from 2.7.1 to 2.8.9
  • Bump lodash from 4.17.19 to 4.17.21
  • Bump axios from 0.18.1 to 0.21.1

Deleted:

• Deleted methods:
  • CelsiusInstance.createUser
  • CelsiusInstance.getUsers
  • CelsiusInstance.changeMetadata
  • CelsiusInstance.changeWithdrawalAddress
• Deleted types:
  • PaginationOptions
  • UserWithdrawalAddress
  • UserMetadataResponse
  • UserCreateResponse
  • UsersResponse
  • WithdrawalAddress
  • InstitutionalUser

• Adding a new property amount_precise to the CelsiusTransactionRecord type. It provides the exact transaction amount, without any rounding applied.

• Fixing error handling to cover unhandled cases such as Wallet API being offline and signature verification failing.
• Adding a new class CelsiusSDKError that encapsulates errors raised within the Celsius SDK. This class extends the Error class and contains the following additional attributes:
  • slug - Unique identifier tied to the error, returned by the API;
  • status - Status code returned by the API;
  • originalError - Original error which was used to instantiate CelsiusSDKError.
• Exporting CelsiusSDKError and ValidationError classes used by Celsius SDK to encapsulate errors.
• Fixing unhandled promise rejections in http-client.js::post method.

• Adding new properties to response received when using CelsiusInstance.getTransctionSummary(pagination, userSecret) and CelsiusInstance.getCoinTransactions(coin, pagination, userSecret).
  • original_interest_coin - Name of the original coin for which the interest has been accrued.
  • interest_amount_in_original_coin - Amount accrued in original_interest_coin, before conversion to another asset.

This release adds the following support for originating withdrawal scheme for whitelabel partners:

• Method getWithdrawalAddresses(userSecret) which allows retrieving all withdrawal addresses for the given user;
• Method getWithdrawalAddressForCoin(coin, userSecret) which allows retrieving withdrawal address for the given coin and user.