@cardano-ogmios/schema - npm Package Compare versions

Comparing version 4.0.0-beta.9 to 4.0.0

dist/index.d.ts

@@ -66,3 +66,3 @@ export declare type Block = Byron | Shelley | Allegra | Mary | Alonzo;
 export declare type ValidationTagMismatch = "validationTagMismatch";
-export declare type SubmitTxError = (InvalidWitnesses | MissingVkWitnesses | MissingScriptWitnesses | ScriptWitnessNotValidating | InsufficientGenesisSignatures | MissingTxMetadata | MissingTxMetadataHash | TxMetadataHashMismatch | BadInputs | ExpiredUtxo | OutsideOfValidityInterval | TxTooLarge | MissingAtLeastOneInputUtxo | InvalidMetadata | FeeTooSmall | ValueNotConserved | NetworkMismatch | OutputTooSmall | TooManyAssetsInOutput | AddressAttributesTooLarge | TriesToForgeAda | DelegateNotRegistered | UnknownOrIncompleteWithdrawals | StakePoolNotRegistered | WrongRetirementEpoch | WrongPoolCertificate | StakeKeyAlreadyRegistered | PoolCostTooSmall | PoolMetadataHashTooBig | StakeKeyNotRegistered | RewardAccountNotExisting | RewardAccountNotEmpty | WrongCertificateType | UnknownGenesisKey | AlreadyDelegating | InsufficientFundsForMir | TooLateForMir | MirTransferNotCurrentlyAllowed | MirNegativeTransferNotCurrentlyAllowed | MirProducesNegativeUpdate | DuplicateGenesisVrf | NonGenesisVoters | UpdateWrongEpoch | ProtocolVersionCannotFollow | UnredeemableScripts | MissingRequiredDatums | UnspendableDatums | ExtraDataMismatch | MissingRequiredSignatures | UnspendableScriptInputs | ExtraRedeemers | MissingDatumHashesForInputs | MissingCollateralInputs | CollateralTooSmall | CollateralIsScript | CollateralHasNonAdaAssets | TooManyCollateralInputs | ExecutionUnitsTooLarge | OutsideForecast | ValidationTagMismatch | CollectErrors)[];
+export declare type SubmitTxError = (InvalidWitnesses | MissingVkWitnesses | MissingScriptWitnesses | ScriptWitnessNotValidating | InsufficientGenesisSignatures | MissingTxMetadata | MissingTxMetadataHash | TxMetadataHashMismatch | BadInputs | ExpiredUtxo | OutsideOfValidityInterval | TxTooLarge | MissingAtLeastOneInputUtxo | InvalidMetadata | FeeTooSmall | ValueNotConserved | NetworkMismatch | OutputTooSmall | TooManyAssetsInOutput | AddressAttributesTooLarge | TriesToForgeAda | DelegateNotRegistered | UnknownOrIncompleteWithdrawals | StakePoolNotRegistered | WrongRetirementEpoch | WrongPoolCertificate | StakeKeyAlreadyRegistered | PoolCostTooSmall | PoolMetadataHashTooBig | StakeKeyNotRegistered | RewardAccountNotExisting | RewardAccountNotEmpty | WrongCertificateType | UnknownGenesisKey | AlreadyDelegating | InsufficientFundsForMir | TooLateForMir | MirTransferNotCurrentlyAllowed | MirNegativeTransferNotCurrentlyAllowed | MirProducesNegativeUpdate | DuplicateGenesisVrf | NonGenesisVoters | UpdateWrongEpoch | ProtocolVersionCannotFollow | MissingRequiredRedeemers | MissingRequiredDatums | UnspendableDatums | ExtraDataMismatch | MissingRequiredSignatures | UnspendableScriptInputs | ExtraRedeemers | MissingDatumHashesForInputs | MissingCollateralInputs | CollateralTooSmall | CollateralIsScript | CollateralHasNonAdaAssets | TooManyCollateralInputs | ExecutionUnitsTooLarge | OutsideForecast | ValidationTagMismatch | CollectErrors)[];
 export declare type AcquireFailureDetails = "pointTooOld" | "pointNotOnChain";
@@ -79,2 +79,5 @@ export declare type GetEraStart = "eraStart";
 export declare type GetGenesisConfig = "genesisConfig";
+export declare type GetRewardsProvenance = "rewardsProvenance";
+export declare type GetPoolsRanking = "poolsRanking";
+export declare type GetPoolIds = "poolIds";
 export declare type RelativeTime = string;
@@ -197,3 +200,3 @@ export declare type QueryUnavailableInCurrentEra = "QueryUnavailableInCurrentEra";
         args?: {
-            query: GetEraStart | GetLedgerTip | GetCurrentEpoch | GetNonMyopicMemberRewards | GetDelegationsAndRewards | GetCurrentProtocolParameters | GetProposedProtocolParameters | GetStakeDistribution | GetUtxo | GetUtxoFiltered | GetGenesisConfig;
+            query: GetEraStart | GetLedgerTip | GetCurrentEpoch | GetNonMyopicMemberRewards | GetDelegationsAndRewards | GetCurrentProtocolParameters | GetProposedProtocolParameters | GetStakeDistribution | GetUtxo | GetUtxoByAddress | GetUtxoByTxIn | GetGenesisConfig | GetRewardsProvenance | GetPoolsRanking | GetPoolIds | GetPoolParameters;
         };
@@ -304,2 +307,44 @@ mirror?: {
     };
+    "QueryResponse[rewardsProvenance]": {
+        type: "jsonwsp/response";
+        version: "1.0";
+        servicename: "ogmios";
+        methodname: "Query";
+        result: RewardsProvenance | EraMismatch | QueryUnavailableInCurrentEra;
+        reflection?: {
+            [k: string]: unknown;
+        };
+    };
+    "QueryResponse[poolIds]"?: {
+        type: "jsonwsp/response";
+        version: "1.0";
+        servicename: "ogmios";
+        methodname: "Query";
+        result: PoolId[] | EraMismatch | QueryUnavailableInCurrentEra;
+        reflection?: {
+            [k: string]: unknown;
+        };
+    };
+    "QueryResponse[poolParameters]"?: {
+        type: "jsonwsp/response";
+        version: "1.0";
+        servicename: "ogmios";
+        methodname: "Query";
+        result: {
+            [k: string]: PoolParameters;
+        } | EraMismatch | QueryUnavailableInCurrentEra;
+        reflection?: {
+            [k: string]: unknown;
+        };
+    };
+    "QueryResponse[poolsRanking]": {
+        type: "jsonwsp/response";
+        version: "1.0";
+        servicename: "ogmios";
+        methodname: "Query";
+        result: PoolsRanking | EraMismatch | QueryUnavailableInCurrentEra;
+        reflection?: {
+            [k: string]: unknown;
+        };
+    };
     Fault: {
@@ -464,24 +509,3 @@ type: "jsonwsp/fault";
 export interface BlockShelley {
-    body?: {
-        id: Hash16;
-        body: {
-            inputs: TxIn[];
-            outputs: TxOut[];
-            certificates: Certificate[];
-            withdrawals: Withdrawals;
-            fee: Lovelace;
-            timeToLive: Slot;
-            update: UpdateShelley;
-        };
-        witness: {
-            signatures: {
-                [k: string]: Signature;
-            };
-            scripts: {
-                [k: string]: Script;
-            };
-            bootstrap: BootstrapWitness[];
-        };
-        metadata: AuxiliaryData | Null;
-    }[];
+    body?: BlockBodyShelley[];
     headerHash?: Hash16;
@@ -503,2 +527,24 @@ header?: {
 }
+export interface BlockBodyShelley {
+    id: Hash16;
+    body: {
+        inputs: TxIn[];
+        outputs: TxOut[];
+        certificates: Certificate[];
+        withdrawals: Withdrawals;
+        fee: Lovelace;
+        timeToLive: Slot;
+        update: UpdateShelley;
+    };
+    witness: {
+        signatures: {
+            [k: string]: Signature;
+        };
+        scripts: {
+            [k: string]: Script;
+        };
+        bootstrap: BootstrapWitness[];
+    };
+    metadata: AuxiliaryData | Null;
+}
 export interface StakeDelegation {
@@ -517,14 +563,15 @@ stakeDelegation: {
 export interface PoolRegistration {
-    poolRegistration: {
-        owners: Hash16[];
-        cost: Lovelace;
-        margin: Ratio;
-        pledge: Lovelace;
-        vrf: Hash16;
-        metadata: Null | PoolMetadata;
-        id: PoolId;
-        relays: Relay[];
-        rewardAccount: RewardAccount;
-    };
+    poolRegistration: PoolParameters;
 }
+export interface PoolParameters {
+    owners: Hash16[];
+    cost: Lovelace;
+    margin: Ratio;
+    pledge: Lovelace;
+    vrf: Hash16;
+    metadata: Null | PoolMetadata;
+    id: PoolId;
+    relays: Relay[];
+    rewardAccount: RewardAccount;
+}
 export interface PoolMetadata {
@@ -645,7 +692,8 @@ hash: Hash16;
 export interface Map {
-    map: {
-        k: Metadatum;
-        v: Metadatum;
-    }[];
+    map: MetadatumMap[];
 }
+export interface MetadatumMap {
+    k: Metadatum;
+    v: Metadatum;
+}
 export interface NonceProof {
@@ -669,24 +717,3 @@ proof?: Hash64;
 export interface BlockAllegra {
-    body?: {
-        id: Hash16;
-        body: {
-            inputs: TxIn[];
-            outputs: TxOut[];
-            certificates: Certificate[];
-            withdrawals: Withdrawals;
-            fee: Lovelace;
-            validityInterval: ValidityInterval;
-            update: UpdateShelley;
-        };
-        witness: {
-            signatures: {
-                [k: string]: Signature;
-            };
-            scripts: {
-                [k: string]: Script;
-            };
-            bootstrap: BootstrapWitness[];
-        };
-        metadata: AuxiliaryData | Null;
-    }[];
+    body?: BlockBodyAllegra[];
     headerHash?: Hash16;
@@ -708,2 +735,24 @@ header?: {
 }
+export interface BlockBodyAllegra {
+    id: Hash16;
+    body: {
+        inputs: TxIn[];
+        outputs: TxOut[];
+        certificates: Certificate[];
+        withdrawals: Withdrawals;
+        fee: Lovelace;
+        validityInterval: ValidityInterval;
+        update: UpdateShelley;
+    };
+    witness: {
+        signatures: {
+            [k: string]: Signature;
+        };
+        scripts: {
+            [k: string]: Script;
+        };
+        bootstrap: BootstrapWitness[];
+    };
+    metadata: AuxiliaryData | Null;
+}
 export interface ValidityInterval {
@@ -717,25 +766,3 @@ invalidBefore: Slot | Null;
 export interface BlockMary {
-    body?: {
-        id: Hash16;
-        body: {
-            inputs: TxIn[];
-            outputs: TxOut[];
-            certificates: Certificate[];
-            withdrawals: Withdrawals;
-            fee: Lovelace;
-            validityInterval: ValidityInterval;
-            update: UpdateShelley;
-            mint: Value;
-        };
-        witness: {
-            signatures: {
-                [k: string]: Signature;
-            };
-            scripts: {
-                [k: string]: Script;
-            };
-            bootstrap: BootstrapWitness[];
-        };
-        metadata: AuxiliaryData | Null;
-    }[];
+    body?: BlockBodyMary[];
     headerHash?: Hash16;
@@ -757,2 +784,25 @@ header?: {
 }
+export interface BlockBodyMary {
+    id: Hash16;
+    body: {
+        inputs: TxIn[];
+        outputs: TxOut[];
+        certificates: Certificate[];
+        withdrawals: Withdrawals;
+        fee: Lovelace;
+        validityInterval: ValidityInterval;
+        update: UpdateShelley;
+        mint: Value;
+    };
+    witness: {
+        signatures: {
+            [k: string]: Signature;
+        };
+        scripts: {
+            [k: string]: Script;
+        };
+        bootstrap: BootstrapWitness[];
+    };
+    metadata: AuxiliaryData | Null;
+}
 export interface Alonzo {
@@ -762,35 +812,3 @@ alonzo: BlockAlonzo;
 export interface BlockAlonzo {
-    body?: {
-        id: Hash16;
-        body: {
-            inputs: TxIn[];
-            collaterals: TxIn[];
-            outputs: TxOut[];
-            certificates: Certificate[];
-            withdrawals: Withdrawals;
-            fee: Lovelace;
-            validityInterval: ValidityInterval;
-            update: UpdateAlonzo;
-            mint: Value;
-            network: Network | Null;
-            requiredExtraData: Hash16 | Null;
-            requiredExtraSignatures: Hash16[];
-        };
-        witness: {
-            signatures: {
-                [k: string]: Signature;
-            };
-            scripts: {
-                [k: string]: Script;
-            };
-            bootstrap: BootstrapWitness[];
-            datums: {
-                [k: string]: Hash64;
-            };
-            redeemers: {
-                [k: string]: Redeemer;
-            };
-        };
-        metadata: AuxiliaryData | Null;
-    }[];
+    body?: BlockBodyAlonzo[];
     headerHash?: Hash16;
@@ -812,2 +830,35 @@ header?: {
 }
+export interface BlockBodyAlonzo {
+    id: Hash16;
+    body: {
+        inputs: TxIn[];
+        collaterals: TxIn[];
+        outputs: TxOut[];
+        certificates: Certificate[];
+        withdrawals: Withdrawals;
+        fee: Lovelace;
+        validityInterval: ValidityInterval;
+        update: UpdateAlonzo;
+        mint: Value;
+        network: Network | Null;
+        scriptIntegrityHash: Hash16 | Null;
+        requiredExtraSignatures: Hash16[];
+    };
+    witness: {
+        signatures: {
+            [k: string]: Signature;
+        };
+        scripts: {
+            [k: string]: Script;
+        };
+        bootstrap: BootstrapWitness[];
+        datums: {
+            [k: string]: Hash64;
+        };
+        redeemers: {
+            [k: string]: Redeemer;
+        };
+    };
+    metadata: AuxiliaryData | Null;
+}
 export interface UpdateProposalAlonzo {
@@ -1052,6 +1103,8 @@ epoch: Epoch;
 }
-export interface UnredeemableScripts {
-    unredeemableScripts: {
-        [k: string]: ScriptPurpose;
-    }[];
+export interface MissingRequiredRedeemers {
+    missingRequiredRedeemers: {
+        missing: {
+            [k: string]: ScriptPurpose;
+        }[];
+    };
 }
@@ -1146,5 +1199,11 @@ export interface Spend {
 }
-export interface GetUtxoFiltered {
+export interface GetUtxoByAddress {
     utxo: Address[];
 }
+export interface GetUtxoByTxIn {
+    utxo: TxIn[];
+}
+export interface GetPoolParameters {
+    poolParameters: (PoolId | string)[];
+}
 export interface Bound {
@@ -1193,2 +1252,39 @@ time: RelativeTime;
 }
+export interface RewardsProvenance {
+    epochLength: Epoch;
+    decentralizationParameter: Ratio;
+    maxLovelaceSupply: Lovelace;
+    mintedBlocks: {
+        [k: string]: UInt64;
+    };
+    totalMintedBlocks: number;
+    totalExpectedBlocks: number;
+    incentive: number;
+    rewardsGap: number;
+    availableRewards: number;
+    totalRewards: number;
+    treasuryTax: number;
+    activeStake: number;
+    pools: {
+        [k: string]: IndividualPoolRewardsProvenance;
+    };
+}
+export interface IndividualPoolRewardsProvenance {
+    totalMintedBlocks: number;
+    totalStakeShare: string;
+    activeStakeShare: string;
+    ownerStake: number;
+    parameters: PoolParameters;
+    pledgeRatio: string;
+    maxRewards: number;
+    apparentPerformance: string;
+    totalRewards: number;
+    leaderRewards: number;
+}
+export interface PoolsRanking {
+    [k: string]: {
+        score: number;
+        estimatedHitRate: number;
+    };
+}
 //# sourceMappingURL=index.d.ts.map

package.json

 {
   "name": "@cardano-ogmios/schema",
-  "version": "4.0.0-beta.9",
+  "version": "4.0.0",
   "description": "Generated TypeScript from the Cardano Ogmios schema",
@@ -17,2 +17,3 @@ "engines": {
   "scripts": {
+    "prebuild": "yarn generate-schema-types",
     "build": "tsc --build ./src",
@@ -22,3 +23,3 @@ "cleanup": "shx rm -rf dist node_modules index.ts",
     "lint": "shx echo No code to lint in this package",
-    "prepack": "yarn generate-schema-types && yarn build",
+    "prepack": "yarn build",
     "test": "shx echo No tests in this package"
@@ -25,0 +26,0 @@ },

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

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

Improved metrics

Total package byte prevSize

89113

increased by5.62%

Lines of code

1280

increased by8.2%

Number of low quality alerts

2

decreased by-33.33%

No dependency changes