GetBlockApi

type GetBlockApi = object;

Methods

getBlock()

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter	Type
`slot`	`bigint`
`config`	`Readonly`<{ `commitment?`: `Omit`<`Commitment`, `"processed"`>; `encoding?`: `GetBlockEncoding`; `maxSupportedTransactionVersion?`: `GetBlockMaxSupportedTransactionVersion`; `rewards?`: `boolean`; `transactionDetails?`: `GetBlockTransactionDetailsMode`; }> & `Readonly`<{ `rewards`: `false`; `transactionDetails`: `"none"`; }>

Returns

| Readonly<{ blockhash: Blockhash; blockHeight: bigint; blockTime: UnixTimestamp; parentSlot: Slot; previousBlockhash: Blockhash; }> | null

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  rewards: readonly Reward[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter	Type
`slot`	`bigint`
`config`	`Readonly`<{ `commitment?`: `Omit`<`Commitment`, `"processed"`>; `encoding?`: `GetBlockEncoding`; `maxSupportedTransactionVersion?`: `GetBlockMaxSupportedTransactionVersion`; `rewards?`: `boolean`; `transactionDetails?`: `GetBlockTransactionDetailsMode`; }> & `Readonly`<{ `rewards?`: `true`; `transactionDetails`: `"none"`; }>

| Readonly<{ blockhash: Blockhash; blockHeight: bigint; blockTime: UnixTimestamp; parentSlot: Slot; previousBlockhash: Blockhash; }> & Readonly<{ rewards: readonly Reward[]; }> | null

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  signatures: readonly Base58EncodedBytes[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter	Type
`slot`	`bigint`
`config`	`Readonly`<{ `commitment?`: `Omit`<`Commitment`, `"processed"`>; `encoding?`: `GetBlockEncoding`; `maxSupportedTransactionVersion?`: `GetBlockMaxSupportedTransactionVersion`; `rewards?`: `boolean`; `transactionDetails?`: `GetBlockTransactionDetailsMode`; }> & `Readonly`<{ `rewards`: `false`; `transactionDetails`: `"signatures"`; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  rewards: readonly Reward[];
}> & Readonly<{
  signatures: readonly Base58EncodedBytes[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter	Type
`slot`	`bigint`
`config`	`Readonly`<{ `commitment?`: `Omit`<`Commitment`, `"processed"`>; `encoding?`: `GetBlockEncoding`; `maxSupportedTransactionVersion?`: `GetBlockMaxSupportedTransactionVersion`; `rewards?`: `boolean`; `transactionDetails?`: `GetBlockTransactionDetailsMode`; }> & `Readonly`<{ `rewards?`: `true`; `transactionDetails`: `"signatures"`; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter Type

slot bigint

config Readonly<{ commitment?: Omit<Commitment, "processed">; encoding?: GetBlockEncoding; maxSupportedTransactionVersion?: GetBlockMaxSupportedTransactionVersion; rewards?: boolean; transactionDetails?: GetBlockTransactionDetailsMode; }> & Readonly<{ maxSupportedTransactionVersion: GetBlockMaxSupportedTransactionVersion; rewards: false; transactionDetails: "accounts"; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter	Type
`slot`	`bigint`
`config`	`Omit`<`Readonly`<{ `commitment?`: `Omit`<`Commitment`, `"processed"`>; `encoding?`: `GetBlockEncoding`; `maxSupportedTransactionVersion?`: `GetBlockMaxSupportedTransactionVersion`; `rewards?`: `boolean`; `transactionDetails?`: `GetBlockTransactionDetailsMode`; }>, `"maxSupportedTransactionVersion"`> & `Readonly`<{ `rewards`: `false`; `transactionDetails`: `"accounts"`; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  rewards: readonly Reward[];
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter Type

slot bigint

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  rewards: readonly Reward[];
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter	Type
`slot`	`bigint`
`config`	`Omit`<`Readonly`<{ `commitment?`: `Omit`<`Commitment`, `"processed"`>; `encoding?`: `GetBlockEncoding`; `maxSupportedTransactionVersion?`: `GetBlockMaxSupportedTransactionVersion`; `rewards?`: `boolean`; `transactionDetails?`: `GetBlockTransactionDetailsMode`; }>, `"maxSupportedTransactionVersion"`> & `Readonly`<{ `rewards?`: `true`; `transactionDetails`: `"accounts"`; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter Type

slot bigint

config Readonly<{ commitment?: Omit<Commitment, "processed">; encoding?: GetBlockEncoding; maxSupportedTransactionVersion?: GetBlockMaxSupportedTransactionVersion; rewards?: boolean; transactionDetails?: GetBlockTransactionDetailsMode; }> & Readonly<{ encoding: "base58"; maxSupportedTransactionVersion: GetBlockMaxSupportedTransactionVersion; rewards: false; transactionDetails?: "full"; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter	Type
`slot`	`bigint`
`config`	`Omit`<`Readonly`<{ `commitment?`: `Omit`<`Commitment`, `"processed"`>; `encoding?`: `GetBlockEncoding`; `maxSupportedTransactionVersion?`: `GetBlockMaxSupportedTransactionVersion`; `rewards?`: `boolean`; `transactionDetails?`: `GetBlockTransactionDetailsMode`; }>, `"maxSupportedTransactionVersion"`> & `Readonly`<{ `encoding`: `"base58"`; `rewards`: `false`; `transactionDetails?`: `"full"`; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  rewards: readonly Reward[];
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter Type

slot bigint

config Readonly<{ commitment?: Omit<Commitment, "processed">; encoding?: GetBlockEncoding; maxSupportedTransactionVersion?: GetBlockMaxSupportedTransactionVersion; rewards?: boolean; transactionDetails?: GetBlockTransactionDetailsMode; }> & Readonly<{ encoding: "base58"; maxSupportedTransactionVersion: GetBlockMaxSupportedTransactionVersion; rewards?: true; transactionDetails?: "full"; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  rewards: readonly Reward[];
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter	Type
`slot`	`bigint`
`config`	`Omit`<`Readonly`<{ `commitment?`: `Omit`<`Commitment`, `"processed"`>; `encoding?`: `GetBlockEncoding`; `maxSupportedTransactionVersion?`: `GetBlockMaxSupportedTransactionVersion`; `rewards?`: `boolean`; `transactionDetails?`: `GetBlockTransactionDetailsMode`; }>, `"maxSupportedTransactionVersion"`> & `Readonly`<{ `encoding`: `"base58"`; `rewards?`: `true`; `transactionDetails?`: `"full"`; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter Type

slot bigint

config Readonly<{ commitment?: Omit<Commitment, "processed">; encoding?: GetBlockEncoding; maxSupportedTransactionVersion?: GetBlockMaxSupportedTransactionVersion; rewards?: boolean; transactionDetails?: GetBlockTransactionDetailsMode; }> & Readonly<{ encoding: "base64"; maxSupportedTransactionVersion: GetBlockMaxSupportedTransactionVersion; rewards: false; transactionDetails?: "full"; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter	Type
`slot`	`bigint`
`config`	`Omit`<`Readonly`<{ `commitment?`: `Omit`<`Commitment`, `"processed"`>; `encoding?`: `GetBlockEncoding`; `maxSupportedTransactionVersion?`: `GetBlockMaxSupportedTransactionVersion`; `rewards?`: `boolean`; `transactionDetails?`: `GetBlockTransactionDetailsMode`; }>, `"maxSupportedTransactionVersion"`> & `Readonly`<{ `encoding`: `"base64"`; `rewards`: `false`; `transactionDetails?`: `"full"`; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  rewards: readonly Reward[];
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter Type

slot bigint

config Readonly<{ commitment?: Omit<Commitment, "processed">; encoding?: GetBlockEncoding; maxSupportedTransactionVersion?: GetBlockMaxSupportedTransactionVersion; rewards?: boolean; transactionDetails?: GetBlockTransactionDetailsMode; }> & Readonly<{ encoding: "base64"; maxSupportedTransactionVersion: GetBlockMaxSupportedTransactionVersion; rewards?: true; transactionDetails?: "full"; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  rewards: readonly Reward[];
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter	Type
`slot`	`bigint`
`config`	`Omit`<`Readonly`<{ `commitment?`: `Omit`<`Commitment`, `"processed"`>; `encoding?`: `GetBlockEncoding`; `maxSupportedTransactionVersion?`: `GetBlockMaxSupportedTransactionVersion`; `rewards?`: `boolean`; `transactionDetails?`: `GetBlockTransactionDetailsMode`; }>, `"maxSupportedTransactionVersion"`> & `Readonly`<{ `encoding`: `"base64"`; `rewards?`: `true`; `transactionDetails?`: `"full"`; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter Type

slot bigint

config Readonly<{ commitment?: Omit<Commitment, "processed">; encoding?: GetBlockEncoding; maxSupportedTransactionVersion?: GetBlockMaxSupportedTransactionVersion; rewards?: boolean; transactionDetails?: GetBlockTransactionDetailsMode; }> & Readonly<{ encoding: "jsonParsed"; maxSupportedTransactionVersion: GetBlockMaxSupportedTransactionVersion; rewards: false; transactionDetails?: "full"; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter Type

slot bigint

config Omit<Readonly<{ commitment?: Omit<Commitment, "processed">; encoding?: GetBlockEncoding; maxSupportedTransactionVersion?: GetBlockMaxSupportedTransactionVersion; rewards?: boolean; transactionDetails?: GetBlockTransactionDetailsMode; }>, "maxSupportedTransactionVersion"> & Readonly<{ encoding: "jsonParsed"; rewards: false; transactionDetails?: "full"; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  rewards: readonly Reward[];
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter Type

slot bigint

config Readonly<{ commitment?: Omit<Commitment, "processed">; encoding?: GetBlockEncoding; maxSupportedTransactionVersion?: GetBlockMaxSupportedTransactionVersion; rewards?: boolean; transactionDetails?: GetBlockTransactionDetailsMode; }> & Readonly<{ encoding: "jsonParsed"; maxSupportedTransactionVersion: GetBlockMaxSupportedTransactionVersion; transactionDetails?: "full"; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  rewards: readonly Reward[];
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter Type

slot bigint

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter Type

slot bigint

config Readonly<{ commitment?: Omit<Commitment, "processed">; encoding?: GetBlockEncoding; maxSupportedTransactionVersion?: GetBlockMaxSupportedTransactionVersion; rewards?: boolean; transactionDetails?: GetBlockTransactionDetailsMode; }> & Readonly<{ encoding?: "json"; maxSupportedTransactionVersion: GetBlockMaxSupportedTransactionVersion; rewards: false; transactionDetails?: "full"; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter	Type
`slot`	`bigint`
`config`	`Omit`<`Readonly`<{ `commitment?`: `Omit`<`Commitment`, `"processed"`>; `encoding?`: `GetBlockEncoding`; `maxSupportedTransactionVersion?`: `GetBlockMaxSupportedTransactionVersion`; `rewards?`: `boolean`; `transactionDetails?`: `GetBlockTransactionDetailsMode`; }>, `"maxSupportedTransactionVersion"`> & `Readonly`<{ `encoding?`: `"json"`; `rewards`: `false`; `transactionDetails?`: `"full"`; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

Call Signature

getBlock(slot, config):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  rewards: readonly Reward[];
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter Type

slot bigint

config Readonly<{ commitment?: Omit<Commitment, "processed">; encoding?: GetBlockEncoding; maxSupportedTransactionVersion?: GetBlockMaxSupportedTransactionVersion; rewards?: boolean; transactionDetails?: GetBlockTransactionDetailsMode; }> & Readonly<{ encoding?: "json"; maxSupportedTransactionVersion: GetBlockMaxSupportedTransactionVersion; transactionDetails?: "full"; }>

getBlock(slot, config?):
  | Readonly<{
  blockhash: Blockhash;
  blockHeight: bigint;
  blockTime: UnixTimestamp;
  parentSlot: Slot;
  previousBlockhash: Blockhash;
}> & Readonly<{
  rewards: readonly Reward[];
}> & Readonly<{
  transactions: readonly TTransaction[];
}>
  | null;

Returns identity and transaction information about a confirmed block in the ledger

Parameters

Parameter	Type
`slot`	`bigint`
`config?`	`Omit`<`Readonly`<{ `commitment?`: `Omit`<`Commitment`, `"processed"`>; `encoding?`: `GetBlockEncoding`; `maxSupportedTransactionVersion?`: `GetBlockMaxSupportedTransactionVersion`; `rewards?`: `boolean`; `transactionDetails?`: `GetBlockTransactionDetailsMode`; }>, `"maxSupportedTransactionVersion"`> & `Readonly`<{ `encoding?`: `"json"`; `transactionDetails?`: `"full"`; }>

Returns

See

https://solana.com/docs/rpc/http/getblock

GetBlockApi

On this page