@mavrykdynamics/taquito-rpc
Version:
Provides low level methods, and types to invoke RPC calls from a Nomadic Mavryk RPC node
1,424 lines (1,423 loc) • 72.2 kB
TypeScript
import BigNumber from 'bignumber.js';
import { OpKind } from './opkind';
export type BalanceResponse = BigNumber;
export type StorageResponse = ScriptedContracts['storage'];
export type ScriptResponse = ScriptedContracts;
export type BigMapGetResponse = MichelsonV1Expression;
export type ManagerResponse = {
manager: string;
};
export type ManagerKeyResponse = string | {
key: string;
};
export type DelegateResponse = string | null;
export type OperationHash = string;
export type UnstakeRequestsResponse = {
finalizable: {
delegate: string;
cycle: number;
amount: BigNumber;
}[];
unfinalizable: {
delegate: string;
requests: {
cycle: number;
amount: BigNumber;
}[];
};
} | null;
interface INodeExtender {
length: string;
segment: string;
proof: string;
}
type OtherEltsInner = {
value: any;
} | {
inode_extender: INodeExtender;
};
export type OtherElts = {
node: [string, {
value: string;
} | {
node: string;
}][];
} | {
other_elts: OtherEltsInner;
};
export interface Inode {
length: string;
proofs: [string | null, string | null];
}
export interface DelegatesResponse {
full_balance?: BigNumber;
current_frozen_deposits?: BigNumber;
frozen_deposits?: BigNumber;
staking_balance: BigNumber;
delegated_contracts: string[];
delegated_balance: BigNumber;
min_delegated_in_current_cycle?: MinDelegatedInCurrentCycle;
deactivated: boolean;
total_delegated_stake?: BigNumber;
staking_denominator?: BigNumber;
active_consensus_key?: string;
grace_period: number;
pending_denunciations?: boolean;
frozen_deposits_limit?: BigNumber;
voting_power?: BigNumber;
current_ballot?: BallotVote;
current_proposals?: string[];
remaining_proposals?: number;
pending_consensus_keys?: PendingConsensusKey[];
balance?: BigNumber;
frozen_balance?: BigNumber;
frozen_balance_by_cycle?: Frozenbalancebycycle[];
}
export type MinDelegatedInCurrentCycle = {
amount: string;
level?: LevelInfo;
};
export type PendingConsensusKey = {
cycle: number;
pkh: string;
};
export type VotingInfoResponse = {
voting_power?: string;
current_ballot?: BallotListResponseEnum;
current_proposals?: string[];
remaining_proposals?: number;
};
interface Frozenbalancebycycle {
cycle: number;
deposit?: BigNumber;
deposits?: BigNumber;
fees: BigNumber;
rewards: BigNumber;
}
export type BigMapKey = {
key: {
[key: string]: string | object[];
};
type: {
prim: string;
args?: object[];
};
};
export type LiquidityBakingToggleVotes = 'on' | 'off' | 'pass';
export type AdaptiveIssuanceVote = 'on' | 'off' | 'pass';
export interface BlockFullHeader {
level: number;
proto: number;
predecessor: string;
timestamp: TimeStampMixed;
validation_pass: number;
operations_hash: string;
fitness: string[];
context: string;
payload_hash?: string;
payload_round?: number;
priority?: number;
proof_of_work_nonce: string;
seed_nonce_hash?: string;
liquidity_baking_toggle_vote?: LiquidityBakingToggleVotes;
adaptive_issuance_vote?: AdaptiveIssuanceVote;
liquidity_baking_escape_vote?: boolean | LiquidityBakingToggleVotes;
signature: string;
}
export type InlinedAttestationKindEnum = OpKind.ATTESTATION;
export type InlinedEndorsementKindEnum = OpKind.ENDORSEMENT;
export interface InlinedAttestationContents {
kind: InlinedAttestationKindEnum;
slot?: number;
round?: number;
block_payload_hash?: string;
level: number;
}
export interface InlinedEndorsementContents {
kind: InlinedEndorsementKindEnum;
slot?: number;
round?: number;
block_payload_hash?: string;
level: number;
}
export interface InlinedPreattestationContents {
kind: OpKind.PREATTESTATION;
slot: number;
level: number;
round: number;
block_payload_hash: string;
}
export interface InlinedPreEndorsementContents {
kind: OpKind.PREENDORSEMENT;
slot: number;
level: number;
round: number;
block_payload_hash: string;
}
export interface InlinedAttestation {
branch: string;
operations: InlinedAttestationContents;
signature?: string;
}
export interface InlinedEndorsement {
branch: string;
operations: InlinedEndorsementContents;
signature?: string;
}
export interface InlinedPreattestation {
branch: string;
operations: InlinedPreattestationContents;
signature?: string;
}
export interface InlinedPreEndorsement {
branch: string;
operations: InlinedPreEndorsementContents;
signature?: string;
}
export type BallotVote = 'nay' | 'yay' | 'pass';
export interface OperationContentsAttestation {
kind: OpKind.ATTESTATION;
level: number;
slot?: number;
round?: number;
block_payload_hash?: string;
}
export interface OperationContentsEndorsement {
kind: OpKind.ENDORSEMENT;
level: number;
slot?: number;
round?: number;
block_payload_hash?: string;
}
export interface OperationContentsPreattestation {
kind: OpKind.PREATTESTATION;
slot: number;
level: number;
round: number;
block_payload_hash: string;
}
export interface OperationContentsPreEndorsement {
kind: OpKind.PREENDORSEMENT;
slot: number;
level: number;
round: number;
block_payload_hash: string;
}
export interface OperationContentsDoublePreattestation {
kind: OpKind.DOUBLE_PREATTESTATION_EVIDENCE;
op1: InlinedPreattestation;
op2: InlinedPreattestation;
}
export interface OperationContentsDoublePreEndorsement {
kind: OpKind.DOUBLE_PREENDORSEMENT_EVIDENCE;
op1: InlinedPreEndorsement;
op2: InlinedPreEndorsement;
}
export interface OperationContentsSetDepositsLimit {
kind: OpKind.SET_DEPOSITS_LIMIT;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
limit?: string;
}
export interface OperationContentsAttestationWithDal {
kind: OpKind.ATTESTATION_WITH_DAL;
slot: number;
level: number;
round: number;
block_payload_hash: string;
dal_attestation: string;
}
export interface OperationContentsEndorsementWithDal {
kind: OpKind.ENDORSEMENT_WITH_DAL;
slot: number;
level: number;
round: number;
block_payload_hash: string;
dal_attestation: string;
}
export interface OperationContentsRevelation {
kind: OpKind.SEED_NONCE_REVELATION;
level: number;
nonce: string;
}
export interface OperationContentsVdfRevelation {
kind: OpKind.VDF_REVELATION;
solution: string[];
}
export interface OperationContentsDoubleAttestation {
kind: OpKind.DOUBLE_ATTESTATION_EVIDENCE;
op1: InlinedAttestation;
op2: InlinedAttestation;
slot?: number;
}
export interface OperationContentsDoubleEndorsement {
kind: OpKind.DOUBLE_ENDORSEMENT_EVIDENCE;
op1: InlinedEndorsement;
op2: InlinedEndorsement;
slot?: number;
}
export interface OperationContentsDoubleBaking {
kind: OpKind.DOUBLE_BAKING_EVIDENCE;
bh1: BlockFullHeader;
bh2: BlockFullHeader;
}
export interface OperationContentsActivateAccount {
kind: OpKind.ACTIVATION;
pkh: string;
secret: string;
}
export interface OperationContentsFailingNoop {
kind: OpKind.FAILING_NOOP;
arbitrary: string;
}
export interface OperationContentsProposals {
kind: OpKind.PROPOSALS;
source: string;
period: number;
proposals: string[];
}
export interface OperationContentsBallot {
kind: OpKind.BALLOT;
source: string;
period: number;
proposal: string;
ballot: BallotVote;
}
export interface OperationContentsReveal {
kind: OpKind.REVEAL;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
public_key: string;
}
export interface OperationContentsTransaction {
kind: OpKind.TRANSACTION;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
amount: string;
destination: string;
parameters?: TransactionOperationParameter;
}
export interface OperationContentsOrigination {
kind: OpKind.ORIGINATION;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
balance: string;
delegate?: string;
script?: ScriptedContracts;
}
export interface OperationContentsDelegation {
kind: OpKind.DELEGATION;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
delegate?: string;
}
export interface OperationContentsRegisterGlobalConstant {
kind: OpKind.REGISTER_GLOBAL_CONSTANT;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
value: MichelsonV1Expression;
}
export interface OperationContentsTransferTicket {
kind: OpKind.TRANSFER_TICKET;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
ticket_contents: MichelsonV1Expression;
ticket_ty: MichelsonV1Expression;
ticket_ticketer: string;
ticket_amount: string;
destination: string;
entrypoint: string;
}
export interface OperationContentsUpdateConsensusKey {
kind: OpKind.UPDATE_CONSENSUS_KEY;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
pk: string;
}
export interface OperationContentsDrainDelegate {
kind: OpKind.DRAIN_DELEGATE;
consensus_key: string;
delegate: string;
destination: string;
}
export interface OperationContentsIncreasePaidStorage {
kind: OpKind.INCREASE_PAID_STORAGE;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
amount: string;
destination: string;
}
export interface OperationContentsSmartRollupOriginate {
kind: OpKind.SMART_ROLLUP_ORIGINATE;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
pvm_kind: PvmKind;
kernel: string;
parameters_ty: MichelsonV1Expression;
whitelist?: string[];
}
export interface OperationContentsSmartRollupAddMessages {
kind: OpKind.SMART_ROLLUP_ADD_MESSAGES;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
message: string[];
}
export interface OperationContentsSmartRollupExecuteOutboxMessage {
kind: OpKind.SMART_ROLLUP_EXECUTE_OUTBOX_MESSAGE;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
rollup: string;
cemented_commitment: string;
output_proof: string;
}
export interface OperationContentsSmartRollupPublish {
kind: OpKind.SMART_ROLLUP_PUBLISH;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
rollup: string;
commitment: SmartRollupPublishCommitment;
}
export interface OperationContentsSmartRollupCement {
kind: OpKind.SMART_ROLLUP_CEMENT;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
rollup: string;
commitment: string;
}
export interface OperationContentsSmartRollupRefute {
kind: OpKind.SMART_ROLLUP_REFUTE;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
rollup: string;
opponent: string;
refutation: SmartRollupRefutation;
}
export interface OperationContentsSmartRollupRecoverBond {
kind: OpKind.SMART_ROLLUP_RECOVER_BOND;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
rollup: string;
staker: string;
}
export interface OperationContentsSmartRollupTimeout {
kind: OpKind.SMART_ROLLUP_TIMEOUT;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
rollup: string;
stakers: SmartRollupTimeoutStakers;
}
export interface OperationContentsDalPublishCommitment {
kind: OpKind.DAL_PUBLISH_COMMITMENT;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
slot_header: {
slot_index: number;
commitment: string;
commitment_proof: string;
};
}
export type OperationContents = OperationContentsAttestation | OperationContentsPreattestation | OperationContentsDoublePreattestation | OperationContentsEndorsement | OperationContentsPreEndorsement | OperationContentsDoublePreEndorsement | OperationContentsRevelation | OperationContentsVdfRevelation | OperationContentsDoubleAttestation | OperationContentsDoubleEndorsement | OperationContentsDoubleBaking | OperationContentsActivateAccount | OperationContentsProposals | OperationContentsBallot | OperationContentsReveal | OperationContentsTransaction | OperationContentsOrigination | OperationContentsDelegation | OperationContentsAttestationWithDal | OperationContentsEndorsementWithDal | OperationContentsFailingNoop | OperationContentsRegisterGlobalConstant | OperationContentsSetDepositsLimit | OperationContentsTransferTicket | OperationContentsUpdateConsensusKey | OperationContentsDrainDelegate | OperationContentsIncreasePaidStorage | OperationContentsSmartRollupOriginate | OperationContentsSmartRollupAddMessages | OperationContentsSmartRollupExecuteOutboxMessage | OperationContentsSmartRollupPublish | OperationContentsSmartRollupCement | OperationContentsSmartRollupRefute | OperationContentsSmartRollupRecoverBond | OperationContentsSmartRollupTimeout | OperationContentsDalPublishCommitment;
export interface OperationContentsAndResultMetadataExtended1 {
balance_updates?: OperationMetadataBalanceUpdates[];
delegate: string;
consensus_power: number;
consensus_key: string;
}
export interface OperationContentsAndResultMetadataExtended0 {
balance_updates?: OperationMetadataBalanceUpdates[];
delegate: string;
endorsement_power: number;
consensus_key?: string;
}
export interface OperationContentsAndResultMetadataPreattestation {
balance_updates?: OperationMetadataBalanceUpdates[];
delegate: string;
consensus_power: number;
consensus_key?: string;
}
export interface OperationContentsAndResultMetadataPreEndorsement {
balance_updates?: OperationMetadataBalanceUpdates[];
delegate: string;
preendorsement_power: number;
consensus_key?: string;
}
export interface OperationContentsAndResultMetadataReveal {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultReveal;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataTransaction {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultTransaction;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataDelegation {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultDelegation;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataRegisterGlobalConstant {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultRegisterGlobalConstant;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataSetDepositsLimit {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultSetDepositsLimit;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadata {
balance_updates?: OperationMetadataBalanceUpdates[];
}
export interface OperationContentsAndResultMetadataTransferTicket {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultTransferTicket;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataIncreasePaidStorage {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultIncreasePaidStorage;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataUpdateConsensusKey {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultUpdateConsensusKey;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataDrainDelegate {
balance_updates?: OperationMetadataBalanceUpdates[];
allocated_destination_contract?: boolean;
}
export interface OperationContentsAndResultMetadataSmartRollupOriginate {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultSmartRollupOriginate;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataSmartRollupAddMessages {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultSmartRollupAddMessages;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataSmartRollupExecuteOutboxMessage {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultSmartRollupExecuteOutboxMessage;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataSmartRollupPublish {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultSmartRollupPublish;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataSmartRollupCement {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultSmartRollupCement;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataSmartRollupRefute {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultSmartRollupRefute;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataSmartRollupRecoverBond {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultSmartRollupRecoverBond;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataSmartRollupTimeout {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultSmartRollupTimeout;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultMetadataDalPublishCommitment {
balance_updates?: OperationMetadataBalanceUpdates[];
operation_result: OperationResultDalPublishCommitment;
internal_operation_results?: InternalOperationResult[];
}
export interface OperationContentsAndResultAttestation {
kind: OpKind.ATTESTATION;
block_payload_hash?: string;
level: number;
round?: number;
slot?: number;
metadata: OperationContentsAndResultMetadataExtended1;
}
export interface OperationContentsAndResultEndorsement {
kind: OpKind.ENDORSEMENT;
block_payload_hash?: string;
level: number;
round?: number;
slot?: number;
metadata: OperationContentsAndResultMetadataExtended0;
}
export interface OperationContentsAndResultPreattestation {
kind: OpKind.PREATTESTATION;
slot: number;
level: number;
round: number;
block_payload_hash: string;
metadata: OperationContentsAndResultMetadataPreattestation;
}
export interface OperationContentsAndResultPreEndorsement {
kind: OpKind.PREENDORSEMENT;
slot: number;
level: number;
round: number;
block_payload_hash: string;
metadata: OperationContentsAndResultMetadataPreEndorsement;
}
export interface OperationContentsAndResultDoublePreattestation {
kind: OpKind.DOUBLE_PREATTESTATION_EVIDENCE;
op1: InlinedPreattestation;
op2: InlinedPreattestation;
metadata: OperationContentsAndResultMetadata;
}
export interface OperationContentsAndResultAttestationWithDal {
kind: OpKind.ATTESTATION_WITH_DAL;
slot: number;
level: number;
round: number;
block_payload_hash: string;
dal_attestation: string;
metadata: OperationContentsAndResultMetadataExtended1;
}
export interface OperationContentsAndResultDoublePreEndorsement {
kind: OpKind.DOUBLE_PREENDORSEMENT_EVIDENCE;
op1: InlinedPreEndorsement;
op2: InlinedPreEndorsement;
metadata: OperationContentsAndResultMetadata;
}
export interface OperationContentsAndResultEndorsementWithDal {
kind: OpKind.ENDORSEMENT_WITH_DAL;
slot: number;
level: number;
round: number;
block_payload_hash: string;
dal_attestation: string;
metadata: OperationContentsAndResultMetadataExtended0;
}
export interface OperationContentsAndResultRevelation {
kind: OpKind.SEED_NONCE_REVELATION;
level: number;
nonce: string;
metadata: OperationContentsAndResultMetadata;
}
export interface OperationContentsAndResultDoubleAttestation {
kind: OpKind.DOUBLE_ATTESTATION_EVIDENCE;
op1: InlinedAttestation;
op2: InlinedAttestation;
slot?: number;
metadata: OperationContentsAndResultMetadata;
}
export interface OperationContentsAndResultDoubleEndorsement {
kind: OpKind.DOUBLE_ENDORSEMENT_EVIDENCE;
op1: InlinedEndorsement;
op2: InlinedEndorsement;
slot?: number;
metadata: OperationContentsAndResultMetadata;
}
export interface OperationContentsAndResultDoubleBaking {
kind: OpKind.DOUBLE_BAKING_EVIDENCE;
bh1: BlockFullHeader;
bh2: BlockFullHeader;
metadata: OperationContentsAndResultMetadata;
}
export interface OperationContentsAndResultActivateAccount {
kind: OpKind.ACTIVATION;
pkh: string;
secret: string;
metadata: OperationContentsAndResultMetadata;
}
export interface OperationContentsAndResultProposals {
kind: OpKind.PROPOSALS;
source: string;
period: number;
proposals: string[];
}
export interface OperationContentsAndResultBallot {
kind: OpKind.BALLOT;
source: string;
period: number;
proposal: string;
ballot: BallotVote;
}
export interface OperationContentsAndResultReveal {
kind: OpKind.REVEAL;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
public_key: string;
metadata: OperationContentsAndResultMetadataReveal;
}
export interface OperationContentsAndResultTransaction {
kind: OpKind.TRANSACTION;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
amount: string;
destination: string;
parameters?: TransactionOperationParameter;
metadata: OperationContentsAndResultMetadataTransaction;
}
export interface OperationContentsAndResultDelegation {
kind: OpKind.DELEGATION;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
delegate?: string;
metadata: OperationContentsAndResultMetadataDelegation;
}
export interface OperationContentsAndResultRegisterGlobalConstant {
kind: OpKind.REGISTER_GLOBAL_CONSTANT;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
value: MichelsonV1Expression;
metadata: OperationContentsAndResultMetadataRegisterGlobalConstant;
}
export interface OperationContentsAndResultSetDepositsLimit {
kind: OpKind.SET_DEPOSITS_LIMIT;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
limit?: string;
metadata: OperationContentsAndResultMetadataSetDepositsLimit;
}
export interface OperationContentsAndResultTransferTicket {
kind: OpKind.TRANSFER_TICKET;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
ticket_contents: MichelsonV1Expression;
ticket_ty: MichelsonV1Expression;
ticket_ticketer: string;
ticket_amount: string;
destination: string;
entrypoint: string;
metadata: OperationContentsAndResultMetadataTransferTicket;
}
export interface OperationContentsAndResultUpdateConsensusKey {
kind: OpKind.UPDATE_CONSENSUS_KEY;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
pk: string;
metadata: OperationContentsAndResultMetadataUpdateConsensusKey;
}
export interface OperationContentsAndResultDrainDelegate {
kind: OpKind.DRAIN_DELEGATE;
consensus_key: string;
delegate: string;
destination: string;
metadata: OperationContentsAndResultMetadataDrainDelegate;
}
export interface OperationContentsAndResultIncreasePaidStorage {
kind: OpKind.INCREASE_PAID_STORAGE;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
amount: string;
destination: string;
metadata: OperationContentsAndResultMetadataIncreasePaidStorage;
}
export interface OperationContentsAndResultVdfRevelation {
kind: OpKind.VDF_REVELATION;
solution: string[];
metadata: OperationContentsAndResultMetadata;
}
export interface OperationContentsAndResultSmartRollupOriginate {
kind: OpKind.SMART_ROLLUP_ORIGINATE;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
pvm_kind: PvmKind;
kernel: string;
parameters_ty: MichelsonV1Expression;
whitelist?: string[];
metadata: OperationContentsAndResultMetadataSmartRollupOriginate;
}
export interface OperationContentsAndResultSmartRollupAddMessages {
kind: OpKind.SMART_ROLLUP_ADD_MESSAGES;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
message: string[];
metadata: OperationContentsAndResultMetadataSmartRollupAddMessages;
}
export interface OperationContentsAndResultSmartRollupExecuteOutboxMessage {
kind: OpKind.SMART_ROLLUP_EXECUTE_OUTBOX_MESSAGE;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
rollup: string;
cemented_commitment: string;
output_proof: string;
metadata: OperationContentsAndResultMetadataSmartRollupExecuteOutboxMessage;
}
export interface OperationContentsAndResultSmartRollupPublish {
kind: OpKind.SMART_ROLLUP_PUBLISH;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
rollup: string;
commitment: SmartRollupPublishCommitment;
metadata: OperationContentsAndResultMetadataSmartRollupPublish;
}
export interface OperationContentsAndResultSmartRollupCement {
kind: OpKind.SMART_ROLLUP_CEMENT;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
rollup: string;
metadata: OperationContentsAndResultMetadataSmartRollupCement;
}
export interface OperationContentsAndResultSmartRollupRefute {
kind: OpKind.SMART_ROLLUP_REFUTE;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
rollup: string;
opponent: string;
refutation: SmartRollupRefutation;
metadata: OperationContentsAndResultMetadataSmartRollupRefute;
}
export interface OperationContentsAndResultSmartRollupRecoverBond {
kind: OpKind.SMART_ROLLUP_RECOVER_BOND;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
rollup: string;
staker: string;
metadata: OperationContentsAndResultMetadataSmartRollupRecoverBond;
}
export interface OperationContentsAndResultSmartRollupTimeout {
kind: OpKind.SMART_ROLLUP_TIMEOUT;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
rollup: string;
stakers: SmartRollupTimeoutStakers;
metadata: OperationContentsAndResultMetadataSmartRollupTimeout;
}
export interface OperationContentsAndResultDalPublishCommitment {
kind: OpKind.DAL_PUBLISH_COMMITMENT;
source: string;
fee: string;
counter: string;
gas_limit: string;
storage_limit: string;
slot_header: {
slot_index: number;
commitment: string;
commitment_proof: string;
};
metadata: OperationContentsAndResultMetadataDalPublishCommitment;
}
export type OperationContentsAndResult = OperationContentsAndResultAttestation | OperationContentsAndResultPreattestation | OperationContentsAndResultDoublePreattestation | OperationContentsAndResultEndorsement | OperationContentsAndResultPreEndorsement | OperationContentsAndResultDoublePreEndorsement | OperationContentsAndResultRevelation | OperationContentsAndResultDoubleEndorsement | OperationContentsAndResultDoubleAttestation | OperationContentsAndResultDoubleBaking | OperationContentsAndResultActivateAccount | OperationContentsAndResultProposals | OperationContentsAndResultBallot | OperationContentsAndResultReveal | OperationContentsAndResultTransaction | OperationContentsAndResultOrigination | OperationContentsAndResultDelegation | OperationContentsAndResultAttestationWithDal | OperationContentsAndResultEndorsementWithDal | OperationContentsAndResultRegisterGlobalConstant | OperationContentsAndResultSetDepositsLimit | OperationContentsAndResultTransferTicket | OperationContentsAndResultIncreasePaidStorage | OperationContentsAndResultUpdateConsensusKey | OperationContentsAndResultDrainDelegate | OperationContentsAndResultVdfRevelation | OperationContentsAndResultSmartRollupOriginate | OperationContentsAndResultSmartRollupAddMessages | OperationContentsAndResultSmartRollupExecuteOutboxMessage | OperationContentsAndResultSmartRollupPublish | OperationContentsAndResultSmartRollupCement | OperationContentsAndResultSmartRollupRefute | OperationContentsAndResultSmartRollupRecoverBond | OperationContentsAndResultSmartRollupTimeout | OperationContentsAndResultDalPublishCommitment;
export type OperationContentsAndResultWithFee = OperationContentsAndResultTransaction | OperationContentsAndResultOrigination | OperationContentsAndResultDelegation | OperationContentsAndResultReveal | OperationContentsAndResultRegisterGlobalConstant | OperationContentsAndResultSetDepositsLimit | OperationContentsAndResultUpdateConsensusKey | OperationContentsAndResultIncreasePaidStorage | OperationContentsAndResultTransferTicket | OperationContentsAndResultSmartRollupAddMessages | OperationContentsAndResultSmartRollupOriginate | OperationContentsAndResultSmartRollupExecuteOutboxMessage | OperationContentsAndResultDalPublishCommitment;
export declare enum OPERATION_METADATA {
TOO_LARGE = "too large"
}
export interface OperationEntry {
protocol: string;
chain_id: string;
hash: string;
branch: string;
contents: (OperationContents | OperationContentsAndResult)[];
signature?: string;
metadata?: OPERATION_METADATA;
}
export interface BlockResponse {
protocol: string;
chain_id: string;
hash: string;
header: BlockFullHeader;
metadata: BlockMetadata;
operations: OperationEntry[][];
}
export type BakingRightsArgumentsDelegate = string | string[];
export type BakingRightsArgumentsCycle = number | number[];
export type BakingRightsArgumentsLevel = number | number[];
export type AllDelegatesQueryArguments = {
active?: boolean;
inactive?: boolean;
with_minimal_stake?: boolean;
without_minimal_stake?: boolean;
};
export type BakingRightsQueryArguments = BakingRightsQueryArgumentsBase;
export interface BakingRightsQueryArgumentsBase {
level?: BakingRightsArgumentsLevel;
cycle?: BakingRightsArgumentsCycle;
delegate?: BakingRightsArgumentsDelegate;
consensus_key?: string;
max_priority?: number;
max_round?: string;
all?: null;
}
export interface BakingRightsResponseItem {
level: number;
delegate: string;
priority?: number;
round?: number;
estimated_time?: Date;
consensus_key?: string;
}
export type BakingRightsResponse = BakingRightsResponseItem[];
export type AttestationRightsArgumentsDelegate = string | string[];
export type AttestationRightsArgumentsCycle = number | number[];
export type AttestationRightsArgumentsLevel = number | number[];
export interface AttestationRightsQueryArguments {
level?: AttestationRightsArgumentsLevel;
cycle?: AttestationRightsArgumentsCycle;
delegate?: AttestationRightsArgumentsDelegate;
consensus_key?: string;
}
export interface AttestationRightsResponseItemDelegates {
delegate: string;
first_slot: number;
attestation_power: number;
consensus_key: string;
}
export interface AttestationRightsResponseItem {
level: number;
delegate?: string;
delegates?: AttestationRightsResponseItemDelegates[];
slots?: number[];
estimated_time?: Date;
}
export type AttestationRightsResponse = AttestationRightsResponseItem[];
export type BallotListResponseEnum = 'nay' | 'yay' | 'pass';
export interface BallotListResponseItem {
pkh: string;
ballot: BallotListResponseEnum;
}
export type BallotListResponse = BallotListResponseItem[];
export interface BallotsResponse {
yay: BigNumber;
nay: BigNumber;
pass: BigNumber;
}
export type PeriodKindResponse = 'proposal' | 'exploration' | 'cooldown' | 'promotion' | 'adoption' | 'testing_vote' | 'testing' | 'promotion_vote';
export type CurrentProposalResponse = string | null;
export type CurrentQuorumResponse = number;
export interface VotesListingsResponseItem {
pkh: string;
rolls?: number;
voting_power?: BigNumber;
}
export type VotesListingsResponse = VotesListingsResponseItem[];
export type ProposalsResponseItem = [string, BigNumber];
export type ProposalsResponse = ProposalsResponseItem[];
export type HeaderContentEnum = 'activate' | 'activate_testchain';
export interface HeaderContent {
command: HeaderContentEnum;
hash: string;
fitness: string[];
protocol_parameters: string;
}
export interface BlockHeaderResponse {
protocol: string;
chain_id: string;
hash: string;
level: number;
proto: number;
predecessor: string;
timestamp: string;
validation_pass: number;
operations_hash: string;
fitness: string[];
context: string;
content: HeaderContent;
payload_hash?: string;
payload_round?: number;
priority?: number;
proof_of_work_nonce: string;
liquidity_baking_escape_vote?: boolean | LiquidityBakingToggleVotes;
signature: string;
}
export interface PackDataParams {
data: MichelsonV1Expression;
type: MichelsonV1Expression;
gas?: BigNumber;
}
export interface TicketTokenParams {
ticketer: string;
content_type: MichelsonV1Expression;
content: MichelsonV1Expression;
}
export interface TicketBalance {
ticketer: string;
content_type: MichelsonV1Expression;
content: MichelsonV1Expression;
amount: string;
}
export type AllTicketBalances = TicketBalance[];
export type HexString = string;
export interface PackDataResponse {
packed: HexString;
gas?: BigNumber | 'unaccounted';
}
export type BigMapResponse = MichelsonV1Expression | MichelsonV1Expression[];
export type SaplingDiffResponse = {
root: SaplingTransactionCommitmentHash;
commitments_and_ciphertexts: CommitmentsAndCiphertexts[];
nullifiers: string[];
};
export type SaplingTransactionCommitmentHash = string;
export type PreapplyParams = OperationObject[];
export type PreapplyResponse = {
contents: OperationContentsAndResult[];
};
export type ForgeOperationsParams = Pick<OperationObject, 'branch' | 'contents'>;
export type TimeStampMixed = Date | string;
export type BalanceUpdateKindEnum = MetadataBalanceUpdatesKindEnum;
export type BalanceUpdateCategoryEnum = MetadataBalanceUpdatesCategoryEnum;
export interface MichelsonV1ExpressionBase {
int?: string;
string?: string;
bytes?: string;
}
export interface MichelsonV1ExpressionExtended {
prim: string;
args?: MichelsonV1Expression[];
annots?: string[];
}
export type MichelsonV1Expression = MichelsonV1ExpressionBase | MichelsonV1ExpressionExtended | MichelsonV1Expression[];
export interface ScriptedContracts {
code: MichelsonV1Expression[];
storage: MichelsonV1Expression;
}
export type AILaunchCycleResponse = number | null;
export type BondId = {
smart_rollup: string;
};
export type OperationBalanceUpdates = OperationMetadataBalanceUpdates[];
export interface OperationObject {
branch?: string;
contents?: OperationContents[];
protocol?: string;
signature?: string;
}
export type InternalOperationResultKindEnum = OpKind.TRANSACTION | OpKind.ORIGINATION | OpKind.DELEGATION | OpKind.EVENT;
export type SuccessfulManagerOperationResultKindEnum = OpKind.REVEAL | OpKind.TRANSACTION | OpKind.ORIGINATION | OpKind.DELEGATION;
export type InternalOperationResultEnum = OperationResultReveal | OperationResultTransaction | OperationResultDelegation | OperationResultOrigination | OperationResultEvent;
export interface OperationResultTransferTicket {
status: OperationResultStatusEnum;
balance_updates?: OperationBalanceUpdates;
ticket_updates?: TicketUpdates[];
consumed_milligas?: string;
paid_storage_size_diff?: string;
errors?: MavrykGenericOperationError[];
}
export interface OperationResultIncreasePaidStorage {
status: OperationResultStatusEnum;
balance_updates?: OperationBalanceUpdates;
consumed_milligas?: string;
errors?: MavrykGenericOperationError[];
}
export interface OperationResultUpdateConsensusKey {
status: OperationResultStatusEnum;
consumed_milligas?: string;
errors?: MavrykGenericOperationError[];
}
export interface OperationResultDelegation {
status: OperationResultStatusEnum;
consumed_gas?: string;
errors?: MavrykGenericOperationError[];
consumed_milligas?: string;
}
export interface OperationResultSetDepositsLimit {
status: OperationResultStatusEnum;
consumed_gas?: string;
errors?: MavrykGenericOperationError[];
consumed_milligas?: string;
}
export interface OperationResultRegisterGlobalConstant {
status: OperationResultStatusEnum;
balance_updates?: OperationBalanceUpdates;
consumed_gas?: string;
storage_size?: string;
global_address?: string;
errors?: MavrykGenericOperationError[];
consumed_milligas?: string;
}
export interface OperationResultSmartRollupOriginate {
status: OperationResultStatusEnum;
balance_updates?: OperationBalanceUpdates;
address?: string;
genesis_commitment_hash?: string;
consumed_milligas?: string;
size?: string;
errors?: MavrykGenericOperationError[];
}
export interface OperationResultSmartRollupAddMessages {
status: OperationResultStatusEnum;
consumed_milligas?: string;
errors?: MavrykGenericOperationError[];
}
export interface OperationResultSmartRollupExecuteOutboxMessage {
status: OperationResultStatusEnum;
balance_updates?: OperationBalanceUpdates;
ticket_updates?: TicketUpdates[];
consumed_milligas?: string;
paid_storage_size_diff?: string;
errors?: MavrykGenericOperationError[];
}
export interface OperationResultSmartRollupPublish {
status: OperationResultStatusEnum;
consumed_milligas?: string;
staked_hash?: string;
published_at_level?: number;
balance_updates?: OperationBalanceUpdates;
errors?: MavrykGenericOperationError[];
}
export interface OperationResultSmartRollupCement {
status: OperationResultStatusEnum;
consumed_milligas?: string;
inbox_level?: number;
commitment_hash?: string;
errors?: MavrykGenericOperationError[];
}
export interface OperationResultSmartRollupRefute {
status: OperationResultStatusEnum;
consumed_milligas?: string;
game_status?: SmartRollupGameStatus;
balance_updates?: OperationBalanceUpdates;
errors?: MavrykGenericOperationError[];
}
export interface OperationResultSmartRollupRecoverBond {
status: OperationResultStatusEnum;
balance_updates?: OperationBalanceUpdates;
consumed_milligas?: string;
errors?: MavrykGenericOperationError[];
}
export interface OperationResultSmartRollupTimeout {
status: OperationResultStatusEnum;
consumed_milligas?: string;
game_status?: SmartRollupGameStatus;
balance_updates?: OperationBalanceUpdates;
errors?: MavrykGenericOperationError[];
}
export interface OperationResultDalPublishCommitment {
status: OperationResultStatusEnum;
slot_header?: {
version: string;
level: number;
index: number;
commitment: string;
};
consumed_milligas?: string;
errors?: MavrykGenericOperationError[];
}
export interface ContractBigMapDiffItem {
key_hash?: string;
key?: MichelsonV1Expression;
value?: MichelsonV1Expression;
action?: DiffActionEnum;
big_map?: string;
source_big_map?: string;
destination_big_map?: string;
key_type?: MichelsonV1Expression;
value_type?: MichelsonV1Expression;
}
export type ContractBigMapDiff = ContractBigMapDiffItem[];
export interface MavrykGenericOperationError {
kind: string;
id: string;
delegate?: string;
}
export interface TicketUpdates {
ticket_token: {
ticketer: string;
content_type: MichelsonV1Expression;
content: MichelsonV1Expression;
};
updates: {
account: string;
amount: string;
}[];
}
export type TicketReceipt = TicketUpdates;
export type BatchOperationResult = OperationResultTransaction | OperationResultReveal | OperationResultDelegation | OperationResultOrigination | OperationResultIncreasePaidStorage | OperationResultRegisterGlobalConstant | OperationResultTransferTicket | OperationResultSmartRollupAddMessages | OperationResultSmartRollupOriginate | OperationResultUpdateConsensusKey;
export type OperationResult = OperationResultOrigination | OperationResultTransaction | OperationResultReveal | OperationResultDelegation | OperationResultIncreasePaidStorage | OperationResultRegisterGlobalConstant | OperationResultTransferTicket | OperationResultUpdateConsensusKey | OperationResultSmartRollupOriginate | OperationResultSmartRollupAddMessages | OperationResultSetDepositsLimit | OperationResultSmartRollupPublish | OperationResultSmartRollupCement | OperationResultSmartRollupRefute | OperationResultSmartRollupRecoverBond | OperationResultSmartRollupTimeout | OperationResultSmartRollupExecuteOutboxMessage | OperationResultDalPublishCommitment;
export interface OperationResultTransaction {
status: OperationResultStatusEnum;
storage?: MichelsonV1Expression;
big_map_diff?: ContractBigMapDiff;
balance_updates?: OperationBalanceUpdates;
ticket_updates?: TicketUpdates[];
ticket_receipt?: TicketReceipt[];
originated_contracts?: string[];
consumed_gas?: string;
storage_size?: string;
paid_storage_size_diff?: string;
allocated_destination_contract?: boolean;
errors?: MavrykGenericOperationError[];
consumed_milligas?: string;
lazy_storage_diff?: LazyStorageDiff[];
ticket_hash?: string;
}
export interface OperationResultReveal {
status: OperationResultStatusEnum;
consumed_gas?: string;
errors?: MavrykGenericOperationError[];
consumed_milligas?: string;
}
export interface TransactionOperationParameter {
entrypoint: string;
value: MichelsonV1Expression;
}
export interface InternalOperationResult {
kind: InternalOperationResultKindEnum;
source: string;
nonce: number;
amount?: string;
destination?: string;
parameters?: TransactionOperationParameter;
public_key?: string;
balance?: string;
delegate?: string;
script?: ScriptedContracts;
value?: MichelsonV1Expression;
limit?: string;
result: InternalOperationResultEnum;
type?: MichelsonV1Expression;
tag?: string;
payload?: MichelsonV1Expression;
}
export interface SuccessfulManagerOperationResult {
kind: SuccessfulManagerOperationResultKindEnum;
consumed_gas?: string;
consumed_milligas?: string;
storage?: MichelsonV1Expression;
big_map_diff?: ContractBigMapDiff;
balance_updates?: OperationBalanceUpdates;
originated_contracts?: string[];
storage_size?: string;
paid_storage_size_diff?: string;
lazy_storage_diff?: LazyStorageDiff[];
}
export type MetadataBalanceUpdatesKindEnum = 'contract' | 'freezer' | 'accumulator' | 'burned' | 'commitment' | 'minted' | 'staking';
export declare enum METADATA_BALANCE_UPDATES_CATEGORY {
BAKING_BONUSES = "baking bonuses",
BAKING_REWARDS = "baking rewards",
BLOCK_FEES = "block fees",
BONDS = "bonds",
BOOTSTRAP = "bootstrap",
BURNED = "burned",
COMMITMENT = "commitment",
DELEGATE_DENOMINATOR = "delegate_denominator",
DELEGATOR_NUMERATOR = "delegator_numerator",
DEPOSITS = "deposits",
ENDORSING_REWARDS = "endorsing rewards",
INVOICE = "invoice",
LOST_ENDORSING_REWARDS = "lost endorsing rewards",
MINTED = "minted",
NONCE_REVELATION_REWARDS = "nonce revelation rewards",
PUNISHMENTS = "punishments",
SMART_ROLLUP_REFUTATION_PUNISHMENTS = "smart_rollup_refutation_punishments",
SMART_ROLLUP_REFUTATION_REWARDS = "smart_rollup_refutation_rewards",
STORAGE_FEES = "storage fees",
SUBSIDY = "subsidy",
UNSTAKED_DEPOSITS = "unstaked_deposits"
}
export type MetadataBalanceUpdatesCategoryEnum = METADATA_BALANCE_UPDATES_CATEGORY;
export type MetadataBalanceUpdatesOriginEnum = 'block' | 'migration' | 'subsidy' | 'simulation' | 'delayed_operation';
export type FrozenStaker = SingleStaker | SharedStaker | Baker;
export type Staker = SingleStaker | SharedStaker;
export interface SingleStaker {
contract: string;
delegate: string;
}
export interface SharedStaker {
delegate: string;
}
export interface Baker {
baker: string;
}
export interface OperationMetadataBalanceUpdates {
kind: MetadataBalanceUpdatesKindEnum;
contract?: string;
change: string;
origin?: MetadataBalanceUpdatesOriginEnum;
category?: MetadataBalanceUpdatesCategoryEnum;
staker?: FrozenStaker | Staker;
delegate?: string;
participation?: boolean;
revelation?: boolean;
committer?: string;
bond_id?: BondId;
cycle?: number;
delegator?: string;
}
export type OperationResultStatusEnum = 'applied' | 'failed' | 'skipped' | 'backtracked';
export type DiffActionEnum = 'update' | 'remove' | 'copy' | 'alloc';
export type LazyStorageDiff = LazyStorageDiffBigMap | LazyStorageDiffSaplingState;
export interface LazyStorageDiffBigMap {
kind: 'big_map';
id: string;
diff: LazyStorageDiffBigMapItems;
}
export interface LazyStorageDiffSaplingState {
kind: 'sapling_state';
id: string;
diff: LazyStorageDiffSaplingStateItems;
}
export interface LazyStorageDiffBigMapItems {
action: DiffActionEnum;
updates?: LazyStorageDiffUpdatesBigMap[];
source?: string;
key_type?: MichelsonV1Expression;
value_type?: MichelsonV1Expression;
}
export interface LazyStorageDiffSaplingStateItems {
action: DiffActionEnum;
updates?: LazyStorageDiffUpdatesSaplingState;
source?: string;
memo_size?: number;
}
export interface LazyStorageDiffUpdatesBigMap {
key_hash: string;
key: MichelsonV1Expression;
value?: MichelsonV1Expression;
}
export type CommitmentsAndCiphertexts = [
SaplingTransactionCommitment,
SaplingTransactionCiphertext
];
export type SaplingTransactionCommitment = string;
export interface LazyStorageDiffUpdatesSaplingState {
commitments_and_ciphertexts: CommitmentsAndCiphertexts[];
nullifiers: string[];
}
export interface SaplingTransactionCiphertext {
cv: string;
epk: string;
payload_enc: string;
nonce_enc: string;
payload_out: string;
nonce_out: string;
}
export interface OperationResultOrigination {
status: OperationResultStatusEnum;
big_map_diff?: ContractBigMapDiff;
balance_updates?: OperationBalanceUpdates;
originated_contracts?: string[];
consumed_gas?: string;
storage_size?: string;
paid_storage_size_diff?: string;
errors?: MavrykGenericOperationError[];
consumed_milligas?: string;
lazy_storage_diff?: LazyStorageDiff[];
}
export interface OperationResultEvent {
status: OperationResultStatusEnum;
consumed_milligas?: string;
errors?: MavrykGenericOperationError[];
}
export interface OperationContentsAndResultMetadataOrigination {
balance_updates: OperationMetadataBalanceUpdates[];
operation_result: OperationResultOrigination;
internal_operation_results?: InternalOperationResult[];
}
export type ConstantsResponse = ConstantsResponseCommon & ConstantsResponseProto020 & ConstantsResponseProto019 & ConstantsResponseProto017 & ConstantsResponseProto016 & ConstantsResponseProto015 & ConstantsResponseProto014 & ConstantsResponseProto013 & ConstantsResponseProto012 & ConstantsResponseProto011 & ConstantsResponseProto010 & ConstantsResponseProto009 & ConstantsResponseProto008 & ConstantsResponseProto007 & ConstantsResponseProto006 & ConstantsResponseProto005 & ConstantsResponseProto004 & ConstantsResponseProto003 & ConstantsResponseProto001And002;
export interface ConstantsResponseCommon {
proof_of_work_nonce_size: number;
nonce_length: number;
max_operation_data_length: number;
preserved_cycles: number;
blocks_per_cycle: number;
blocks_per_commitment: number;
blocks_per_roll_snapshot: number;
blocks_per_voting_period: number;
time_between_blocks: BigNumber[];
endorsers_per_block: number;
hard_gas_limit_per_operation: BigNumber;
hard_gas_limit_per_block: BigNumber;
proof_of_work_threshold: BigNumber;
tokens_per_roll: BigNumber;