Merge pull request #3 from standardconnect/0.0.4-beta

0.0.4 beta

Author: interc0der

examples/index.ts

@@ -0,0 +1,51 @@
+import xls32d from '../dist/src';
+import { IAccountEncodeOpts, ICtiEncodeOpts } from '../dist/types';
+
+const mod = {
+  networkId: 1,
+  ledger_hash: 'F8A87917637D476E871D22A1376D7C129DAC9E25D45AD4B67D1E75EA4418654C',
+  ledger_index: '62084722',
+  txn_hash: '1C0FA22BBF5D0A8A7A105EB7D0AD7A2532863AA48584493D4BC45741AEDC4826',
+  txn_index: '25',
+};
+
+const { uri, cti, bigInt, hex, bin, bytes } = new xls32d.utils.cti.Encode(mod);
+console.log(uri, cti, bigInt, hex, bin, bytes);
+
+const input: ICtiEncodeOpts = {
+  type: 'cti',
+  params: {
+    networkId: 1,
+    ledger_hash: 'F8A87917637D476E871D22A1376D7C129DAC9E25D45AD4B67D1E75EA4418654C',
+    ledger_index: '62084722',
+    txn_hash: '1C0FA22BBF5D0A8A7A105EB7D0AD7A2532863AA48584493D4BC45741AEDC4826',
+    txn_index: '25',
+  },
+};
+
+const inputa: IAccountEncodeOpts = {
+  type: 'account',
+  params: {
+    xaddress: 'rpfBYsmNBB7Y6z7qHS8g26KE3y3hHaTxkq',
+  },
+};
+
+const main = async () => {
+  const uri32 = xls32d.encode(input);
+  console.log(uri32);
+
+  const duri32 = await xls32d.decode('xrpl:cti?id=17475295679037553836033');
+  console.log(duri32);
+
+  const durai32 = await xls32d.decode(
+    'xrpl:account?address=rpfBYsmNBB7Y6z7qHS8g26KE3y3hHaTxkq&tag=000001'
+  );
+
+  console.log(durai32);
+
+  const uria32 = xls32d.encode(inputa);
+
+  console.log(uria32);
+};
+
+main();

examples/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "examples",
+  "version": "0.0.1",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "xls-32d": "^0.0.3-beta"
+  },
+  "devDependencies": {
+    "ts-node": "^10.9.1"
+  }
+}

examples/yarn-error.log

@@ -0,0 +1,41 @@
+Arguments: 
+  /usr/local/bin/node /usr/local/bin/yarn add xls32d
+
+PATH: 
+  /Users/intercoder/.gem/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Library/Apple/usr/bin:/Users/intercoder/.gem/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/Applications/Visual Studio Code.app/Contents/Resources/app/bin:/Applications/Visual Studio Code.app/Contents/Resources/app/bin
+
+Yarn version: 
+  1.22.10
+
+Node version: 
+  18.12.0
+
+Platform: 
+  darwin arm64
+
+Trace: 
+  Error: https://registry.yarnpkg.com/xls32d: Not found
+      at params.callback [as _callback] (/usr/local/lib/node_modules/yarn/lib/cli.js:66988:18)
+      at self.callback (/usr/local/lib/node_modules/yarn/lib/cli.js:140662:22)
+      at Request.emit (node:events:513:28)
+      at Request.<anonymous> (/usr/local/lib/node_modules/yarn/lib/cli.js:141634:10)
+      at Request.emit (node:events:513:28)
+      at IncomingMessage.<anonymous> (/usr/local/lib/node_modules/yarn/lib/cli.js:141556:12)
+      at Object.onceWrapper (node:events:627:28)
+      at IncomingMessage.emit (node:events:525:35)
+      at endReadableNT (node:internal/streams/readable:1359:12)
+      at process.processTicksAndRejections (node:internal/process/task_queues:82:21)
+
+npm manifest: 
+  {
+    "name": "examples",
+    "version": "0.0.1",
+    "main": "index.js",
+    "license": "MIT"
+  }
+
+yarn manifest: 
+  No manifest
+
+Lockfile: 
+  No lockfile

