xumm-sdk - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

dist/package.json

 {
     "name": "xumm-sdk",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "description": "Interact with the Xumm Developer API",
@@ -5,0 +5,0 @@ "main": "dist/src/index.js",

dist/src/index.d.ts

@@ -12,6 +12,6 @@ import { Storage } from './Storage';
      */
-    ping(): Promise<import("./Meta").ApplicationDetails>;
-    getCuratedAssets(): Promise<import("./Meta").CuratedAssetsResponse>;
+    ping(): Promise<import("./types").ApplicationDetails>;
+    getCuratedAssets(): Promise<import("./types").CuratedAssetsResponse>;
 }
 export { XummSdk };
 export type { Types };

dist/src/Meta.d.ts

@@ -1,43 +0,2 @@
-export interface ApplicationDetails {
-    quota: object;
-    application: {
-        uuidv4: string;
-        name: string;
-        webhookurl: string;
-        disabled: number;
-    };
-    call: {
-        uuidv4: string;
-    };
-}
-export interface Pong {
-    pong: boolean;
-    auth: ApplicationDetails;
-}
-export interface AnyJson {
-    [key: string]: AnyJson | any;
-}
-export interface CuratedAssetsResponse {
-    issuers: string[];
-    currencies: string[];
-    details: {
-        [issuer: string]: {
-            id: number;
-            name: string;
-            domain?: string;
-            avatar?: string;
-            shortlist: number;
-            currencies: {
-                [currencyCode: string]: {
-                    id: number;
-                    issuer_id: number;
-                    currency: string;
-                    name: string;
-                    avatar?: string;
-                    shortlist: number;
-                };
-            };
-        };
-    };
-}
+import type { ApplicationDetails, AnyJson, CuratedAssetsResponse } from './types';
 export declare class Meta {
@@ -44,0 +3,0 @@ private apiKey;

dist/src/Payload.d.ts

@@ -1,20 +0,3 @@
-import { Meta, AnyJson } from './Meta';
-import WebSocket from 'ws';
-import type { XummPostPayloadBodyJson as JsonPayload, XummPostPayloadBodyBlob as BlobPayload, XummPostPayloadResponse as CreatedPayload, XummDeletePayloadResponse as DeletedPayload, XummGetPayloadResponse as XummPayload } from './types/xumm-api';
-interface SubscriptionCallbackParams {
-    uuid: string;
-    data: AnyJson;
-    resolve: (resolveData?: any) => void;
-    payload: XummPayload;
-}
-interface PayloadSubscription {
-    payload: XummPayload;
-    resolved: Promise<any> | undefined;
-    resolve: (resolveData?: any) => void;
-    websocket: WebSocket;
-}
-interface PayloadAndSubscription extends PayloadSubscription {
-    created: CreatedPayload;
-}
-declare type onPayloadEvent = (subscriptionCallback: SubscriptionCallbackParams) => any | Promise<any> | void;
+import { Meta } from './Meta';
+import type { PayloadSubscription, PayloadAndSubscription, onPayloadEvent, XummPostPayloadBodyJson as JsonPayload, XummPostPayloadBodyBlob as BlobPayload, XummPostPayloadResponse as CreatedPayload, XummDeletePayloadResponse as DeletedPayload, XummGetPayloadResponse as XummPayload } from './types';
 export declare class Payload {
@@ -30,2 +13,1 @@ private Meta;
 }
-export {};

dist/src/Payload.js

@@ -76,2 +76,7 @@ "use strict";
             const callbackPromise = new utils_1.DeferredPromise();
+            /**
+             * This is ugly, but there's a small chance a created XUMM payload has not been distributed
+             * across the load balanced XUMM backend, so wait a bit.
+             */
+            yield new Promise(resolve => setTimeout(resolve, 75));
             const payloadDetails = yield this.resolvePayload(payload);
@@ -78,0 +83,0 @@ if (payloadDetails) {

dist/src/Storage.d.ts

@@ -1,19 +0,3 @@
-import { Meta, AnyJson } from './Meta';
-export interface StorageResponse {
-    application: {
-        name: string;
-        uuidv4: string;
-    };
-}
-export interface StorageGetResponse extends StorageResponse {
-    data: AnyJson | null;
-}
-export interface StorageSetResponse extends StorageResponse {
-    stored: boolean;
-    data: AnyJson;
-}
-export interface StorageDeleteResponse extends StorageResponse {
-    stored: boolean;
-    data: null;
-}
+import { Meta } from './Meta';
+import type { AnyJson } from './types';
 export declare class Storage {
@@ -20,0 +4,0 @@ private Meta;

dist/src/types/xumm-api/index.d.ts

@@ -58,2 +58,3 @@ declare const XummTxTypes: readonly ["SignIn"];
 }
+export declare type CreatePayload = XummPostPayloadBodyJson | XummPostPayloadBodyBlob;
 export interface XummPostPayloadResponse {
@@ -60,0 +61,0 @@ uuid: string;

package.json

 {
   "name": "xumm-sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Interact with the Xumm Developer API",
@@ -5,0 +5,0 @@ "main": "dist/src/index.js",

README.md

@@ -1,21 +0,215 @@
-# XUMM SDK (JS/TS)
+# XUMM SDK (JS/TS)  [![npm version](https://badge.fury.io/js/xumm-sdk.svg)](https://www.npmjs.com/xumm-sdk)
 
-...
+Interact with the XUMM SDK from Javascript / Typescript environments.
 
-**Typescript 3.8+ is required**
+## How to use the XUMM SDK
 
-## How to use:
+Get the SDK straight from npm: `npm install xumm-sdk`.
+
+Initialize the SDK in Javascript:
+```javascript
+const {XummSdk} = require('xumm-sdk').
+```
+
+... or in Typescript:
+
+```typescript
+import {XummSdk} from 'xumm-sdk'
+// Or with types:
+//   import {XummSdk, Types} from 'xumm-sdk'
+```
+
+Now continue by constructing the XummSdk object:
+
+```typescript
+const Sdk = new XummSdk()
+// Or with manually provided credentials (instead of using dotenv):
+//   const Sdk = new XummSdk('someAppKey', 'someAppSecret')
+```
+
+### Credentials
+
+The SDK will look in your environment or dotenv file (`.env`) for the `XUMM_APIKEY` and `XUMM_APISECRET` values.
+A [sample dotenv file looks like this](https://github.com/XRPL-Labs/XUMM-SDK/blob/master/sample.env). Alternatively
+you can provide your XUMM API Key & Secret by passing them to the XummSdk constructor. If both your environment and the SDK constructor contain credentials, the values provided to the constructor will be used.
+
+Create your app and get your XUMM API credentials at the XUMM Developer Console:
+
+- https://apps.xumm.dev
+
+More information about the XUMM API, payloads, the API workflow, sending Push notifications, etc. please check the XUMM API Docs: 
+
+- https://xumm.readme.io/docs
+
+
+### Methods & params (+ samples)
+
+After constructing the SDK, you can call the methods:
+
+- `Sdk.*` for the helper methods (see below)
+- `Sdk.payload.*` to get/update/create payloads for users to sign
+- `Sdk.storage.*` for your XUMM app storage (to store meta info for headless applications)
+
+Please note all snippets below assume you constructed the XUMM SDK into the `Sdk` constant, as the [How to use the XUMM SDK](#how-to-use-the-xumm-sdk) section outlines.
+
+#### Helper methods
+
+##### Sdk.ping()
+
+The `ping` method allows you to verify API access (valid credentials) and returns some info on your XUMM APP:
+
+```typescript
+const pong = await Sdk.ping()
+```
+
+Returns [`<ApplicationDetails>`](https://github.com/XRPL-Labs/XUMM-SDK/blob/master/src/types/Meta/ApplicationDetails.ts):
+```javascript
+{
+  quota: {},
+  application: {
+    uuidv4: '00000000-1111-2222-3333-aaaaaaaaaaaa',
+    name: 'My XUMM APP',
+    webhookurl: '',
+    disabled: 0
+  },
+  call: { uuidv4: 'bbbbbbbb-cccc-dddd-eeee-111111111111' }
+}
+```
+
+##### Sdk.getCuratedAssets()
+
+The `getCuratedAssets` method allows you to get the list of trusted issuers and IOU's. This is the same list used to
+populate the "Add Asset" button at the XUMM home screan.
+
+```typescript
+const curatedAssets = await Sdk.getCuratedAssets()
+```
+
+Returns [`<CuratedAssetsResponse>`](https://github.com/XRPL-Labs/XUMM-SDK/blob/master/src/types/Meta/CuratedAssetsResponse.ts):
+```javascript
+{
+  curatedAssets: {
+    issuers: [ 'Bitstamp', 'GateHub' ],
+    currencies: [ 'USD', 'BTC', 'EUR', 'ETH' ],
+    details: {
+      Bitstamp: [Object],
+      GateHub: [Object]
+    }
+  }
+}
+```
+
+#### App Storage
+
+App Storage allows you to store a JSON object at the XUMM API platform, containing max 60KB of data.
+Your XUMM APP storage is stored at the XUMM API backend, meaning it persists until you overwrite or delete it.
+
+This data is private, and accessible only with your own API credentials. This private JSON data can be used to store credentials / config / bootstrap info / ... for your headless application (eg. POS device).
+
+```typescript
+const storageSet = await Sdk.storage.set({name: 'Wietse', age: 32, male: true})
+console.log(storageSet)
+// true
+
+const storageGet = await Sdk.storage.get()
+console.log(storageGet)
+// { name: 'Wietse', age: 32, male: true }
+
+const storageDelete = await Sdk.storage.delete()
+console.log(storageDelete)
+// true
+
+const storageGetAfterDelete = await Sdk.storage.get()
+console.log(storageGetAfterDelete)
+// null
+```
+
+#### Payloads
+
 ...
+TODO
 
-### ...
+#### Payload subscriptions (subscribe to live updates)
+
 ...
+TODO
 
-## How to...
+## Debugging (logging)
 
-##### Test:
+The XUMM SDK will emit debugging info when invoked with a debug environment variable configured like: `DEBUG=xumm-sdk*` 
 
-`npm run test`
+You'll see the XUMM SDK debug messages if you invoke your script instead of this:
 
+```
+node myApp.js
+```
+
+like this:
+
+```
+DEBUG=xumm-sdk* node myApp.js
+```
+
+## Development
+
+Please note: you most likely just want to **use** the XUMM SDK, to do so, fetch the `xumm-sdk` package from NPM using `npm install --save xumm-sdk`.
+
+If you actually want to change/test/develop/build/contribute (to) the source of the XUMM SDK:
+
+##### Build
+
+Please note: at least Typescript version **3.8+** is required!
+
+To build the code, run `tsc`. To build automatically on file changes (watch): `tsc -w`.
+
+##### Lint & test
+
+Lint the code using `npm run lint`, run tests (jest) using `npm run test`
+
 ##### Run development code:
 
-`npm run dev` (Compiles and runs `/samples/....ts`)
+Build, run, show debug output & watch `/dist/samples/dev.js`, compiled from `/samples/dev.ts` using `npm run dev`. The `/samples/dev.ts` file is **not included by default**. A sample file could contain:
+
+```typescript
+import Debug from 'debug'
+import {XummSdk, Types} from '../src/'
+
+const log = Debug('xumm-sdk:sample')
+
+const main = async () => {
+  try {
+    const Sdk = new XummSdk('someAppKey', 'someAppSecret')
+    const pong = await Sdk.ping()
+    log({pong})
+
+    const curatedAssets = await Sdk.getCuratedAssets()
+    log({curatedAssets})
+
+    const PaymentPayload: Types.CreatePayload = {
+      txjson: {
+        TransactionType : 'Payment',
+        Destination : 'rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY',
+        DestinationTag: 495,
+        Amount: '1337'
+      }
+    }
+
+    const payload = await Sdk.payload.create(PaymentPayload)
+    log({payload})
+
+    if (payload) {
+      await Sdk.payload.subscribe(payload, event => {
+        log('Subscription Event data', event.data)
+
+        if (typeof event.data.expired !== 'undefined' || typeof event.data.signed !== 'undefined') {
+          return event.data
+        }
+      })
+    }
+  } catch (e) {
+    log({error: e.message, stack: e.stack})
+  }
+}
+
+main()
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

40516

increased by29.93%

Number of package files

42

increased by162.5%

Lines of code

785

increased by9.18%

Number of lines in readme file

216

increased by881.82%

No dependency changes