https://github.com/emeraldpay/emerald-api-js
https://github.com/emeraldpay/emerald-api-js
javascript typescript
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/emeraldpay/emerald-api-js
- Owner: emeraldpay
- License: apache-2.0
- Created: 2019-05-06T03:17:30.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-02-13T19:57:21.000Z (over 1 year ago)
- Last Synced: 2025-10-17T21:14:17.256Z (9 months ago)
- Topics: javascript, typescript
- Language: TypeScript
- Size: 1.55 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
= Emerald API Client for Javascript
image:https://github.com/emeraldpay/emerald-api-js/workflows/Unit%20Tests/badge.svg["Unit Tests"]
image:https://img.shields.io/github/license/emeraldpay/emerald-api-js.svg?maxAge=2592000["License",link="https://github.com/emeraldpay/emerald-api-js/blob/master/LICENSE"]
== NodeJS / Electron Client
image:https://img.shields.io/npm/v/@emeraldpay/api-node.svg["npm (scoped)",link="https://www.npmjs.com/package/@emeraldpay/api-node"]
== Web Client
image:https://img.shields.io/npm/v/@emeraldpay/api-web.svg["npm (scoped)",link="https://www.npmjs.com/package/@emeraldpay/api-web"]
== Development
=== Build Instructions
.Prepare Environment
----
pnpm install
----
.Build all
----
pnpm -r run build
----
.Build individual modules
----
pnpm --filter @emeraldpay/api run build
pnpm --filter @emeraldpay/api-node run build
pnpm --filter @emeraldpay/api-web run build
----
.Compile individual modules
----
pnpm --filter @emeraldpay/api run build:ts
pnpm --filter @emeraldpay/api-node run build:ts
pnpm --filter @emeraldpay/api-web run build:ts
----
.Test individual modules
----
pnpm --filter @emeraldpay/api run test
pnpm --filter @emeraldpay/api-node run test
pnpm --filter @emeraldpay/api-web run test
----
=== Update Protobuf
This Client references Emerald API protobuf through Git Submodules.
Original Protobuf definitions are located at: https://github.com/emeraldpay/emerald-grpc
.Update Protobuf definitions to the latest:
----
git submodule update --remote
git commit api-definitions
----
== License
Copyright 2026 EmeraldPay Ltd
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.