package.json

@@ -1,6 +1,6 @@
 {
   "name": "xls-32d",
-  "version": "0.0.3-beta",
+  "version": "0.0.4-beta",
   "description": "XRPLF Standards Proposal - Request URI Structure",
   "main": "./dist/src/index.js",
   "repository": "https://github.com/standardconnect/xls-32d.git",
@@ -39,8 +39,10 @@
   "devDependencies": {
     "@types/fs-extra": "^11.0.1",
     "@types/jest": "^29.2.6",
+    "@types/jsonwebtoken": "^9.0.1",
     "@types/node": "^18.8.0",
     "@types/qrcode": "^1.5.0",
+    "@types/uuid": "^9.0.0",
     "jest": "^29.3.1",
     "prettier": "^2.8.0",
     "ts-jest": "^29.0.5",
@@ -49,8 +51,10 @@
   },
   "dependencies": {
     "fs-extra": "^10.1.0",
+    "jsonwebtoken": "^9.0.0",
     "qrcode": "^1.5.1",
     "tsc-alias": "^1.8.2",
+    "uuid": "^9.0.0",
     "zod": "^3.20.2"
   }
 }

src/helpers/client.ts

@@ -0,0 +1,20 @@
+import { URL } from './procedure';
+
+// This is a helper client which will be used to manufacture the correct URL/URI
+// The clients main prupose is to make sure that the provided domain supports xls32-d
+// and is so, retrieves a jwt and endpoint
+// With the jwt and endpoint, the request manufacturer can product the correct URL/URI
+
+// The client will also be used to receive incoming URI/URLs, check their validity and parse information for custom client-side handling
+
+export class Client {
+  constructor() {}
+
+  // check to see if domain has a provider and determine the appropiate endpoint for the manufacturing of the url
+
+  // required this this feature
+  // this.endpoint and this.jwt
+  //encode = (url:string) => new URL().encode(url)
+
+  decode = (url: string) => new URL().decode(url);
+}

src/helpers/decode.ts

@@ -1,11 +1,14 @@
 import { DecodeObj } from 'types/index';
 import utils from 'utils/index';
 
