@kynesyslabs/demosdk 1.0.5 → 1.0.6

package/README.md

@@ -1,48 +1,50 @@
-# DEMOS SDKs
+# @kynesyslabs/demosdk
 
-This repo contains all the Demos SDKs
+Demos SDKs metapackage
 
-## Usage
-
-### Core
-
-TODO: Update once ported.
-
-### Multichain SDKs
+### Multichain SDKs Usage
 
 Check out the [multichain documentation](./documentation/multichain/README.md).
 
-## Organization
 
-The packages are structured like this:
+### Adding stuff
 
-```sh
-./src
-├── core # blockchain interface stuff <todo: port from frontend>
-│
-├── types # shared types
-│
-├── multichain
-│   ├── core     # default chain sdk implementation for all chains
-│   ├── localsdk # local sdks for all chains
-│   └── websdk   # web sdks for all chains
+Create a new folder in the `src` directory and add your stuff. Export items on the `index.ts` file in your new folder. Then add an export entry in `package.json` as shown:
+
+```json
+"exports": {
+    // ...
+    "./stuff": "./build/stuff/index.js"
+}
 ```
 
-## Development setup
-```sh
-yarn install
+This will allow users to use the new things as follows:
+
+```js
+import { Stuff, otherStuff } from '@kynesyslabs/demosdk/stuff'
 ```
 
-## Running tests
+### Running tests
 
 ```sh
 # multichain
 yarn test:multichain
 ```
 
-## Publishing on NPM
+### Publishing on NPM
+
+Publishing to NPM is automated using a Github Workflow. To publish a new version:
+
+1. Incrememt the `package.json` version field
+2. Commit your changes with a message starting with the word `release`
+3. Push to Github.
+
+```sh
+# Example:
+git commit -m "release v1.0.5"
+```
 
-TODO!
+The commit will trigger a workflow run to build the files and publish a new version on NPM.
 
 ## What has Changed?
 
@@ -56,4 +58,3 @@ new: `rpc_url`, `chain_id`, `isEIP1559`
 ## TODOs
 
 -   Review `getBalance` return type. Should it be a string or an object?
--

package/build/types/Operation.d.ts

@@ -2,7 +2,7 @@ import { TxFee } from "./TxFee";
 export interface Operation {
     operator: string;
     actor: string;
-    params: {};
+    params: any;
     hash: string;
     nonce: number;
     timestamp: number;

package/build/types/addressInfo.d.ts

@@ -0,0 +1,6 @@
+import { StatusNative } from "./statusNative";
+import { statusNative as StatusProperties } from "./statusProperties";
+export default interface AddressInfo {
+    native: StatusNative | null;
+    properties: StatusProperties | null;
+}

package/build/types/addressInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=addressInfo.js.map

package/build/types/addressInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addressInfo.js","sourceRoot":"","sources":["../../../src/types/addressInfo.ts"],"names":[],"mappings":""}

package/build/types/communication/transmit.d.ts

@@ -0,0 +1,14 @@
+export interface BundleContent {
+    type: string;
+    message: string;
+    sender: any;
+    receiver: any;
+    timestamp: number;
+    data: any;
+    extra: string;
+}
+export interface Bundle {
+    content: BundleContent;
+    hash: string;
+    signature: any;
+}

package/build/types/communication/transmit.js

@@ -0,0 +1,13 @@
+"use strict";
+/* LICENSE
+
+© 2023 by KyneSys Labs, licensed under CC BY-NC-ND 4.0
+
+Full license text: https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode
+Human readable license: https://creativecommons.org/licenses/by-nc-nd/4.0/
+
+KyneSys Labs: https://www.kynesys.xyz/
+
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=transmit.js.map

package/build/types/communication/transmit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transmit.js","sourceRoot":"","sources":["../../../../src/types/communication/transmit.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE"}

package/build/types/index.d.ts

@@ -5,6 +5,7 @@ export { ISignature } from './ISignature';
 export { StateChange } from './StateChange';
 export { ValidityData } from './ValidityData';
 export { RawTransaction } from './rawTransaction';
+export { Bundle, BundleContent } from './communication/transmit';
 export { Transaction, TransactionContent } from './Transaction';
 export { StatusNative } from './statusNative';
 export { statusNative as StatusProperties } from './statusProperties';
@@ -12,3 +13,4 @@ export { Operation, OperationRegistrySlot, OperationResult } from './Operation';
 export { ISecurityReport, SIComlink, SIResponseRegistry, } from './network/SecurityTypes';
 export { ExecutionResult } from './network/ExecutionResult';
 export { IPeerConfig } from './peers/Peer';
+export { IParam, IWeb2Payload, IWeb2Request, IWeb2Result, IRawWeb2Request, IWeb2Attestation, } from './web2';

package/build/types/web2/index.d.ts

@@ -0,0 +1,49 @@
+import forge from "node-forge";
+export interface IParam {
+    name: string;
+    value: any;
+}
+export interface IWeb2Payload {
+    type: "web2Request";
+    message: IWeb2Request;
+    sender: any;
+    receiver: any;
+    timestamp: any;
+    data: any;
+    extra: any;
+}
+export interface IWeb2Result {
+    status: number;
+    statusText: string;
+    data: any;
+}
+export interface IWeb2Request {
+    raw: IRawWeb2Request;
+    result: any;
+    attestations: {};
+    hash: string;
+    signature?: forge.pki.ed25519.BinaryBuffer;
+}
+export interface IRawWeb2Request {
+    action: string;
+    parameters: IParam[];
+    requestedParameters: [] | null;
+    method: "POST" | "GET" | "PUT" | "DELETE" | "PATCH";
+    url: string;
+    headers: any;
+    minAttestations: number;
+    stage: {
+        origin: {
+            identity: forge.pki.ed25519.BinaryBuffer;
+            connection_url: string;
+        };
+        hop_number: number;
+    };
+}
+export interface IWeb2Attestation {
+    hash: string;
+    timestamp: number;
+    identity: forge.pki.PublicKey;
+    signature: forge.pki.ed25519.BinaryBuffer;
+    valid: boolean;
+}

package/build/types/web2/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/build/types/web2/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/web2/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kynesyslabs/demosdk",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "author": "Kynesys Labs",