Catapult API questions

garp · November 20, 2016, 11:24am

I have a few questions regarding the catapult engine or API:

will the catapult API remain reverse compatible with the current NIS API? Meaning, will it break existing apps using the NIS API or not?
Will the current nodes have to be upgraded to be catapult API nodes or catapult blockchain nodes or both? For me the released info is not clear about that, yet.
Will the API, changed or not, be documented with swagger. That will be needed in a few potential development projects I can think of. If there is no catapult API swagger in the pipeline yet, I am willing to consider investing the effort to help document the API.

garp

BloodyRookie · November 20, 2016, 4:46pm

We are planning to have support for NIS legacy API requests. But clients using the legacy API should upgrade to the new API if possible.
There is no decision yet how to handle the transition from NIS to catapult.
There are currently no plans to use swagger. But any help is welcome.

garp · November 21, 2016, 4:52pm

Hi BloodyRookie,

Thanks for the clarification.

Regarding point 3: If I could be provided the info on the catapult API, or at least the part that is already decided or final, I could start documenting it. I estimate I could probably start working on it somewhere in the second half of december.

garp

BloodyRookie · November 22, 2016, 5:16pm

We’ll be contacting you once we have enough catapult api requests. Thank you for your offer.

garp · November 26, 2016, 5:32pm

Ok.
The current NIS REST API could be used as well I suppose. I expect a number of calls to be similar.
Oh, and is the current /w/messages interface documented somewhere?

BloodyRookie · November 26, 2016, 5:43pm

I don’t think so. But i will ask @gimre.

gimre · November 26, 2016, 8:43pm

I think that’s the most comprehensive description:
(please remember, there’s STOMP on top of websockets https://stomp.github.io)

github.com

NemProject/nem-lightwallet/blob/master/lightwallet/README.md

Lightwallet tech notes
======================

Lightwallet is a proof-of-concept wallet for NEM. Lightwallet implements signing of transactions,
directly inside the browser from JS (using adjusted tweetnacl-js library).

Lightwallet uses require.js, bootstrap, and angular.

The most important part is WalletController.
Routes are very basic and are defined in walletApp.js.
Any angular-objects, should include 'definitions', as a first element.

The display of transactions is done using the `<transaction>` directive.
The directive uses proper `line*.html` view, depending on the transaction type.

Transaction's modal windows are done using angularUi and are currently handled 
via proper `tx*.js` controllers and a corresponding `tx*.html` views.

Multisig transaction details are common for multisig txes and placed directly inside
`txDetails.html` view, details for specific transaction types are in proper `details*.js` files.

This file has been truncated. show original

akkie · July 22, 2017, 3:37pm

Hi,

Are there any news regarding the swagger API spec?

Does it make sense to create a project proposal to get a bounty? Because in my opinion, a swagger SPEC would be a real benefit for developers, because of the automatic client creation functionality Swagger offers out of the box for many languages and technologies.

alexmccall · February 14, 2018, 2:32am

@CrimsonMeadow

TakaNobu · April 23, 2019, 1:15am

I can’t find “/heartbeat” in Catapult.
Could you please tell me how should I check node is alive with less load?

gimre · April 23, 2019, 9:16am

catapult.tools.health --help

and

catapult.tools.network --help

TakaNobu · April 24, 2019, 12:29am

thank you so much!