-export const decode = async (uri: string): Promise<DecodeObj> => {
+export const uri_decode = async (uri: string): Promise<DecodeObj> => {
   return {
     protocol: utils.parse.getProtocol(uri),
     version: await utils.parse.getVersion(uri),
     type: utils.parse.getType(uri),
     params: utils.parse.getParams(uri),
   };
 };
+
+export const url_decode = async (url: string): Promise<any> =>
+  Object.fromEntries(new URL(url).searchParams);

src/helpers/encode.ts

@@ -1,13 +1,28 @@
-import { EncodeOpts, ExtendedEcodingOpts } from 'types/index';
+import {
+  URIEncodeOpts,
+  ExtendedURIEncodingOpts,
+  URLEncodeOpts,
+  ExtendedURLEncodingOpts,
+} from 'types/index';
 import utils from 'utils/index';
 import { getVersion } from 'utils/index';
 
-export const encode = (opts: EncodeOpts): string => {
-  let object: ExtendedEcodingOpts = {
+export const uri_encode = (opts: URIEncodeOpts): string => {
+  let object: ExtendedURIEncodingOpts = {
     protocol: 'xrpl',
     version: getVersion(),
     ...opts,
   };
 
   return utils.parse.convertToUri(object);
 };
+
+export const url_encode = (opts: URLEncodeOpts): string => {
+  let object: ExtendedURLEncodingOpts = {
+    protocol: 'xrpl',
+    version: getVersion(),
+    ...opts,
+  };
+
+  return utils.parse.convertToUrl(object);
+};

src/helpers/index.ts

@@ -1,5 +1,12 @@
-import { EncodeOpts } from 'types/index';
-import x from './procedure';
+import { URIEncodeOpts, URLEncodeOpts } from 'types/index';
+import { URI, URL } from './procedure';
 
-export const encode = (opts: EncodeOpts) => new x().encode(opts);
-export const decode = (uri: string) => new x().input(uri).decode(uri);
+export const uri = {
+  encode: (opts: URIEncodeOpts) => new URI().encode(opts),
+  decode: (uri: string) => new URI().input(uri).decode(uri),
+};
+
+export const url = {
+  encode: (opts: URLEncodeOpts) => new URL().encode(opts),
+  decode: (url: string) => new URL().decode(url),
+};

src/helpers/procedure.ts

@@ -1,14 +1,27 @@
-import { encode as _encode } from './encode';
-import { decode as _decode } from './decode';
-import { EncodeOpts } from 'types/index';
+import { uri_encode, url_encode } from './encode';
+import { uri_decode, url_decode } from './decode';
+import { URIEncodeOpts, URLEncodeOpts } from 'types/index';
 
 import utils from 'utils/index';
 
-export default class x {
+export class URI {
   input = (uri: string) => {
     utils.checks.isValidSchema(uri);
     return this;
   };
-  encode = (opts: EncodeOpts) => _encode(opts);
-  decode = (uri: string) => _decode(uri);
+  encode = (opts: URIEncodeOpts) => uri_encode(opts);
+  decode = (uri: string) => uri_decode(uri);
+}
+
+export class URL {
+  input = (uri: string) => {
+    utils.checks.isValidSchema(uri);
+    return this;
+  };
+
+  fetchProvider = () => {};
+
+  encode = (opts: URLEncodeOpts) => url_encode(opts);
+
+  decode = (uri: string) => url_decode(uri);
 }

src/helpers/provider.ts

@@ -0,0 +1,57 @@
+import { getVersion } from 'utils/getVersion';
+import { v4 as uuid } from 'uuid';
+import jwt from 'jsonwebtoken';
+
+const jwt_key = 'my secret';
+const providerEndpoint = '/this/is/the/recieving/point';
+
+const defaultResponse = {
+  version: getVersion(),
+  supported: true,
+};
+
+export interface Request {
+  host?: string;
+  domain?: string;
+  origin?: string;
+  ip?: string;
+  uuid?: string;
+}
+export interface Response {
+  version: string;
+  supported: boolean;
+  endpoint?: string;
+  jwt?: string;
+}
+
+// This is a provider to be installed on the receiver of the URL
+// Provider shall be hosted at a default standardized endpoint
+// For the purposes of this example, this provider will be hosted at
+// https://localhost:3000/sc
+
+export class Provider {
+  req: Request;
+  res: Response = defaultResponse;
+  uuid: string = uuid();
+  key: string;
+  secret: string;
+  credentials: { key: string; secret: string };
+  endpoint: string;
+
+  constructor({ key, secret }: { key: string; secret: string }, request: Request = {}) {
+    this.key = key;
+    this.secret = secret;
+    this.req = request;
+    this.credentials = { key: this.key, secret: this.secret };
+    this.endpoint = providerEndpoint;
+    if (this.endpoint) this.res.endpoint = this.endpoint;
+    this.res.jwt = this.write();
+  }
+
+  private write = () =>
+    jwt.sign(Object.assign(this.credentials, { uuid: this.uuid }), jwt_key, {
+      expiresIn: '7d',
+    });
+
+  public response = () => this.res;
+}

src/index.ts

@@ -1,7 +1,8 @@
 import utils from 'utils/index';
-import { decode, encode } from 'helpers/index';
+import { uri, url } from 'helpers/index';
 import { generateQRCodeToBase64 as qr } from 'utils/qr';
+import * as types from 'types';
 
-export { decode, encode, utils, qr };
+export { uri, url, utils, qr, types };
 
-export default { decode, encode, qr, utils };
+export default { uri, url, qr, utils, types };