lending: JavaScript / TypeScript client library (#1996)

Author: jordaaash

ci/js-test-token-lending.sh

@@ -9,4 +9,3 @@ cd token-lending/js
 npm install
 npm run lint
 npm run build
-npm run start-with-test-validator

token-lending/js/.eslintignore

@@ -0,0 +1,5 @@
+node_modules
+
+docs
+lib
+types

token-lending/js/.eslintrc.json

@@ -1,32 +1,11 @@
 {
-  "root": true,
-  "env": {
-    "node": true,
-    "browser": true
-  },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/recommended-requiring-type-checking",
-    "prettier",
-    "prettier/@typescript-eslint"
-  ],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 2020,
-    "parser": "babel-eslint",
-    "project": "./tsconfig.json",
-    "sourceType": "module"
-  },
-  "plugins": [
-    "@typescript-eslint",
-    "prettier"
-  ],
-  "rules": {
-    "no-console": 0,
-    "semi": 0,
-    "template-curly-spacing": ["error", "never"],
-    "@typescript-eslint/no-explicit-any": 0
-  }
+    "root": true,
+    "env": {
+        "node": true,
+        "browser": true
+    },
+    "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+    "parser": "@typescript-eslint/parser",
+    "plugins": ["@typescript-eslint", "prettier"],
+    "rules": {}
 }

token-lending/js/.gitignore

@@ -1,14 +1,4 @@
 node_modules
-coverage
-.nyc_output
-.DS_Store
-*.log
-.vscode
-.idea
-dist
-compiled
-.awcache
-.rpt2_cache
+
 docs
 lib
-test-ledger

token-lending/js/.prettierignore

@@ -0,0 +1,2 @@
+docs
+lib

token-lending/js/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "printWidth": 120,
+  "trailingComma": "es5",
+  "tabWidth": 4,
+  "semi": true,
+  "singleQuote": true
+}

token-lending/js/README.md

@@ -1,69 +1,23 @@
-# Token-lending JavaScript API
+# SPL Token Lending client library
 
-The Token-lending JavaScript library comprises:
+This is a JavaScript + TypeScript library for interacting with the [SPL Token Lending](https://github.com/solana-labs/solana-program-library/tree/master/token-lending) program.
 
-* A library to interact with the on-chain program
-* A test client that exercises the program
-* Scripts to facilitate building the program
+## Install
 
-## Getting Started
+Install the library and its peer dependencies in your app:
 
-First fetch the npm dependencies, including `@solana/web3.js`, by running:
-```sh
-$ npm install
+### Yarn
+```shell
+yarn add @solana/spl-token-lending @solana/spl-token @solana/web3.js
 ```
 
-### Select a Network
-
-The client connects to a local Solana cluster by default.
-
-To enable on-chain program logs, set the `RUST_LOG` environment variable:
-
-```bash
-$ export RUST_LOG=solana_runtime::native_loader=trace,solana_runtime::system_instruction_processor=trace,solana_runtime::bank=debug,solana_bpf_loader=debug,solana_rbpf=debug
-```
-
-To start a local Solana cluster run:
-```bash
-$ npm run localnet:update
-$ npm run localnet:up
+### NPM
+```shell
+npm install @solana/spl-token-lending @solana/spl-token @solana/web3.js
 ```
 
-Solana cluster logs are available with:
-```bash
-$ npm run localnet:logs
-```
-
-For more details on working with a local cluster, see the [full
-instructions](https://github.com/solana-labs/solana-web3.js#local-network).
-
-### Build the on-chain program
-
-```bash
-$ npm run build:program
-```
+## Documentation
 
-### Run the test client
-
-```sh
-$ npm run start
-```
-
-## Pointing to a public Solana cluster
-
-Solana maintains three public clusters:
-- `devnet` - Development cluster
-- `testnet` - Tour De Sol test cluster
-- `mainnet-beta` -  Main cluster
-
-Use npm scripts to configure which cluster.
-
-To point to `devnet`:
-```bash
-$ npm run cluster:devnet
-```
-
-To point back to the local cluster:
-```bash
-$ npm run cluster:localnet
-```
+- [Client library docs](https://solana-labs.github.io/solana-program-library/token-lending/)
+- [Program docs](https://github.com/solana-labs/solana-program-library/tree/master/token-lending)
+- [CLI docs](https://github.com/solana-labs/solana-program-library/tree/master/token-lending/cli)