@minka/ledger-sdk - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0-rc.1

package.json

 {
   "name": "@minka/ledger-sdk",
-  "version": "2.1.0",
-  "license": "MIT",
+  "version": "2.2.0-rc.1",
   "description": "SDK for Minka Ledger",
-  "main": "main.js",
+  "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -17,3 +16,3 @@ "scripts": {
   "typedoc": {
-    "entryPoint": "src/lib/sdk.ts",
+    "entryPoint": "src/index.ts",
     "displayName": "Ledger SDK",
@@ -24,2 +23,3 @@ "tsconfig": "tsconfig.lib.json",
   "author": "Željko Rumenjak",
+  "license": "MIT",
   "dependencies": {
@@ -34,3 +34,9 @@ "@noble/ed25519": "1.7.1",
     "type-fest": "3.0.0"
+  },
+  "peerDependencies": {
+    "@minka/crypto": "1.0.0",
+    "@minka/errors": "1.0.0",
+    "@minka/format": "1.0.0",
+    "@minka/types": "1.0.0"
   }
 }

README.md

@@ -17,7 +17,7 @@ # Minka Ledger SDK
 
-First, you need an instance of the `LedgerSDK` class, you can pass an options object with the `required` property `baseUrl` pointing to the ledger you want to use.
+First, you need an instance of the `LedgerSDK` class, you can pass an options object with the `required` property `server` pointing to the ledger you want to use.
 
 ```javascript
-const ledger = new LedgerSDK({
-  baseUrl: 'https://minka.inc..',
+const ledger = new LedgerSdk({
+  server: 'https://minka.inc..',
 })
@@ -34,4 +34,6 @@ ```
 
-Each entity of the ledger has its client, and those clients are properties of the `LedgerSDK` instance, for example, the client for `signers` will be returned in `ledger.signers` if you used the example below to connect to the ledger.
+Each entity of the ledger has its client, and those clients are properties of the `LedgerSDK` instance, for example, the client for `signer` will be returned in `sdk.signer` if you used the example below to connect to the ledger.
 
+Available clients: `ledger`, `symbol`, `wallet`, `intent`, `signer`, `effect` and `bridge`.
+
 ##### Common client methods
@@ -46,3 +48,3 @@
 ```javascript
-const output = await ledger.signers.list()
+const output = await sdk.signer.list()
 // output: MultipleRecordsResponse
@@ -56,3 +58,3 @@ ```
 ```javascript
-const output = await ledger.signers.read('handle')
+const output = await sdk.signer.read('handle')
 // output: SingleRecordResponse
@@ -66,4 +68,4 @@ ```
 ```javascript
-// Initialize a record builder for the signers entity
-const emptySignerRecord = await ledger.signers.init()
+// Initialize a record builder for the signer entity
+const emptySignerRecord = await sdk.signer.init()
 /**
@@ -83,3 +85,3 @@ * Send that record to the backend. Note this record will
  */
-await ledger.signers.init({ record: {} }).hash().sign([keyPair]).send()
+await sdk.signer.init({}).hash().sign([{ keyPair }]).send()
 ```

src/index.d.ts

@@ -10,1 +10,4 @@ export { BridgeResponse, BridgesResponse } from './lib/clients/bridge-client';
 export { LedgerSdkError } from './lib/types/ledger-sdk-error';
+export * as crypto from "../crypto/src";
+export * as errors from "../errors/src";
+export * as types from "../types/src";

src/lib/clients/base-client.d.ts

@@ -1,2 +0,2 @@
-import { LedgerRecord, JwtConfig, LedgerSignature, LedgerMeta } from '@minka/types';
+import { LedgerRecord, JwtConfig, LedgerSignature, LedgerMeta } from "../../../types/src";
 import { Axios, AxiosRequestConfig } from 'axios';
@@ -6,3 +6,3 @@ import { LedgerListParams } from '../types/list-params';
 import { BaseRecordResponse, RecordResponseClass } from '../types/record-response';
-export declare type BaseClientOptions = {
+export type BaseClientOptions = {
     apiClient: Axios;
@@ -9,0 +9,0 @@ secure?: JwtConfig;

src/lib/clients/bridge-client.d.ts

@@ -1,2 +0,2 @@
-import { JwtConfig, LedgerHandle, LedgerList, LedgerRecord, LedgerBridge } from '@minka/types';
+import { JwtConfig, LedgerHandle, LedgerList, LedgerRecord, LedgerBridge } from "../../../types/src";
 import { AxiosResponse } from 'axios';
@@ -18,6 +18,6 @@ import { CreateRecordBuilder } from '../services/create-record-builder';
 export declare class BridgeClient extends BaseClient {
-    init(record?: Partial<LedgerRecord<LedgerBridge>>): CreateRecordBuilder<LedgerBridge, BridgeResponse, import("@minka/types").LedgerMeta>;
-    from(record: LedgerRecord<LedgerBridge>): UpdateRecordBuilder<LedgerBridge, BridgeResponse, import("@minka/types").LedgerMeta>;
+    init(record?: Partial<LedgerRecord<LedgerBridge>>): CreateRecordBuilder<LedgerBridge, BridgeResponse, import("../../../types/src").LedgerMeta>;
+    from(record: LedgerRecord<LedgerBridge>): UpdateRecordBuilder<LedgerBridge, BridgeResponse, import("../../../types/src").LedgerMeta>;
     read(handle: LedgerHandle, authParams?: Partial<JwtConfig>): Promise<BridgeResponse>;
     list(params?: LedgerListParams): Promise<BridgesResponse>;
 }

src/lib/clients/effect-client.d.ts

@@ -1,2 +0,2 @@
-import { JwtConfig, LedgerEffect, LedgerHandle, LedgerList, LedgerRecord } from '@minka/types';
+import { JwtConfig, LedgerEffect, LedgerHandle, LedgerList, LedgerRecord } from "../../../types/src";
 import { AxiosResponse } from 'axios';
@@ -18,6 +18,6 @@ import { CreateRecordBuilder } from '../services/create-record-builder';
 export declare class EffectClient extends BaseClient {
-    init(record?: Partial<LedgerRecord<LedgerEffect>>): CreateRecordBuilder<LedgerEffect, EffectResponse, import("@minka/types").LedgerMeta>;
-    from(record: LedgerRecord<LedgerEffect>): UpdateRecordBuilder<LedgerEffect, EffectResponse, import("@minka/types").LedgerMeta>;
+    init(record?: Partial<LedgerRecord<LedgerEffect>>): CreateRecordBuilder<LedgerEffect, EffectResponse, import("../../../types/src").LedgerMeta>;
+    from(record: LedgerRecord<LedgerEffect>): UpdateRecordBuilder<LedgerEffect, EffectResponse, import("../../../types/src").LedgerMeta>;
     read(handle: LedgerHandle, authParams?: Partial<JwtConfig>): Promise<EffectResponse>;
     list(params?: LedgerListParams): Promise<EffectsResponse>;
 }

src/lib/clients/intent-client.d.ts

@@ -1,2 +0,2 @@
-import { IntentMeta, IntentRecord, JwtConfig, LedgerHandle, LedgerIntent, LedgerList } from '@minka/types';
+import { IntentMeta, IntentRecord, JwtConfig, LedgerHandle, LedgerIntent, LedgerList } from "../../../types/src";
 import { AxiosResponse } from 'axios';
@@ -3,0 +3,0 @@ import { SignIntentBuilder } from '../services/sign-intent-builder';

src/lib/clients/ledger-client.d.ts

@@ -1,2 +0,2 @@
-import { JwtConfig, Ledger, LedgerHandle, LedgerList, LedgerRecord } from '@minka/types';
+import { JwtConfig, Ledger, LedgerHandle, LedgerList, LedgerRecord } from "../../../types/src";
 import { AxiosResponse } from 'axios';
@@ -18,6 +18,6 @@ import { CreateRecordBuilder } from '../services/create-record-builder';
 export declare class LedgerClient extends BaseClient {
-    init(record?: Partial<LedgerRecord<Ledger>>): CreateRecordBuilder<Ledger, LedgerResponse, import("@minka/types").LedgerMeta>;
-    from(record: LedgerRecord<Ledger>): UpdateRecordBuilder<Ledger, LedgerResponse, import("@minka/types").LedgerMeta>;
+    init(record?: Partial<LedgerRecord<Ledger>>): CreateRecordBuilder<Ledger, LedgerResponse, import("../../../types/src").LedgerMeta>;
+    from(record: LedgerRecord<Ledger>): UpdateRecordBuilder<Ledger, LedgerResponse, import("../../../types/src").LedgerMeta>;
     read(handle: LedgerHandle, authParams?: Partial<JwtConfig>): Promise<LedgerResponse>;
     list(params?: LedgerListParams): Promise<LedgersResponse>;
 }

src/lib/clients/signer-client.d.ts

@@ -1,2 +0,2 @@
-import { JwtConfig, LedgerHandle, LedgerList, LedgerRecord, LedgerSigner } from '@minka/types';
+import { JwtConfig, LedgerHandle, LedgerList, LedgerRecord, LedgerSigner } from "../../../types/src";
 import { AxiosResponse } from 'axios';
@@ -19,5 +19,5 @@ import { SignerRecordBuilder } from '../services/signer-record-builder';
     init(record?: Partial<LedgerRecord<LedgerSigner>>): SignerRecordBuilder;
-    from(record: LedgerRecord<LedgerSigner>): UpdateRecordBuilder<LedgerSigner, SignerResponse, import("@minka/types").LedgerMeta>;
+    from(record: LedgerRecord<LedgerSigner>): UpdateRecordBuilder<LedgerSigner, SignerResponse, import("../../../types/src").LedgerMeta>;
     read(handle: LedgerHandle, authParams?: Partial<JwtConfig>): Promise<SignerResponse>;
     list(params?: LedgerListParams): Promise<SignersResponse>;
 }

src/lib/clients/status-client.d.ts

@@ -1,2 +0,2 @@
-import { LedgerRecord, LedgerStatus } from '@minka/types';
+import { LedgerRecord, LedgerStatus } from "../../../types/src";
 import { AxiosResponse } from 'axios';
@@ -3,0 +3,0 @@ import { BaseRecordResponse } from '../types/record-response';

src/lib/clients/symbol-client.d.ts

@@ -1,2 +0,2 @@
-import { JwtConfig, LedgerHandle, LedgerList, LedgerRecord, LedgerSymbol } from '@minka/types';
+import { JwtConfig, LedgerHandle, LedgerList, LedgerRecord, LedgerSymbol } from "../../../types/src";
 import { AxiosResponse } from 'axios';
@@ -18,6 +18,6 @@ import { CreateRecordBuilder } from '../services/create-record-builder';
 export declare class SymbolClient extends BaseClient {
-    init(record?: Partial<LedgerRecord<LedgerSymbol>>): CreateRecordBuilder<LedgerSymbol, SymbolResponse, import("@minka/types").LedgerMeta>;
-    from(record: LedgerRecord<LedgerSymbol>): UpdateRecordBuilder<LedgerSymbol, SymbolResponse, import("@minka/types").LedgerMeta>;
+    init(record?: Partial<LedgerRecord<LedgerSymbol>>): CreateRecordBuilder<LedgerSymbol, SymbolResponse, import("../../../types/src").LedgerMeta>;
+    from(record: LedgerRecord<LedgerSymbol>): UpdateRecordBuilder<LedgerSymbol, SymbolResponse, import("../../../types/src").LedgerMeta>;
     read(handle: LedgerHandle, authParams?: Partial<JwtConfig>): Promise<SymbolResponse>;
     list(params?: LedgerListParams): Promise<SymbolsResponse>;
 }

src/lib/clients/wallet-client.d.ts

@@ -1,2 +0,2 @@
-import { JwtConfig, LedgerAddress, LedgerBalance, LedgerList, LedgerRecord, LedgerWallet } from '@minka/types';
+import { JwtConfig, LedgerAddress, LedgerBalance, LedgerList, LedgerRecord, LedgerWallet } from "../../../types/src";
 import { AxiosResponse } from 'axios';
@@ -22,4 +22,4 @@ import { CreateRecordBuilder } from '../services/create-record-builder';
 export declare class WalletClient extends BaseClient {
-    init(record?: Partial<LedgerRecord<LedgerWallet>>): CreateRecordBuilder<LedgerWallet, WalletResponse, import("@minka/types").LedgerMeta>;
-    from(record: LedgerRecord<LedgerWallet>): UpdateRecordBuilder<LedgerWallet, WalletResponse, import("@minka/types").LedgerMeta>;
+    init(record?: Partial<LedgerRecord<LedgerWallet>>): CreateRecordBuilder<LedgerWallet, WalletResponse, import("../../../types/src").LedgerMeta>;
+    from(record: LedgerRecord<LedgerWallet>): UpdateRecordBuilder<LedgerWallet, WalletResponse, import("../../../types/src").LedgerMeta>;
     read(handle: LedgerAddress, authParams?: Partial<JwtConfig>): Promise<WalletResponse>;
@@ -26,0 +26,0 @@ list(params?: LedgerListParams): Promise<WalletsResponse>;

src/lib/sdk.d.ts

@@ -1,2 +0,2 @@
-import { JwtConfig, LedgerHandle, LedgerPublic } from '@minka/types';
+import { JwtConfig, LedgerHandle, LedgerPublic } from "../../types/src";
 import { EffectClient } from './clients/effect-client';
@@ -10,3 +10,3 @@ import { LedgerClient } from './clients/ledger-client';
 import { ProofVerificationClient } from './services/proof-verification-client';
-export declare type SdkOptions = {
+export type SdkOptions = {
     secure?: JwtConfig;
@@ -19,3 +19,3 @@ server: string;
 };
-export declare type HandleHelper = {
+export type HandleHelper = {
     unique: (size?: number) => LedgerHandle;
@@ -22,0 +22,0 @@ };

src/lib/services/base-record-builder.d.ts

 import { PartialDeep } from 'type-fest';
-import { JwtConfig, LedgerHash, LedgerMeta, LedgerRecord, LedgerSigningParams } from '@minka/types';
+import { JwtConfig, LedgerHash, LedgerMeta, LedgerRecord, LedgerSigningParams } from "../../../types/src";
 export declare class BaseRecordBuilder<T, M extends LedgerMeta = LedgerMeta> {
@@ -4,0 +4,0 @@ protected authParams: JwtConfig;

src/lib/services/create-record-builder.d.ts

@@ -1,5 +0,5 @@
-import { JwtConfig, LedgerMeta, LedgerRecord } from '@minka/types';
+import { JwtConfig, LedgerMeta, LedgerRecord } from "../../../types/src";
 import { BaseRecordResponse } from '../types/record-response';
 import { BaseRecordBuilder } from './base-record-builder';
-export declare type CreateRecordHandler<T, R, M extends LedgerMeta = LedgerMeta> = (record: LedgerRecord<T, M>, authParams: JwtConfig) => Promise<R>;
+export type CreateRecordHandler<T, R, M extends LedgerMeta = LedgerMeta> = (record: LedgerRecord<T, M>, authParams: JwtConfig) => Promise<R>;
 export declare class CreateRecordBuilder<T, R extends BaseRecordResponse<T, M>, M extends LedgerMeta = LedgerMeta> extends BaseRecordBuilder<T, M> {
@@ -6,0 +6,0 @@ protected createRecord: CreateRecordHandler<T, R, M>;

src/lib/services/intent-record-builder.d.ts

@@ -1,2 +0,2 @@
-import { IntentMeta, LedgerIntent, LedgerSigningParams } from '@minka/types';
+import { IntentMeta, LedgerIntent, LedgerSigningParams } from "../../../types/src";
 import { IntentResponse } from '../clients/intent-client';
@@ -3,0 +3,0 @@ import { CreateRecordBuilder } from './create-record-builder';

src/lib/services/proof-verification-client.d.ts

@@ -1,4 +0,4 @@
-import { LedgerPublic, LedgerRecord, LedgerSignature } from '@minka/types';
+import { LedgerPublic, LedgerRecord, LedgerSignature } from "../../../types/src";
 import { LedgerSdkError } from '../types/ledger-sdk-error';
-declare type ComparableSignature = Partial<LedgerSignature>;
+type ComparableSignature = Partial<LedgerSignature>;
 export declare class ProofVerificationClient {
@@ -5,0 +5,0 @@ private ledgerSigner;

src/lib/services/sign-intent-builder.d.ts

@@ -1,4 +0,4 @@
-import { IntentMeta, IntentRecord, IntentSignatureData, JwtConfig, LedgerHash, LedgerIntent, LedgerSignature, LedgerSigningParams } from '@minka/types';
+import { IntentMeta, IntentRecord, IntentSignatureData, JwtConfig, LedgerHash, LedgerIntent, LedgerSignature, LedgerSigningParams } from "../../../types/src";
 import { IntentResponse } from '../clients/intent-client';
-declare type SendSignatureFunction = (signature: LedgerSignature<IntentSignatureData>, authParams: JwtConfig) => Promise<IntentResponse>;
+type SendSignatureFunction = (signature: LedgerSignature<IntentSignatureData>, authParams: JwtConfig) => Promise<IntentResponse>;
 export declare class SignIntentBuilder {
@@ -11,3 +11,3 @@ private recordBuilder;
     auth(params: Partial<JwtConfig>): this;
-    read(): Promise<import("@minka/types").LedgerRecord<LedgerIntent, IntentMeta>>;
+    read(): Promise<import("../../../types/src").LedgerRecord<LedgerIntent, IntentMeta>>;
     hash(hash?: LedgerHash): this;
@@ -14,0 +14,0 @@ sign(params: LedgerSigningParams[]): this;

src/lib/services/signer-record-builder.d.ts

@@ -1,2 +0,2 @@
-import { LedgerKeyPair, LedgerSigner } from '@minka/types';
+import { LedgerKeyPair, LedgerSigner } from "../../../types/src";
 import { SignerResponse } from '../clients/signer-client';
@@ -11,4 +11,4 @@ import { SignerRecordReadOptions } from '../types/record-builder';
     lock(): this;
-    read(readOptions?: SignerRecordReadOptions): Promise<import("@minka/types").LedgerRecord<LedgerSigner, import("@minka/types").LedgerMeta>>;
+    read(readOptions?: SignerRecordReadOptions): Promise<import("../../../types/src").LedgerRecord<LedgerSigner, import("../../../types/src").LedgerMeta>>;
     keys(keyPair: Partial<LedgerKeyPair>): this;
 }

src/lib/services/update-record-builder.d.ts

@@ -1,6 +0,6 @@
-import { JwtConfig, LedgerMeta, LedgerRecord, LedgerBaseData } from '@minka/types';
+import { JwtConfig, LedgerMeta, LedgerRecord, LedgerBaseData } from "../../../types/src";
 import { BaseRecordResponse } from '../types/record-response';
 import { BaseRecordBuilder } from './base-record-builder';
 import { PartialDeep } from 'type-fest';
-export declare type UpdateRecordHandler<T, R, M extends LedgerMeta = LedgerMeta> = (record: LedgerRecord<T, M>, authParams: JwtConfig) => Promise<R>;
+export type UpdateRecordHandler<T, R, M extends LedgerMeta = LedgerMeta> = (record: LedgerRecord<T, M>, authParams: JwtConfig) => Promise<R>;
 export declare class UpdateRecordBuilder<T extends LedgerBaseData, R extends BaseRecordResponse<T>, M extends LedgerMeta = LedgerMeta> extends BaseRecordBuilder<T, M> {
@@ -7,0 +7,0 @@ protected updateRecord: UpdateRecordHandler<T, R, M>;

src/lib/types/ledger-sdk-error.d.ts

@@ -1,2 +0,2 @@
-import { LedgerError, LedgerErrorReason } from '@minka/errors';
+import { LedgerError, LedgerErrorReason } from "../../../errors/src";
 export declare class LedgerSdkError extends Error implements LedgerError {
@@ -3,0 +3,0 @@ reason: LedgerErrorReason;

src/lib/types/list-params.d.ts

@@ -1,9 +0,9 @@
-import { JwtConfig } from '@minka/types';
-export declare type LedgerPaginationParams = {
+import { JwtConfig } from "../../../types/src";
+export type LedgerPaginationParams = {
     index: number;
     limit: number;
 };
-export declare type LedgerListParams = {
+export type LedgerListParams = {
     page?: LedgerPaginationParams;
     authParams?: Partial<JwtConfig>;
 };

src/lib/types/list-response.d.ts

@@ -1,2 +0,2 @@
-import { LedgerHash, LedgerList, LedgerMeta, LedgerPage } from '@minka/types';
+import { LedgerHash, LedgerList, LedgerMeta, LedgerPage } from "../../../types/src";
 import { AxiosResponse } from 'axios';
@@ -11,2 +11,2 @@ import { LedgerResponse } from './ledger-response';
 }
-export declare type ListResponseClass<T, R extends BaseListResponse<T, M>, M extends LedgerMeta = LedgerMeta> = new (response: AxiosResponse<LedgerList<T, M>, void>) => R;
+export type ListResponseClass<T, R extends BaseListResponse<T, M>, M extends LedgerMeta = LedgerMeta> = new (response: AxiosResponse<LedgerList<T, M>, void>) => R;

src/lib/types/record-builder.d.ts

@@ -1,3 +0,3 @@
-export declare type SignerRecordReadOptions = {
+export type SignerRecordReadOptions = {
     plain?: boolean;
 };

src/lib/types/record-response.d.ts

@@ -1,2 +0,2 @@
-import { LedgerHash, LedgerMeta, LedgerRecord } from '@minka/types';
+import { LedgerHash, LedgerMeta, LedgerRecord } from "../../../types/src";
 import { AxiosResponse } from 'axios';
@@ -10,2 +10,2 @@ import { LedgerResponse } from './ledger-response';
 }
-export declare type RecordResponseClass<T, R extends BaseRecordResponse<T, M>, M extends LedgerMeta = LedgerMeta> = new (response: AxiosResponse<LedgerRecord<T, M>, LedgerRecord<T, M>>) => R;
+export type RecordResponseClass<T, R extends BaseRecordResponse<T, M>, M extends LedgerMeta = LedgerMeta> = new (response: AxiosResponse<LedgerRecord<T, M>, LedgerRecord<T, M>>) => R;

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

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

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

295263

increased by126.44%

Number of package files

389

increased by1340.74%

Lines of code

4396

increased by1007.3%

Number of lines in readme file

82

increased by2.5%

Worsened metrics

Dependency count

12

increased by50%

Number of medium supply chain risk alerts

2

increased byInfinity%

No dependency changes