Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: client => dapi #8

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

coolaj86
Copy link
Contributor

@coolaj86 coolaj86 commented Jul 3, 2022

"client" is too generic - sounds like it could refer to a http or tcp client, however, this is highly specific to the platform, so it makes sense to call this dapi as to not be confused with other clients that may exist in the code and be more clear to the reader

sd 'client' 'dapi' *.js */*.js

@markin-io
Copy link

DAPI is the HTTP/GRPC interface in front of the Core and Platform.
SDK is a client to DAPI, and SDK could work in offline mode without connection to DAPI (e.g. to just create and sign transactions).

Having this in mind, renaming client to dapi and clientOptions to dapiOptions won't be correct.

@coolaj86
Copy link
Contributor Author

coolaj86 commented Jul 12, 2022

SDK could work in offline mode without connection to DAPI

Well, as long as we're agreed that that makes client an even worse name.

Could call it dash, or dp?

I still think dapi is just fine as it is the representation of the application programming interface - which includes offline functions - not a representation of the wire protocol.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants