@ritbit/v4-client-js 1.3.17

package/.env

@@ -0,0 +1 @@
+SERVICE_NAME=v4-client-js

package/.eslintignore

@@ -0,0 +1,2 @@
+__native__/*.js
+__native__/__ios__/*.js

package/.eslintrc.js

@@ -0,0 +1,15 @@
+module.exports = {
+  extends: ['./node_modules/@dydxprotocol/node-service-base-dev/.eslintrc.js', 'prettier'],
+
+  parser: '@typescript-eslint/parser',
+  // Override the base configuration to set the correct tsconfigRootDir.
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+  },
+
+  ignorePatterns: ['**/examples/**/*.js', '**/codegen/**/*.ts'],
+
+  rules: {
+    'no-console': 'off',
+  },
+};

package/.gitleaks.toml

@@ -0,0 +1,24 @@
+# Title for the gitleaks configuration file.
+title = "Gitleaks title"
+
+[extend]
+# useDefault will extend the base configuration with the default gitleaks config:
+# https://github.com/zricethezav/gitleaks/blob/master/config/gitleaks.toml
+useDefault = true
+
+[allowlist]
+paths = [
+  '''gitleaks\.toml''',
+]
+
+regexTarget = "line"
+regexes = [
+  '''clientId''',
+  '''isEd25519Pubkey''',
+  '''isSecp256k1Pubkey''',
+  '''Ed25519Keypair;''',
+  '''Secp256k1Pubkey''',
+  '''e92a6595c934c991d3b3e987ea9b3125bf61a076deab3a9cb519787b7b3e8d77''',
+  '''8d805729d752cbeccbbce08531cc38b271031ae250f7b67bd5f1bf3827c46d87''',
+  '''44de77c4ee23e1008d4ebf23c9b4b6dca0fd29aadb0950a5bf96dc81b4f4bfc3''',
+]

package/.gitleaksignore

@@ -0,0 +1 @@
+ee48563a588a0d4bef717c4a64288d676b1f2c84:.coveralls.yml:generic-api-key:1

package/.nvmrc

@@ -0,0 +1 @@
+v20.8.1

package/.prettierignore

@@ -0,0 +1,3 @@
+__native__/*.js
+__native__/__ios__/*.js
+node_modules/

package/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "printWidth": 100,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "jsxBracketSameLine": false
+}

package/.releaserc

@@ -0,0 +1,10 @@
+{
+  "branches": ["main"],
+  "tagFormat": "v4-client-js@${version}",
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/npm"
+  ]
+}

package/.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Node.js - Debug Current File",
+      "type": "node",
+      "request": "launch",
+      "program": "${file}"
+    }
+  ]
+}

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright (C) 2025 RITBIT Trading.
+
+Subject to your compliance with applicable law and the v4 Terms of Use, available at dydx.exchange/legal, you are granted the right to use the Software (defined below) under the terms of the license as set forth below; provided, however, that if you violate any such applicable law in your use of the Software, all of your rights and licenses to use (including any rights to reproduce, distribute, install or modify) the Software will automatically and immediately terminate.
+
+The "Software" shall mean the following:  ritbit/v4-clients and any RITBIT or RITBIT Trading repository reflecting a copy of, or linking to, this license.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this Software and associated documentation files, to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+For more information about this software, see https://ritbit.trade. 
+ Copyright (C) 2025 RITBIT Trading.

package/README.md

@@ -0,0 +1,83 @@
+<p align="center"><img src="https://ritbit.trade/icon.svg?" width="256" /></p>
+
+<h1 align="center">RITBIT Chain Client for Javascript</h1>
+
+<div align="center">
+  <a href='https://www.npmjs.com/package/@ritbit/v4-client-js'>
+    <img src='https://img.shields.io/npm/v/@ritbit/v4-client-js.svg' alt='npm'/>
+  </a>
+  <a href='https://github.com/ritbit/v4-clients/blob/main/v4-client-js/LICENSE'>
+    <img src='https://img.shields.io/badge/License-AGPL_v3-blue.svg' alt='License' />
+  </a>
+</div>
+
+The v4-Client Typescript client is used for placing transactions and querying the RITBIT Chain.
+
+## Development
+
+`v4-client-js` uses node `v18` for development, see the .nvmrc file [here](https://github.com/ritbit/v4-clients/blob/main/v4-client-js/.nvmrc).
+You can use `nvm` to manage different versions of node.
+
+```
+nvm install
+nvm use
+nvm alias default $(nvm version) # optional
+```
+
+You can run the following commands to ensure that you are running the correct `node` and `npm` versions.
+
+```
+node -v # expected: v20.x.x (should match .nvmrc)
+npm -v  # expected: 10.x.x
+```
+
+### 1. Clone or fork the V4 clients repo
+
+```bash
+git clone git@github.com:ritbit/v4-clients.git
+```
+
+### 2. Go to one of the examples
+
+- Go to `v4-client-js/examples`
+
+```bash
+cd v4-client-js/examples
+```
+
+These examples by default use a test account with `DYDX_TEST_MNEMONIC` from the TS client library under `v4-client-js/examples/constants`, but you can use any test address that you own.
+
+### 3. Run the scripts with node
+
+```bash
+npm install
+npm run build
+```
+
+You should now see a `/build/examples` dir generated with JS files. We will use node to run these scripts
+
+- Open a terminal to run an example, e.g. account_endpoints.
+
+```bash
+node ../build/examples/composite_example.js
+
+```
+
+Everytime you change the TS code, you need to run `npm run build` again, before you execute using node.
+
+## Single-JS for mobile apps
+
+Mobile apps needs to load JS as a single JS file. To build, run
+
+```
+npm run webpack
+```
+
+The file is generated in **native**/**ios**/v4-native-client.js
+Pending: Different configurations may be needed to generate JS for Android app
+
+## Release
+
+Using the `npm version` command will update the appropriate version tags within the package locks and also will add a git tag with the version number..
+For example `npm version minor` will perform the necessary changes for a minor version release. After the change is merged, a GitHub action will
+[publish](https://github.com/ritbit/v4-clients/blob/master/.github/workflows/js-publish.yml) the new release.