@frequency-chain/api-augment - npm Package Compare versions

Comparing version 0.0.0-8b04fd to 0.0.0-8d464f

definitions/messages.d.ts

@@ -35,3 +35,26 @@ declare const _default: {
     };
+    runtime: {
+        MessagesRuntimeApi: {
+            methods: {
+                get_messages_by_schema_and_block: {
+                    description: string;
+                    params: {
+                        name: string;
+                        type: string;
+                    }[];
+                    type: string;
+                };
+                get_schema_by_id: {
+                    description: string;
+                    params: {
+                        name: string;
+                        type: string;
+                    }[];
+                    type: string;
+                };
+            };
+            version: number;
+        }[];
+    };
 };
 export default _default;

definitions/msa.d.ts

@@ -11,3 +11,3 @@ declare const _default: {
         };
-        grantedSchemaIds: {
+        grantedSchemaIdsByMsaId: {
             description: string;
@@ -23,2 +23,4 @@ params: {
         MessageSourceId: string;
+        DelegatorId: string;
+        ProviderId: string;
         KeyInfoResponse: {
@@ -29,3 +31,26 @@ key: string;
     };
+    runtime: {
+        MsaRuntimeApi: {
+            methods: {
+                has_delegation: {
+                    description: string;
+                    params: {
+                        name: string;
+                        type: string;
+                    }[];
+                    type: string;
+                };
+                get_granted_schemas_by_msa_id: {
+                    description: string;
+                    params: {
+                        name: string;
+                        type: string;
+                    }[];
+                    type: string;
+                };
+            };
+            version: number;
+        }[];
+    };
 };
 export default _default;

definitions/schemas.d.ts

@@ -41,3 +41,18 @@ declare const _default: {
     };
+    runtime: {
+        SchemasRuntimeApi: {
+            methods: {
+                get_schema_by_id: {
+                    description: string;
+                    params: {
+                        name: string;
+                        type: string;
+                    }[];
+                    type: string;
+                };
+            };
+            version: number;
+        }[];
+    };
 };
 export default _default;

index.d.ts

@@ -0,1 +1,2 @@
+import { ExtDef } from "@polkadot/types/extrinsic/signedExtensions/types";
 import "./interfaces/types-lookup";
@@ -14,2 +15,10 @@ import "./interfaces/augment-api";
 /**
+ * Frequency Specific Signed Extensions
+ */
+export declare const signedExtensions: ExtDef;
+/**
+ * Build up all the Runtime Api Calls
+ */
+export declare const runtime: {};
+/**
  * Export for easy use with Polkadot API's ApiPromise
@@ -27,2 +36,4 @@ *
     types: {};
+    signedExtensions: ExtDef;
+    runtime: {};
 };

interfaces/augment-api-errors.d.ts

@@ -329,6 +329,2 @@ import '@polkadot/api-base/types/errors';
             /**
-             * Cryptographic signature verification failed for adding a key to MSA
-             **/
-            AddKeySignatureVerificationFailed: AugmentedError<ApiType>;
-            /**
              * Cryptographic signature verification failed for adding the Provider as delegate
@@ -338,2 +334,6 @@ **/
             /**
+             * Attempted to request validity of schema permission or delegation in the future.
+             **/
+            CannotPredictValidityPastCurrentBlock: AugmentedError<ApiType>;
+            /**
              * The operation was attempted with an unknown delegation
@@ -344,6 +344,2 @@ **/
              * The operation was attempted with a revoked delegation
-             *
-             * # Situations
-             * * Had a prior delegation
-             * * Has an active delegation, but the schema permission is revoked
              **/
@@ -392,6 +388,2 @@ DelegationRevoked: AugmentedError<ApiType>;
             /**
-             * More than one account key exists for the MSA during retire attempt
-             **/
-            MoreThanOneKeyExists: AugmentedError<ApiType>;
-            /**
              * MsaId values have reached the maximum
@@ -401,2 +393,10 @@ **/
             /**
+             * Cryptographic signature verification failed for adding a key to MSA
+             **/
+            MsaOwnershipInvalidSignature: AugmentedError<ApiType>;
+            /**
+             * Cryptographic signature verification failed for proving ownership of new public-key.
+             **/
+            NewKeyOwnershipInvalidSignature: AugmentedError<ApiType>;
+            /**
              * An operation was attempted with an unknown Key
@@ -414,3 +414,3 @@ **/
             /**
-             * The submited proof has expired; the current block is less the expiration block
+             * The submitted proof has expired; the current block is less the expiration block
              **/
@@ -427,6 +427,2 @@ ProofHasExpired: AugmentedError<ApiType>;
             /**
-             * Can't retire a registered provider MSA
-             **/
-            RegisteredProviderCannotBeRetired: AugmentedError<ApiType>;
-            /**
              * Provider is not permitted to publish for given schema_id
@@ -545,10 +541,2 @@ **/
             /**
-             * Error in Deserialization
-             **/
-            DeserializationError: AugmentedError<ApiType>;
-            /**
-             * The governance schema model max value provided is too large (greater than the BoundedVec size)
-             **/
-            ExceedsGovernanceSchemaModelMaxValue: AugmentedError<ApiType>;
-            /**
              * The schema model exceeds the maximum length allowed
@@ -566,6 +554,2 @@ **/
             /**
-             * Schema does not exist
-             **/
-            NoSuchSchema: AugmentedError<ApiType>;
-            /**
              * CurrentSchemaIdentifierMaximum was attempted to overflow max, means MaxSchemaRegistrations is too big
@@ -575,10 +559,2 @@ **/
             /**
-             * Error in Serialization
-             **/
-            SerializationError: AugmentedError<ApiType>;
-            /**
-             * Error is converting to string
-             **/
-            StringConversionError: AugmentedError<ApiType>;
-            /**
              * Generic error
@@ -585,0 +561,0 @@ **/

interfaces/augment-api-events.d.ts

@@ -337,5 +337,5 @@ import '@polkadot/api-base/types/events';
              **/
-            DelegationGranted: AugmentedEvent<ApiType, [provider: u64, delegator: u64], {
-                provider: u64;
-                delegator: u64;
+            DelegationGranted: AugmentedEvent<ApiType, [providerId: u64, delegatorId: u64], {
+                providerId: u64;
+                delegatorId: u64;
             }>;
@@ -345,7 +345,14 @@ /**
              **/
-            DelegationRevoked: AugmentedEvent<ApiType, [provider: u64, delegator: u64], {
-                provider: u64;
-                delegator: u64;
+            DelegationRevoked: AugmentedEvent<ApiType, [providerId: u64, delegatorId: u64], {
+                providerId: u64;
+                delegatorId: u64;
             }>;
             /**
+             * A an update to the delegation occurred (ex. schema permissions where updated).
+             **/
+            DelegationUpdated: AugmentedEvent<ApiType, [providerId: u64, delegatorId: u64], {
+                providerId: u64;
+                delegatorId: u64;
+            }>;
+            /**
              * A new Message Service Account was created with a new MessageSourceId
@@ -366,4 +373,4 @@ **/
              **/
-            ProviderCreated: AugmentedEvent<ApiType, [providerMsaId: u64], {
-                providerMsaId: u64;
+            ProviderCreated: AugmentedEvent<ApiType, [providerId: u64], {
+                providerId: u64;
             }>;
@@ -489,2 +496,6 @@ /**
             /**
+             * Emitted when a schema is registered. [who, schemas id]
+             **/
+            SchemaCreated: AugmentedEvent<ApiType, [AccountId32, u16]>;
+            /**
              * Emitted when maximum size for schema model is changed.
@@ -494,6 +505,2 @@ **/
             /**
-             * Emitted when a schema is registered. [who, schemas id]
-             **/
-            SchemaRegistered: AugmentedEvent<ApiType, [AccountId32, u16]>;
-            /**
              * Generic event
@@ -500,0 +507,0 @@ **/

interfaces/augment-api-rpc.d.ts

 import '@polkadot/rpc-core/types/jsonrpc';
 import type { BlockPaginationRequest, BlockPaginationResponseMessage } from '@frequency-chain/api-augment/messages';
-import type { MessageSourceId } from '@frequency-chain/api-augment/msa';
+import type { DelegatorId, ProviderId } from '@frequency-chain/api-augment/msa';
 import type { SchemaId, SchemaModel, SchemaResponse } from '@frequency-chain/api-augment/schemas';
@@ -457,7 +457,7 @@ import type { AugmentedRpc } from '@polkadot/rpc-core/types';
              **/
-            checkDelegations: AugmentedRpc<(delegator_msa_ids: Vec<MessageSourceId> | (MessageSourceId | AnyNumber | Uint8Array)[], provider_msa_id: MessageSourceId | AnyNumber | Uint8Array, block_number: Option<BlockNumber> | null | Uint8Array | BlockNumber | AnyNumber) => Observable<Vec<ITuple<[MessageSourceId, bool]>>>>;
+            checkDelegations: AugmentedRpc<(delegator_msa_ids: Vec<DelegatorId> | (DelegatorId | AnyNumber | Uint8Array)[], provider_msa_id: ProviderId | AnyNumber | Uint8Array, block_number: BlockNumber | AnyNumber | Uint8Array, schema_id: Option<SchemaId> | null | Uint8Array | SchemaId | AnyNumber) => Observable<Vec<ITuple<[DelegatorId, bool]>>>>;
             /**
              * Fetch the list of schema ids that a delegator has granted to provider
              **/
-            grantedSchemaIds: AugmentedRpc<(delegator_msa_id: MessageSourceId | AnyNumber | Uint8Array, provider_msa_id: MessageSourceId | AnyNumber | Uint8Array) => Observable<Vec<SchemaId>>>;
+            grantedSchemaIdsByMsaId: AugmentedRpc<(delegator_msa_id: DelegatorId | AnyNumber | Uint8Array, provider_msa_id: ProviderId | AnyNumber | Uint8Array) => Observable<Option<Vec<SchemaId>>>>;
         };
@@ -464,0 +464,0 @@ net: {

interfaces/augment-api-runtime.d.ts

 import '@polkadot/api-base/types/calls';
+import type { MessageResponse } from '@frequency-chain/api-augment/messages';
+import type { DelegatorId, ProviderId } from '@frequency-chain/api-augment/msa';
+import type { PayloadLocation, SchemaId, SchemaResponse } from '@frequency-chain/api-augment/schemas';
 import type { ApiTypes, AugmentedCall, DecoratedCallBase } from '@polkadot/api-base/types';
-import type { Bytes, Null, Option, Vec, u32 } from '@polkadot/types-codec';
+import type { Bytes, Null, Option, Vec, bool, u32 } from '@polkadot/types-codec';
 import type { AnyNumber, ITuple } from '@polkadot/types-codec/types';
@@ -12,3 +15,3 @@ import type { CheckInherentsResult, InherentData } from '@polkadot/types/interfaces/blockbuilder';
 import type { FeeDetails, RuntimeDispatchInfo } from '@polkadot/types/interfaces/payment';
-import type { AccountId, Block, Header, Index, KeyTypeId, SlotDuration } from '@polkadot/types/interfaces/runtime';
+import type { AccountId, Block, BlockNumber, Header, Index, KeyTypeId, SlotDuration } from '@polkadot/types/interfaces/runtime';
 import type { RuntimeVersion } from '@polkadot/types/interfaces/state';
@@ -123,2 +126,17 @@ import type { ApplyExtrinsicResult } from '@polkadot/types/interfaces/system';
         };
+        /** 0x54bef602b989d121/1 */
+        messagesRuntimeApi: {
+            /**
+             * Retrieve the messages for a particular schema and block number
+             **/
+            getMessagesBySchemaAndBlock: AugmentedCall<ApiType, (schema_id: SchemaId | AnyNumber | Uint8Array, schema_payload_location: PayloadLocation | 'OnChain' | 'IPFS' | number | Uint8Array, block_number: BlockNumber | AnyNumber | Uint8Array) => Observable<Vec<MessageResponse>>>;
+            /**
+             * Retrieve a schema by id
+             **/
+            getSchemaById: AugmentedCall<ApiType, (schema_id: SchemaId | AnyNumber | Uint8Array) => Observable<Option<SchemaResponse>>>;
+            /**
+             * Generic call
+             **/
+            [key: string]: DecoratedCallBase<ApiType>;
+        };
         /** 0x37e397fc7c91f5e4/1 */
@@ -135,2 +153,17 @@ metadata: {
         };
+        /** 0x24d062f93a859f6f/1 */
+        msaRuntimeApi: {
+            /**
+             * Get the list of schema ids (if any) that exist in any delegation between the delegator and provider
+             **/
+            getGrantedSchemasByMsaId: AugmentedCall<ApiType, (delegator_id: DelegatorId | AnyNumber | Uint8Array, provider_id: ProviderId | AnyNumber | Uint8Array) => Observable<Option<Vec<SchemaId>>>>;
+            /**
+             * Check to see if a delegation existed between the given delegator and provider at a given block
+             **/
+            hasDelegation: AugmentedCall<ApiType, (delegator_id: DelegatorId | AnyNumber | Uint8Array, provider_id: ProviderId | AnyNumber | Uint8Array, block_number: BlockNumber | AnyNumber | Uint8Array, schema_id: Option<SchemaId> | null | Uint8Array | SchemaId | AnyNumber) => Observable<bool>>;
+            /**
+             * Generic call
+             **/
+            [key: string]: DecoratedCallBase<ApiType>;
+        };
         /** 0xf78b278be53f454c/2 */
@@ -153,2 +186,13 @@ offchainWorkerApi: {
         };
+        /** 0x02fadd88517cc081/1 */
+        schemasRuntimeApi: {
+            /**
+             * Fetch the schema by id
+             **/
+            getSchemaById: AugmentedCall<ApiType, (schema_id: SchemaId | AnyNumber | Uint8Array) => Observable<Option<SchemaResponse>>>;
+            /**
+             * Generic call
+             **/
+            [key: string]: DecoratedCallBase<ApiType>;
+        };
         /** 0xab3c0572291feb8b/1 */
@@ -155,0 +199,0 @@ sessionKeys: {

interfaces/lookup.d.ts

@@ -591,11 +591,11 @@ declare const _default: {
             DelegationGranted: {
-                provider: string;
-                delegator: string;
+                providerId: string;
+                delegatorId: string;
             };
             ProviderCreated: {
-                providerMsaId: string;
+                providerId: string;
             };
             DelegationRevoked: {
-                provider: string;
-                delegator: string;
+                providerId: string;
+                delegatorId: string;
             };
@@ -605,2 +605,6 @@ MsaRetired: {
             };
+            DelegationUpdated: {
+                providerId: string;
+                delegatorId: string;
+            };
         };
@@ -625,3 +629,3 @@ };
         _enum: {
-            SchemaRegistered: string;
+            SchemaCreated: string;
             SchemaMaxSizeChanged: string;
@@ -1345,3 +1349,2 @@ };
                 msaOwnerProof: string;
-                newPublicKey: string;
                 newKeyOwnerProof: string;
@@ -1351,3 +1354,3 @@ addKeyPayload: string;
             delete_msa_public_key: {
-                key: string;
+                publicKeyToDelete: string;
             };
@@ -1357,2 +1360,10 @@ revoke_delegation_by_provider: {
             };
+            grant_schema_permissions: {
+                providerMsaId: string;
+                schemaIds: string;
+            };
+            revoke_schema_permissions: {
+                providerMsaId: string;
+                schemaIds: string;
+            };
             retire_msa: string;
@@ -1392,3 +1403,3 @@ };
     /**
-     * Lookup161: pallet_msa::types::AddKeyData
+     * Lookup161: pallet_msa::types::AddKeyData<T>
      **/
@@ -1398,2 +1409,3 @@ PalletMsaAddKeyData: {
         expiration: string;
+        newPublicKey: string;
     };
@@ -1400,0 +1412,0 @@ /**

interfaces/msa/types.d.ts

 import type { Struct, u64 } from '@polkadot/types-codec';
 import type { AccountId } from '@polkadot/types/interfaces/runtime';
+/** @name DelegatorId */
+export interface DelegatorId extends MessageSourceId {
+}
 /** @name KeyInfoResponse */
@@ -11,2 +14,5 @@ export interface KeyInfoResponse extends Struct {
 }
+/** @name ProviderId */
+export interface ProviderId extends MessageSourceId {
+}
 export declare type PHANTOM_MSA = 'msa';

interfaces/schemas/types.d.ts

@@ -5,3 +5,4 @@ import type { Bytes, Enum, Struct, u16 } from '@polkadot/types-codec';
     readonly isAvroBinary: boolean;
-    readonly type: 'AvroBinary';
+    readonly isParquet: boolean;
+    readonly type: 'AvroBinary' | 'Parquet';
 }
@@ -8,0 +9,0 @@ /** @name PayloadLocation */

package.json

 {
   "name": "@frequency-chain/api-augment",
-  "version": "0.0.0-8b04fd",
+  "version": "0.0.0-8d464f",
   "bugs": {
@@ -8,3 +8,3 @@ "url": "https://github.com/LibertyDSNP/frequency/issues"
   "description": "RPC configuration for Frequency for use with Polkadotjs API",
-  "main": "index.cjs",
+  "main": "./cjs/index.js",
   "repository": {
@@ -17,21 +17,8 @@ "type": "git",
   "license": "Apache-2.0",
-  "devDependencies": {
-    "@polkadot/api": "^9.6.1",
-    "@polkadot/rpc-provider": "^9.6.1",
-    "@polkadot/typegen": "^9.6.1",
-    "@polkadot/types": "^9.6.1",
-    "@types/mocha": "^9.1.1",
-    "@typescript-eslint/eslint-plugin": "^5.36.0",
-    "@typescript-eslint/parser": "^5.36.0",
-    "eslint": "^8.23.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-mocha": "^10.1.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "mocha": "10.0.0",
-    "prettier": "2.7.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.7.4"
+  "dependencies": {
+    "@polkadot/api": "^9.6.2",
+    "@polkadot/rpc-provider": "^9.6.2",
+    "@polkadot/types": "^9.6.2"
   },
-  "module": "index.js",
+  "module": "./esm/index.js",
   "types": "index.d.ts",
@@ -41,6 +28,6 @@ "exports": {
       "types": "./index.d.ts",
-      "require": "./index.cjs",
-      "default": "./index.js"
+      "require": "./cjs/index.js",
+      "default": "./esm/index.js"
     }
   }
 }

README.md

@@ -30,2 +30,9 @@ # Javascript Custom RPC
 
+## Upgrades and Matching Versions
+
+Assuming you are using no deprecated methods, any release version should work against a release version of `@frequency-chain/api-augment`.
+If you are working against a development version it is suggested that you match against the commit hash using `v0.0.0-[First 6 of the commit hash]`.
+
+Changelog is maintained in the [releases for Frequency](https://github.com/LibertyDSNP/frequency/releases).
+
 ### Usage
@@ -32,0 +39,0 @@

No alert changes

Improved metrics

Total package byte prevSize

622292

increased by15.88%

Dev dependency count

0

decreased by-100%

Number of package files

82

increased by43.86%

Lines of code

15150

increased by21.61%

Number of lines in readme file

130

increased by5.69%

Worsened metrics

Dependency count

3

increased byInfinity%

Dependency changes

• + Added@polkadot/api@^9.6.2

• + Added@polkadot/rpc-provider@^9.6.2

• + Added@polkadot/types@^9.6.2

• + Added@babel/runtime@7.26.7(transitive)

• + Added@noble/hashes@1.2.0(transitive)

• + Added@noble/secp256k1@1.7.1(transitive)

• + Added@polkadot/api@9.14.2(transitive)

• + Added@polkadot/api-augment@9.14.2(transitive)

• + Added@polkadot/api-base@9.14.2(transitive)

• + Added@polkadot/api-derive@9.14.2(transitive)

• + Added@polkadot/keyring@10.4.2(transitive)

• + Added@polkadot/networks@10.4.2(transitive)

• + Added@polkadot/rpc-augment@9.14.2(transitive)

• + Added@polkadot/rpc-core@9.14.2(transitive)

• + Added@polkadot/rpc-provider@9.14.2(transitive)

• + Added@polkadot/types@9.14.2(transitive)

• + Added@polkadot/types-augment@9.14.2(transitive)

• + Added@polkadot/types-codec@9.14.2(transitive)

• + Added@polkadot/types-create@9.14.2(transitive)

• + Added@polkadot/types-known@9.14.2(transitive)

• + Added@polkadot/types-support@9.14.2(transitive)

• + Added@polkadot/util@10.4.2(transitive)

• + Added@polkadot/util-crypto@10.4.2(transitive)

• + Added@polkadot/wasm-bridge@6.4.1(transitive)

• + Added@polkadot/wasm-crypto@6.4.1(transitive)

• + Added@polkadot/wasm-crypto-asmjs@6.4.1(transitive)

• + Added@polkadot/wasm-crypto-init@6.4.1(transitive)

• + Added@polkadot/wasm-crypto-wasm@6.4.1(transitive)

• + Added@polkadot/wasm-util@6.4.1(transitive)

• + Added@polkadot/x-bigint@10.4.2(transitive)

• + Added@polkadot/x-fetch@10.4.2(transitive)

• + Added@polkadot/x-global@10.4.2(transitive)

• + Added@polkadot/x-randomvalues@10.4.2(transitive)

• + Added@polkadot/x-textdecoder@10.4.2(transitive)

• + Added@polkadot/x-textencoder@10.4.2(transitive)

• + Added@polkadot/x-ws@10.4.2(transitive)

• + Added@scure/base@1.1.1(transitive)

• + Added@substrate/connect@0.7.19(transitive)

• + Added@substrate/connect-extension-protocol@1.0.1(transitive)

• + Added@substrate/smoldot-light@0.7.9(transitive)

• + Added@substrate/ss58-registry@1.51.0(transitive)

• + Added@types/bn.js@5.1.6(transitive)

• + Added@types/node@22.13.1(transitive)

• + Added@types/node-fetch@2.6.12(transitive)

• + Added@types/websocket@1.0.10(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedbn.js@5.2.1(transitive)

• + Addedbufferutil@4.0.9(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addedd@1.0.2(transitive)

• + Addeddata-uri-to-buffer@4.0.1(transitive)

• + Addeddebug@2.6.94.4.0(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addeded2curve@0.3.0(transitive)

• + Addedes5-ext@0.10.64(transitive)

• + Addedes6-iterator@2.0.3(transitive)

• + Addedes6-symbol@3.1.4(transitive)

• + Addedesniff@2.0.1(transitive)

• + Addedevent-emitter@0.3.5(transitive)

• + Addedeventemitter3@4.0.75.0.1(transitive)

• + Addedext@1.7.0(transitive)

• + Addedfetch-blob@3.2.0(transitive)

• + Addedform-data@4.0.1(transitive)

• + Addedformdata-polyfill@4.0.10(transitive)

• + Addedis-typedarray@1.0.0(transitive)

• + Addedjson-stringify-safe@5.0.1(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedmock-socket@9.3.1(transitive)

• + Addedms@2.0.02.1.3(transitive)

• + Addednext-tick@1.1.0(transitive)

• + Addednock@13.5.6(transitive)

• + Addednode-domexception@1.0.0(transitive)

• + Addednode-fetch@3.3.2(transitive)

• + Addednode-gyp-build@4.8.4(transitive)

• + Addedpako@2.1.0(transitive)

• + Addedpropagate@2.0.1(transitive)

• + Addedregenerator-runtime@0.14.1(transitive)

• + Addedrxjs@7.8.1(transitive)

• + Addedtslib@2.8.1(transitive)

• + Addedtweetnacl@1.0.3(transitive)

• + Addedtype@2.7.3(transitive)

• + Addedtypedarray-to-buffer@3.1.5(transitive)

• + Addedundici-types@6.20.0(transitive)

• + Addedutf-8-validate@5.0.10(transitive)

• + Addedweb-streams-polyfill@3.3.3(transitive)

• + Addedwebsocket@1.0.35(transitive)

• + Addedws@8.18.0(transitive)

• + Addedyaeti@0.0.6(transitive)