Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
readme
This PR contains an outline for a proposed implementation for an API providing high-level methods for interacting with NAJ objects. The ultimate goal is to provide simple methods which map directly to clear behavior (examples). These methods in turn can be easily wrapped by frontend libraries to tie the behavior to application lifecycle.
The implementation is backed primarily by a
NearClient
class to reduce the number of required dependencies and provide an intuitive API for common operations. Client instances are easily configured for viewing and/or signing and provide helpful methods with clear, succinct parameters. This would also be exported from the package to aid in more complex use cases.This is very much a WIP and contains some duplicated code (in particular some tightly coupled logic in
accounts
andtransactions
), but is still useful as a proof of concept for a simple composition layer over@near-js
packages. It can easily be supplemented with a caching strategy and extended for use in frontend frameworks (i.e. hooks).cc @mpeterdev @thisisjoshford