All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
-
Added method
CelsiusInstance.getStatistics(userSecret, timestamp)
that returns following statistics:- deposit_count - Number of deposits made
- deposit_amount - Total amount deposited in usd and per coin (in that coin and usd)
- withdrawal_count - Number of withdrawals made
- withdrawal_amount - Total amount withdrawn in usd and per coin (in that coin and usd)
- interest_count - Number of interests earned
- interest_amount - Total interest earned in usd and per coin (in that coin and usd)
Optionally,
timestamp
can be provided which serves as the starting point for gathering statistics. Any deposits, withdrawals and interests created before that date will be ignored. -
Added mocha tests to sdk.
- Added support for ISO 3166 country representation in
CelsiusKycUserData.country
property. Available ISO 3166 country representations are:- ISO 3166 Country name
- ISO 3166 Official state name
- ISO 3166-1 Alpha-2 code
- ISO 3166-3 Alpha-3 code
- Added support for two letter United States state codes in
CelsiusKycUserData.state
property.
- Fixed typings for
CelsiusKycUserData.document_type
. Available document types are now:- passport
- identity_card
- driving_licence
-
Added following address properties to
CelsiusKycUserData
:- country
- state - Required if the country is 'United States'
- city
- zip
- street
- building_number
- flat_number
-
Added following taxpayer properties to
CelsiusKycUserData
:- itin
- national_id
- ssn
-
Changed maximum upload size to 25mb
- Method
CelsiusInstance.getInterestSummary(userSecret)
that returns interest earned by the user.
ValidationError
for all http-client 4xx responses.
- Method
CelsiusInstance.getInterestRates()
will return interest rate for all supported coins.
- Method
CelsiusInstance.createUser()
will create new user for whitelabel partner.
- Method
CelsiusInstance.getUsers()
will return all users for whitelabel partner. - Method
CelsiusInstance.changeMetadata()
will change metadata of the user. - Method
CelsiusInstance.changeWithdrawalAddress()
will change withdrawal address of the user.
- Typescript type definitions! Kudos to @jmbrito01 who typed out most of the definitions, and helped us greatly!
- Supported currencies are now retrieved upon instantiation of the SDK and can be accessed via
CelsiusInstance.currencies
property. - Method
CelsiusInstance.getSupportedCurrencies()
refreshesCelsiusInstance.currencies
property and returns currencies.
- 🚢🍾 First open-source version of the Celsius SDK released! Kudos to @JovanovicJovan & @g4ndr4. Great job guys!