Solana JavaScript SDK v1.x

https://solana-foundation.github.io/solana-web3.js/
Admin
This project provides a comprehensive API reference, detailing classes, enumerations, functions,...
Tokens:85,546
Snippets:1,239
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install migration skill from repository

Source: https://solana-foundation.github.io/solana-web3.js/index.html

Installs the migration skill directly from the repository URL. The 'Copy' text is part of the displayed block.

```bash
$ npx skills add https://github.com/solana-foundation/solana-web3.js/tree/v3.x/skills/web3js-v1-to-v3-migration
Copy
```

--------------------------------

### Install migration skill from local checkout

Source: https://solana-foundation.github.io/solana-web3.js/index.html

Installs the migration skill from a local checkout of the repository. The 'Copy' text is part of the displayed block.

```bash
$ npx skills add ./skills/web3js-v1-to-v3-migration
Copy
```

--------------------------------

### Install @solana/web3.js@rc with npm, pnpm, bun, or yarn

Source: https://solana-foundation.github.io/solana-web3.js/index.html

Install the latest release candidate of @solana/web3.js v3 using your preferred package manager. The @rc tag always resolves to the latest release candidate.

```bash
$ npm install @solana/web3.js@rc
```

```bash
$ pnpm add @solana/web3.js@rc
```

```bash
$ bun add @solana/web3.js@rc
```

```bash
$ yarn add @solana/web3.js@rc
```

--------------------------------

### Install dependencies with pnpm

Source: https://solana-foundation.github.io/solana-web3.js/index.html

Installs project dependencies using pnpm. Requires Node.js 20.18.0 or newer.

```bash
$ pnpm install
Copy

```

--------------------------------

### Request Airdrop Example

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Requests lamports to a specified address using the requestAirdrop method. Requires a Connection instance and a PublicKey. The example uses the testnet endpoint and confirms the transaction after the airdrop.

```typescript
import { Connection, PublicKey, LAMPORTS_PER_SOL } from "@solana/web3.js";  
  
(async () => {  
  const connection = new Connection("https://api.testnet.solana.com", "confirmed");  
  const myAddress = new PublicKey("2nr1bHFT86W9tGnyvmYW4vcHKsQB3sVQfnddasz4kExM");  
  const signature = await connection.requestAirdrop(myAddress, LAMPORTS_PER_SOL);  
  await connection.confirmTransaction(signature);  
})();
```

--------------------------------

### get

Source: https://solana-foundation.github.io/solana-web3.js/classes/MessageAccountKeys.html

Retrieves a public key by index.

```APIDOC
## get(index)

### Description
Returns the public key at the specified index, or undefined if the index is out of bounds.

### Parameters
- **index** (number) - Required - The index of the public key to retrieve.

### Returns
- **PublicKey | undefined** - The public key at the given index, or undefined if not found.
```

--------------------------------

### Install test validator for integration tests

Source: https://solana-foundation.github.io/solana-web3.js/index.html

Installs a test validator required for integration tests.

```bash
$ pnpm --filter @solana/web3.js run test:live-with-test-validator:setup
Copy

```

--------------------------------

### data: Uint8Array

Source: https://solana-foundation.github.io/solana-web3.js/classes/TransactionInstruction.html

Accessor for getting and setting the instruction data.

```APIDOC
## get data(): Uint8Array

### Description
Gets the data of the transaction instruction.

### Returns
- **Uint8Array** - The instruction data.

## set data(data: Uint8Array): void

### Description
Sets the data of the transaction instruction.

### Parameters
- **data** (Uint8Array) - Required - The new instruction data.

### Returns
- **void** - No return value.

```

--------------------------------

### Run integration tests with test validator

Source: https://solana-foundation.github.io/solana-web3.js/index.html

Starts the test validator and runs all integration tests in live mode.

```bash
$ pnpm --filter @solana/web3.js run test:live-with-test-validator
Copy

```

--------------------------------

### onBlock(filter, callback, config)

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Registers a callback to be invoked whenever a matching block is observed. This subscription is unstable and requires the validator to be started with --rpc-pubsub-enable-block-subscription.

```APIDOC
## onBlock

### Description
Registers a callback to be invoked whenever a matching block is observed. This subscription is unstable and requires the validator to be started with `--rpc-pubsub-enable-block-subscription`.

### Method
onBlock

### Parameters
- **filter** (BlockSubscriptionFilter) - Required - Blocks will only be published if they match this filter
- **callback** (BlockSubscriptionJsonCallback) - Required - Function to invoke whenever a matching block is published
- **config** (BlockSubscriptionJsonConfig) - Required - Subscription configuration

### Returns
number - subscription id
```

--------------------------------

### onBlock(filter, callback, config)

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Registers a callback to be invoked whenever a matching block is observed. This subscription is unstable and requires the validator to be started with --rpc-pubsub-enable-block-subscription.

```APIDOC
## onBlock

### Description
Registers a callback to be invoked whenever a matching block is observed. This subscription is unstable and requires the validator to be started with `--rpc-pubsub-enable-block-subscription`.

### Method
onBlock

### Parameters
- **filter** (BlockSubscriptionFilter) - Required - Blocks will only be published if they match this filter
- **callback** (BlockSubscriptionJsonParsedCallback) - Required - Function to invoke whenever a matching block is published
- **config** (BlockSubscriptionJsonParsedConfig) - Required - Subscription configuration

### Returns
number - subscription id
```

--------------------------------

### onBlock(filter, callback, config)

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Registers a callback to be invoked whenever a matching block is observed. This subscription is unstable and requires the validator to be started with --rpc-pubsub-enable-block-subscription.

```APIDOC
## onBlock

### Description
Registers a callback to be invoked whenever a matching block is observed. This subscription is unstable and requires the validator to be started with `--rpc-pubsub-enable-block-subscription`.

### Method
onBlock

### Parameters
- **filter** (BlockSubscriptionFilter) - Required - Blocks will only be published if they match this filter
- **callback** (BlockSubscriptionBase64Callback) - Required - Function to invoke whenever a matching block is published
- **config** (BlockSubscriptionBase64Config) - Required - Subscription configuration

### Returns
number - subscription id
```

--------------------------------

### onBlock(filter, callback, config)

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Registers a callback to be invoked whenever a matching block is observed. This subscription is unstable and requires the validator to be started with --rpc-pubsub-enable-block-subscription.

```APIDOC
## onBlock

### Description
Registers a callback to be invoked whenever a matching block is observed. This subscription is unstable and requires the validator to be started with `--rpc-pubsub-enable-block-subscription`.

### Method
onBlock

### Parameters
- **filter** (BlockSubscriptionFilter) - Required - Blocks will only be published if they match this filter
- **callback** (BlockSubscriptionBase58Callback) - Required - Function to invoke whenever a matching block is published
- **config** (BlockSubscriptionBase58Config) - Required - Subscription configuration

### Returns
number - subscription id
```

--------------------------------

### onBlock(filter, callback, config)

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Registers a callback to be invoked whenever a matching block is observed. This subscription is unstable and requires the validator to be started with --rpc-pubsub-enable-block-subscription.

```APIDOC
## onBlock

### Description
Registers a callback to be invoked whenever a matching block is observed. This subscription is unstable and requires the validator to be started with `--rpc-pubsub-enable-block-subscription`.

### Method
onBlock

### Parameters
- **filter** (BlockSubscriptionFilter) - Required - Blocks will only be published if they match this filter
- **callback** (BlockSubscriptionSignaturesCallback) - Required - Function to invoke whenever a matching block is published
- **config** (BlockSubscriptionSignaturesConfig) - Required - Subscription configuration

### Returns
number - subscription id
```

--------------------------------

### get rpcEndpoint()

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Gets the RPC endpoint URL.

```APIDOC
## [ACCESSOR] get rpcEndpoint()

### Description
Gets the RPC endpoint URL.

### Method
Accessor

### Endpoint
get rpcEndpoint(): string

### Returns
- **string** - The RPC endpoint URL.

### Request Example
```typescript
const endpoint = connection.rpcEndpoint;
```
```

--------------------------------

### get commitment()

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Gets the default commitment level used for requests.

```APIDOC
## [ACCESSOR] get commitment()

### Description
Gets the default commitment level used for requests.

### Method
Accessor

### Endpoint
get commitment(): Commitment | undefined

### Returns
- **Commitment | undefined** - The default commitment level, or undefined if not set.

### Request Example
```typescript
const commitment = connection.commitment;
```
```

--------------------------------

### createInstructionWithPublicKey

Source: https://solana-foundation.github.io/solana-web3.js/classes/Secp256k1Program.html

Creates a secp256k1 instruction with a public key.

```APIDOC
## createInstructionWithPublicKey

### Description
Creates a secp256k1 instruction with a public key. The public key must be 64 bytes long.

### Method
Static method

### Signature
createInstructionWithPublicKey(params: CreateSecp256k1InstructionWithPublicKeyParams): TransactionInstruction

### Parameters
- **params** (CreateSecp256k1InstructionWithPublicKeyParams) - Required - Parameters for creating the instruction.

### Returns
- **TransactionInstruction** - The created transaction instruction.
```

--------------------------------

### get rpcHttpHeaders()

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Gets the HTTP headers used by this connection for JSON-RPC requests.

```APIDOC
## [ACCESSOR] get rpcHttpHeaders()

### Description
Gets the HTTP headers used by this connection for JSON-RPC requests.

### Method
Accessor

### Endpoint
get rpcHttpHeaders(): HttpHeaders | undefined

### Returns
- **HttpHeaders | undefined** - The HTTP headers, or undefined if not set.

### Request Example
```typescript
const headers = connection.rpcHttpHeaders;
```
```

--------------------------------

### createInstructionWithPublicKey

Source: https://solana-foundation.github.io/solana-web3.js/classes/Ed25519Program.html

Creates an ed25519 instruction using a public key and signature. The public key must be 32 bytes long, and the signature must be 64 bytes long.

```APIDOC
## createInstructionWithPublicKey

### Description
Creates an ed25519 instruction using a public key and signature. The public key must be 32 bytes long, and the signature must be 64 bytes long.

### Method
Static

### Parameters
- **params** (CreateEd25519InstructionWithPublicKeyParams) - Required - Parameters for creating the instruction.

### Returns
TransactionInstruction
```

--------------------------------

### createInstructionWithPrivateKey

Source: https://solana-foundation.github.io/solana-web3.js/classes/Secp256k1Program.html

Creates a secp256k1 instruction with a private key.

```APIDOC
## createInstructionWithPrivateKey

### Description
Creates a secp256k1 instruction with a private key. The private key must be 32 bytes long.

### Method
Static method

### Signature
createInstructionWithPrivateKey(params: CreateSecp256k1InstructionWithPrivateKeyParams): TransactionInstruction

### Parameters
- **params** (CreateSecp256k1InstructionWithPrivateKeyParams) - Required - Parameters for creating the instruction.

### Returns
- **TransactionInstruction** - The created transaction instruction.
```

--------------------------------

### createInstructionWithEthAddress

Source: https://solana-foundation.github.io/solana-web3.js/classes/Secp256k1Program.html

Creates a secp256k1 instruction with an Ethereum address.

```APIDOC
## createInstructionWithEthAddress

### Description
Creates a secp256k1 instruction with an Ethereum address. The address must be a hex string or 20 raw bytes.

### Method
Static method

### Signature
createInstructionWithEthAddress(params: CreateSecp256k1InstructionWithEthAddressParams): TransactionInstruction

### Parameters
- **params** (CreateSecp256k1InstructionWithEthAddressParams) - Required - Parameters for creating the instruction.

### Returns
- **TransactionInstruction** - The created transaction instruction.
```

--------------------------------

### createInstructionWithPrivateKey

Source: https://solana-foundation.github.io/solana-web3.js/classes/Ed25519Program.html

Creates an ed25519 instruction using a private key. The private key must be 64 bytes long.

```APIDOC
## createInstructionWithPrivateKey

### Description
Creates an ed25519 instruction using a private key. The private key must be 64 bytes long.

### Method
Static

### Parameters
- **params** (CreateEd25519InstructionWithPrivateKeyParams) - Required - Parameters for creating the instruction.

### Returns
Promise<TransactionInstruction>
```

--------------------------------

### Error.captureStackTrace example

Source: https://solana-foundation.github.io/solana-web3.js/classes/TransactionExpiredNonceInvalidError.html

Example showing how to use Error.captureStackTrace to create a .stack property on an object, with optional constructorOpt to omit frames above a function.

```javascript
const myObject = {};  
Error.captureStackTrace(myObject);  
myObject.stack;  // Similar to `new Error().stack`
Copy
```

```javascript
function a() {  
  b();  
}  
  
function b() {  
  c();  
}  
  
function c() {  
  // Create an error without stack trace to avoid calculating the stack trace twice.  
  const { stackTraceLimit } = Error;  
  Error.stackTraceLimit = 0;  
  const error = new Error();  
  Error.stackTraceLimit = stackTraceLimit;  
  
  // Capture the stack trace above function b  
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace  
  throw error;  
}  
  
a();
Copy
```

--------------------------------

### LoaderV3Program.deployWithMaxDataLen

Source: https://solana-foundation.github.io/solana-web3.js/classes/LoaderV3Program.html

Creates a transaction instruction to deploy a program with a maximum data length.

```APIDOC
## LoaderV3Program.deployWithMaxDataLen

### Description
Creates a transaction instruction to deploy a program with a maximum data length.

### Method
`deployWithMaxDataLen(params: DeployWithMaxDataLenParams): TransactionInstruction`

### Parameters
- **params** (DeployWithMaxDataLenParams) - Required - Parameters for the deployment.

### Returns
`TransactionInstruction`

```

--------------------------------

### LoaderV3Program.initializeBuffer

Source: https://solana-foundation.github.io/solana-web3.js/classes/LoaderV3Program.html

Creates a transaction instruction to initialize a buffer account.

```APIDOC
## LoaderV3Program.initializeBuffer

### Description
Creates a transaction instruction to initialize a buffer account.

### Method
`initializeBuffer(params: InitializeBufferParams): TransactionInstruction`

### Parameters
- **params** (InitializeBufferParams) - Required - Parameters for initializing the buffer.

### Returns
`TransactionInstruction`

```

--------------------------------

### getStakeMinimumDelegation

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Gets the stake minimum delegation.

```APIDOC
## getStakeMinimumDelegation

### Description
get the stake minimum delegation

### Method
N/A (SDK method)

### Endpoint
N/A (SDK method)

### Parameters
- **config** (GetStakeMinimumDelegationConfig) - Optional - Configuration for the request

### Returns
Promise<Readonly<{ context: Readonly<{ slot: Slot }>; value: Lamports }>>
```

--------------------------------

### nonceInitialize

Source: https://solana-foundation.github.io/solana-web3.js/classes/SystemProgram.html

Generate an instruction to initialize a Nonce account.

```APIDOC
## nonceInitialize

### Description
Generate an instruction to initialize a Nonce account.

### Method
Static method

### Parameters
- **params** (InitializeNonceParams) - Required - Parameters for nonce initialization.

### Returns
TransactionInstruction
```

--------------------------------

### constructor

Source: https://solana-foundation.github.io/solana-web3.js/classes/PublicKey.html

Creates a new PublicKey object from bytes or a base-58 encoded string.

```APIDOC
## constructor

### Description
Creates a new PublicKey object from bytes or a base-58 encoded string.

### Method
constructor

### Parameters
- **value** (PublicKeyInitData) - Required - ed25519 public key as bytes or base-58 encoded string

### Returns
PublicKey
```

--------------------------------

### new VoteInit(nodePubkey, authorizedVoter, authorizedWithdrawer, commission)

Source: https://solana-foundation.github.io/solana-web3.js/classes/VoteInit.html

Creates a new VoteInit instance with the specified vote account parameters.

```APIDOC
## new VoteInit(nodePubkey, authorizedVoter, authorizedWithdrawer, commission)

### Description
Creates a new VoteInit instance representing vote account information.

### Constructor
`new VoteInit(nodePubkey: PublicKey, authorizedVoter: PublicKey, authorizedWithdrawer: PublicKey, commission: number): VoteInit`

### Parameters
- **nodePubkey** (PublicKey) - Required - The public key of the node.
- **authorizedVoter** (PublicKey) - Required - The public key authorized to vote.
- **authorizedWithdrawer** (PublicKey) - Required - The public key authorized to withdraw.
- **commission** (number) - Required - Expected percentage commission value, in the inclusive range [0, 100].

### Returns
- **VoteInit** - The newly created VoteInit instance.
```

--------------------------------

### get version

Source: https://solana-foundation.github.io/solana-web3.js/classes/MessageV1.html

Accessor that returns the message version.

```APIDOC
## get version(): 1

### Description
Returns the version of the message, which is always 1 for v1 messages.

### Returns
- **1** - The version number.
```

--------------------------------

### initialize

Source: https://solana-foundation.github.io/solana-web3.js/classes/StakeProgram.html

Generates an Initialize instruction to add to a Stake Create transaction.

```APIDOC
## initialize(params: InitializeStakeParams): TransactionInstruction

### Description
Generate an Initialize instruction to add to a Stake Create transaction.

### Parameters
- **params** (InitializeStakeParams) - Required - Parameters for initialization.

### Returns
- **TransactionInstruction** - The generated instruction.
```

--------------------------------

### instructions: TransactionInstruction[]

Source: https://solana-foundation.github.io/solana-web3.js/classes/Transaction.html

The instructions to atomically execute.

```APIDOC
## instructions: TransactionInstruction[]

### Description
The instructions to atomically execute.

### Type
TransactionInstruction[] (default: [])
```

--------------------------------

### get signature()

Source: https://solana-foundation.github.io/solana-web3.js/classes/Transaction.html

Accessor that returns the first (payer) transaction signature.

```APIDOC
## get signature(): Uint8Array<ArrayBufferLike> | null

### Description
Returns the first (payer) Transaction signature.

### Returns
- **Uint8Array<ArrayBufferLike> | null** - The payer's signature bytes.
```

--------------------------------

### LoaderV3Program.upgrade

Source: https://solana-foundation.github.io/solana-web3.js/classes/LoaderV3Program.html

Creates a transaction instruction to upgrade a program.

```APIDOC
## LoaderV3Program.upgrade

### Description
Creates a transaction instruction to upgrade a program.

### Method
`upgrade(params: UpgradeParams): TransactionInstruction`

### Parameters
- **params** (UpgradeParams) - Required - Parameters for the upgrade.

### Returns
`TransactionInstruction`

```

--------------------------------

### get length

Source: https://solana-foundation.github.io/solana-web3.js/classes/MessageAccountKeys.html

Accessor that returns the total number of account keys.

```APIDOC
## get length(): number

### Description
Gets the length of the account keys, which is the total number of static and loaded account keys.

### Returns
- **number** - The total number of account keys.
```

--------------------------------

### getEstimatedFee(connection)

Source: https://solana-foundation.github.io/solana-web3.js/classes/Transaction.html

Gets the estimated fee for the transaction using the provided connection.

```APIDOC
## getEstimatedFee(connection: Connection): Promise<GetFeeForMessageApiResponse>

### Description
Get the estimated fee associated with a transaction.

### Parameters
- **connection** (Connection) - Connection to RPC Endpoint.

### Returns
- **Promise<GetFeeForMessageApiResponse>** - The estimated fee for the transaction.
```

--------------------------------

### fromSeed

Source: https://solana-foundation.github.io/solana-web3.js/classes/Keypair.html

Creates a keypair from a 32-byte seed.

```APIDOC
## fromSeed(seed: Uint8Array): Promise<Keypair>

### Description
Create a keypair from a 32-byte seed (private-key bytes).

### Method
fromSeed

### Parameters
- **seed** (Uint8Array) - Required - The 32-byte seed (private-key bytes).

### Returns
Promise<Keypair> - A new Keypair instance.
```

--------------------------------

### get version(): 0

Source: https://solana-foundation.github.io/solana-web3.js/classes/MessageV0.html

Returns the message version, which is always 0 for MessageV0.

```APIDOC
## [ACCESSOR] get version

### Description
Returns the message version, which is always 0 for MessageV0.

### Method
get version

### Returns
0
```

--------------------------------

### getAccountInfoAndContext(publicKey, commitmentOrConfig?)

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Fetches all the account info for the specified public key, return with context.

```APIDOC
## [METHOD] getAccountInfoAndContext(publicKey, commitmentOrConfig?)

### Description
Fetch all the account info for the specified public key, return with context.

### Method
Method

### Endpoint
getAccountInfoAndContext(publicKey: PublicKey, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<RpcResponseAndContext<Readonly<AccountInfo<Uint8Array<ArrayBufferLike>> & { space: bigint }> | null>>

### Parameters
#### Path Parameters
- **publicKey** (PublicKey) - Required - The public key of the account.

#### Query Parameters
- **commitmentOrConfig** (Commitment | GetAccountInfoConfig) - Optional - Commitment level or configuration.

### Returns
- **Promise<RpcResponseAndContext<Readonly<AccountInfo<Uint8Array<ArrayBufferLike>> & { space: bigint }> | null>>** - The account info with context.

### Request Example
```typescript
const accountInfoAndContext = await connection.getAccountInfoAndContext(publicKey);
```
```

--------------------------------

### getSlotLeaders

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Fetches a specified number of slot leaders starting from a given slot.

```APIDOC
## getSlotLeaders

### Description
Fetch `limit` number of slot leaders starting from `startSlot`

### Method
N/A (SDK method)

### Endpoint
N/A (SDK method)

### Parameters
- **startSlot** (number | bigint) - Required - fetch slot leaders starting from this slot
- **limit** (number) - Required - number of slot leaders to return

### Returns
Promise<PublicKey[]>
```

--------------------------------

### Browser script tags for @solana/web3.js@rc from unpkg

Source: https://solana-foundation.github.io/solana-web3.js/index.html

Load @solana/web3.js in a browser without a build system using the unpkg CDN. Use the development (un-minified) or production (minified) bundle. For production, pin browser bundles to an exact published version instead of @rc.

```html
<!-- Development (un-minified) -->  
<script src="https://unpkg.com/@solana/web3.js@rc/lib/index.iife.js"></script>  
  
<!-- Production (minified) -->  
<script src="https://unpkg.com/@solana/web3.js@rc/lib/index.iife.min.js"></script>
```

--------------------------------

### getBlocksWithLimit

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Fetches confirmed blocks starting at the provided slot, limited to the requested length.

```APIDOC
## getBlocksWithLimit

### Description
Fetch confirmed blocks starting at the provided slot, limited to the requested length.

### Method
GET

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```typescript
const blocks = await connection.getBlocksWithLimit(startSlot, limit, commitment);
```

### Response
#### Success Response (200)
- **Promise<GetBlocksWithLimitApiResponse>** - The response contains an array of block slot numbers.

#### Response Example
```json
{
  "blocks": [1, 2, 3]
}
```

```

--------------------------------

### getMinimumBalanceForRentExemption

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Fetches the minimum lamports required to exempt an account of a given data length from rent.

```APIDOC
## getMinimumBalanceForRentExemption

### Description
Fetch the minimum balance needed to exempt an account of `dataLength` size from rent.

### Method
GET

### Endpoint
/getMinimumBalanceForRentExemption

### Parameters
#### Path Parameters
- None

#### Query Parameters
- **dataLength** (number) - Required - The length of data in bytes for the account.
- **commitmentOrConfig** (Commitment | GetMinimumBalanceForRentExemptionConfig) - Optional - Commitment level or configuration object.

#### Request Body
None

### Request Example
```json
{
  "dataLength": 100
}
```

### Response
#### Success Response (200)
- **result** (Lamports) - The minimum lamports required.

#### Response Example
```json
{
  "result": 890880
}
```
```

--------------------------------

### get numAccountKeysFromLookups(): number

Source: https://solana-foundation.github.io/solana-web3.js/classes/MessageV0.html

Returns the number of account keys derived from address table lookups.

```APIDOC
## [ACCESSOR] get numAccountKeysFromLookups

### Description
Returns the number of account keys derived from address table lookups.

### Method
get numAccountKeysFromLookups

### Returns
number
```

--------------------------------

### initializeAccount

Source: https://solana-foundation.github.io/solana-web3.js/classes/VoteProgram.html

Static method to generate an Initialize instruction for a Vote account.

```APIDOC
## initializeAccount(params: InitializeAccountParams): TransactionInstruction

### Description
Generate an Initialize instruction.

### Parameters
- **params** (InitializeAccountParams) - Required - Parameters for initializing the account.

### Returns
- **TransactionInstruction** - The generated instruction.
```

--------------------------------

### constructor

Source: https://solana-foundation.github.io/solana-web3.js/classes/MessageV1.html

Constructor for creating a new MessageV1 instance.

```APIDOC
## new MessageV1(args: MessageV1Args): MessageV1

### Description
Creates a new v1 transaction message instance.

### Parameters
- **args** (MessageV1Args) - Required - The arguments for constructing the message.

### Returns
- **MessageV1** - The new message instance.
```

--------------------------------

### onVote

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Registers a callback to be invoked when a new vote is observed in gossip. This subscription is unstable and requires the validator to be started with --rpc-pubsub-enable-vote-subscription.

```APIDOC
## onVote

### Description
Registers a callback to be invoked when a new vote is observed in gossip. This subscription is unstable and requires the validator to be started with `--rpc-pubsub-enable-vote-subscription`.

### Method
onVote

### Parameters
- **callback** (VoteCallback) - Required - Function to invoke whenever a vote is observed

### Returns
- **number** - subscription id
```

--------------------------------

### onBlock

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Registers a callback to be invoked whenever a matching block is observed. This subscription is unstable and requires the validator to be started with `--rpc-pubsub-enable-block-subscription`.

```APIDOC
## onBlock

### Description
Registers a callback to be invoked whenever a matching block is observed. This subscription is unstable and requires the validator to be started with `--rpc-pubsub-enable-block-subscription`.

### Method
SUBSCRIBE

### Endpoint
Connection.onBlock

### Parameters
#### Query Parameters
- **filter** (BlockSubscriptionFilter) - Required - Blocks will only be published if they match this filter.
- **callback** (BlockSubscriptionCallback | BlockSubscriptionAccountsCallback | BlockSubscriptionNoneCallback | BlockSubscriptionSignaturesCallback) - Required - Function to invoke whenever a matching block is published.
- **config** (undefined | BlockSubscriptionAccountsConfig | BlockSubscriptionNoneConfig | BlockSubscriptionSignaturesConfig) - Optional - Subscription configuration.

### Returns
number - subscription id
```

--------------------------------

### constructor

Source: https://solana-foundation.github.io/solana-web3.js/classes/MessageAccountKeys.html

Constructor for the MessageAccountKeys class.

```APIDOC
## new MessageAccountKeys(staticAccountKeys, accountKeysFromLookups?)

### Description
Creates a new instance of the MessageAccountKeys class, which holds the static account keys and optional loaded addresses for a message.

### Parameters
- **staticAccountKeys** (PublicKey[]) - Required - The static account keys for the message.
- **accountKeysFromLookups** (LoadedAddresses) - Optional - The loaded addresses for the message.

### Returns
- **MessageAccountKeys** - The new MessageAccountKeys instance.
```

--------------------------------

### constructor

Source: https://solana-foundation.github.io/solana-web3.js/classes/Lockup.html

Constructor for creating a new Lockup instance.

```APIDOC
## new Lockup(unixTimestamp: number, epoch: number, custodian: PublicKey): Lockup

### Description
Creates a new Lockup object representing stake account lockup information.

### Parameters
- **unixTimestamp** (number) - Required - Unix timestamp of lockup expiration.
- **epoch** (number) - Required - Epoch of lockup expiration.
- **custodian** (PublicKey) - Required - Lockup custodian authority.

### Returns
- **Lockup** - The newly created Lockup object.
```

--------------------------------

### createWithSeed

Source: https://solana-foundation.github.io/solana-web3.js/classes/PublicKey.html

Derives a public key from another key, a seed, and a program ID.

```APIDOC
## createWithSeed

### Description
Derive a public key from another key, a seed, and a program ID. The program ID will also serve as the owner of the public key, giving it permission to write data to the account.

### Method
createWithSeed (static)

### Signature
createWithSeed(fromPublicKey: PublicKey, seed: string, programId: PublicKey): Promise<PublicKey>

### Parameters
- **fromPublicKey** (PublicKey) - The base public key.
- **seed** (string) - The seed string.
- **programId** (PublicKey) - The program ID.

### Returns
- **Promise<PublicKey>** - A promise that resolves to the derived public key.

### Throws
- `SolanaError` with `SOLANA_ERROR__ADDRESSES__MAX_PDA_SEED_LENGTH_EXCEEDED` from `@solana/errors` if the seed exceeds 32 bytes.
- `SolanaError` with `SOLANA_ERROR__ADDRESSES__PDA_ENDS_WITH_PDA_MARKER` from `@solana/errors` if the program address ends with the PDA marker bytes.
```

--------------------------------

### Run unit tests with pnpm test:unit

Source: https://solana-foundation.github.io/solana-web3.js/index.html

Runs the full suite of unit tests from the repository root.

```bash
$ pnpm test:unit
Copy

```

--------------------------------

### Error.prepareStackTrace(err, stackTraces)

Source: https://solana-foundation.github.io/solana-web3.js/classes/TransactionExpiredBlockheightExceededError.html

Static method that can be overridden to customize the stack trace format.

```APIDOC
## [METHOD] Error.prepareStackTrace(err, stackTraces)

### Description
Static method that can be overridden to customize the stack trace format.

### Parameters
- **err** (Error) - Required - The error object.
- **stackTraces** (CallSite[]) - Required - The stack trace call sites.

### Returns
any
```

--------------------------------

### new TransactionInstruction(opts: TransactionInstructionCtorFields): TransactionInstruction

Source: https://solana-foundation.github.io/solana-web3.js/classes/TransactionInstruction.html

Constructor for creating a new TransactionInstruction instance.

```APIDOC
## new TransactionInstruction(opts: TransactionInstructionCtorFields): TransactionInstruction

### Description
Creates a new TransactionInstruction instance with the provided constructor fields.

### Parameters
- **opts** (TransactionInstructionCtorFields) - Required - The fields to initialize the instruction.

### Returns
- **TransactionInstruction** - The newly created instruction instance.

```

--------------------------------

### decodeNonceInitialize

Source: https://solana-foundation.github.io/solana-web3.js/classes/SystemInstruction.html

Decodes a nonce initialize system instruction and retrieves the instruction params.

```APIDOC
## decodeNonceInitialize

### Description
Decodes a nonce initialize system instruction and retrieves the instruction params.

### Method
Static method

### Parameters
- **instruction** (TransactionInstruction) - Required - The transaction instruction to decode.

### Returns
InitializeNonceParams
```

--------------------------------

### LoaderV3Program.write

Source: https://solana-foundation.github.io/solana-web3.js/classes/LoaderV3Program.html

Creates a transaction instruction to write data to a program or buffer.

```APIDOC
## LoaderV3Program.write

### Description
Creates a transaction instruction to write data to a program or buffer.

### Method
`write(params: WriteParams): TransactionInstruction`

### Parameters
- **params** (WriteParams) - Required - Parameters for the write operation.

### Returns
`TransactionInstruction`

```

--------------------------------

### Properties

Source: https://solana-foundation.github.io/solana-web3.js/classes/VoteInit.html

Properties of the VoteInit class.

```APIDOC
## Properties

### authorizedVoter
- **authorizedVoter**: PublicKey - The public key authorized to vote.

### authorizedWithdrawer
- **authorizedWithdrawer**: PublicKey - The public key authorized to withdraw.

### commission
- **commission**: number - Expected percentage commission value, in the inclusive range [0, 100].

### nodePubkey
- **nodePubkey**: PublicKey - The public key of the node.
```

--------------------------------

### decodeInitialize

Source: https://solana-foundation.github.io/solana-web3.js/classes/StakeInstruction.html

Decodes an initialize stake instruction and retrieves the instruction params.

```APIDOC
## decodeInitialize

### Description
Decode a initialize stake instruction and retrieve the instruction params.

### Method
Static method

### Signature
`decodeInitialize(instruction: TransactionInstruction): InitializeStakeParams`

### Parameters
- **instruction** (TransactionInstruction) - Required - The transaction instruction to decode.

### Returns
- **InitializeStakeParams** - The decoded instruction parameters.
```

--------------------------------

### constructor

Source: https://solana-foundation.github.io/solana-web3.js/classes/VersionedTransaction.html

Creates a new VersionedTransaction instance with the given message and optional signatures.

```APIDOC
## constructor

### Description
Creates a new VersionedTransaction instance.

### Method
constructor

### Parameters
- **message** (VersionedMessage) - Required - The transaction message.
- **signatures** (Uint8Array<ArrayBufferLike>[]) - Optional - The signatures for the transaction.

### Returns
VersionedTransaction
```

--------------------------------

### createAccountWithSeed

Source: https://solana-foundation.github.io/solana-web3.js/classes/SystemProgram.html

Generate a transaction instruction that creates a new account at an address generated with `from`, a seed, and programId.

```APIDOC
## createAccountWithSeed

### Description
Generate a transaction instruction that creates a new account at an address generated with `from`, a seed, and programId.

### Method
Static method

### Parameters
- **params** (CreateAccountWithSeedParams) - Required - Parameters for account creation with seed.

### Returns
TransactionInstruction
```

--------------------------------

### CreateSecp256k1InstructionWithEthAddressParams

Source: https://solana-foundation.github.io/solana-web3.js/types/CreateSecp256k1InstructionWithEthAddressParams.html

Type alias for creating a secp256k1 instruction with an Ethereum address.

```APIDOC
## Type Alias CreateSecp256k1InstructionWithEthAddressParams

### Description
Params for creating an secp256k1 instruction using an Ethereum address.

### Type Definition
```typescript
type CreateSecp256k1InstructionWithEthAddressParams = {
  ethAddress: Uint8Array | number[] | string;
  instructionIndex?: number;
  message: Uint8Array | number[];
  recoveryId: number;
  signature: Uint8Array | number[];
};
```

### Properties

#### ethAddress
- **Type**: `Uint8Array | number[] | string`
- **Required**: Yes
- **Description**: The Ethereum address associated with the secp256k1 key pair.

#### instructionIndex
- **Type**: `number`
- **Required**: No
- **Description**: Optional index of the instruction.

#### message
- **Type**: `Uint8Array | number[]`
- **Required**: Yes
- **Description**: The message that was signed.

#### recoveryId
- **Type**: `number`
- **Required**: Yes
- **Description**: The recovery ID used to recover the public key from the signature.

#### signature
- **Type**: `Uint8Array | number[]`
- **Required**: Yes
- **Description**: The secp256k1 signature.

```

--------------------------------

### constructor

Source: https://solana-foundation.github.io/solana-web3.js/classes/TransactionMessage.html

Creates a new TransactionMessage instance with the provided arguments.

```APIDOC
## constructor

### Description
Creates a new TransactionMessage instance.

### Method
constructor

### Signature
new TransactionMessage(args: TransactionMessageArgs): TransactionMessage

### Parameters
- **args** (TransactionMessageArgs) - Required - The arguments for the transaction message.

### Returns
TransactionMessage
```

--------------------------------

### createAccount

Source: https://solana-foundation.github.io/solana-web3.js/classes/SystemProgram.html

Generate a transaction instruction that creates a new account.

```APIDOC
## createAccount

### Description
Generate a transaction instruction that creates a new account.

### Method
Static method

### Parameters
- **params** (CreateAccountParams) - Required - Parameters for account creation.

### Returns
TransactionInstruction
```

--------------------------------

### new VoteInstruction()

Source: https://solana-foundation.github.io/solana-web3.js/classes/VoteInstruction.html

Creates a new VoteInstruction instance.

```APIDOC
## new VoteInstruction()

### Description
Creates a new VoteInstruction instance.

### Returns
VoteInstruction
```

--------------------------------

### decodeCreateAccount

Source: https://solana-foundation.github.io/solana-web3.js/classes/SystemInstruction.html

Decodes a create account system instruction and retrieves the instruction params.

```APIDOC
## decodeCreateAccount

### Description
Decodes a create account system instruction and retrieves the instruction params.

### Method
Static method

### Parameters
- **instruction** (TransactionInstruction) - Required - The transaction instruction to decode.

### Returns
CreateAccountFields
```

--------------------------------

### new BpfLoader()

Source: https://solana-foundation.github.io/solana-web3.js/classes/BpfLoader.html

Creates a new instance of the BpfLoader class. This constructor is part of the factory class for transactions to interact with a program loader.

```APIDOC
## new BpfLoader()

### Description
Creates a new instance of the BpfLoader class.

### Method
constructor

### Returns
- **BpfLoader** - A new BpfLoader instance.
```

--------------------------------

### CreateSecp256k1InstructionWithPublicKeyParams

Source: https://solana-foundation.github.io/solana-web3.js/types/CreateSecp256k1InstructionWithPublicKeyParams.html

Type alias for parameters used to create a secp256k1 instruction with a public key.

```APIDOC
## Type Alias CreateSecp256k1InstructionWithPublicKeyParams

### Description
Params for creating an secp256k1 instruction using a public key.

### Type Definition
```typescript
type CreateSecp256k1InstructionWithPublicKeyParams = {
  instructionIndex?: number;
  message: Uint8Array | number[];
  publicKey: Uint8Array | number[];
  recoveryId: number;
  signature: Uint8Array | number[];
};
```

### Properties
- **instructionIndex** (`number`) - Optional - The instruction index.
- **message** (`Uint8Array | number[]`) - Required - The message to sign.
- **publicKey** (`Uint8Array | number[]`) - Required - The public key.
- **recoveryId** (`number`) - Required - The recovery ID.
- **signature** (`Uint8Array | number[]`) - Required - The signature.
```

--------------------------------

### constructor

Source: https://solana-foundation.github.io/solana-web3.js/classes/ValidatorInfo.html

Constructs a new ValidatorInfo instance with a validator public key and validator information.

```APIDOC
## constructor

### Description
Construct a valid ValidatorInfo.

### Method
constructor

### Parameters
- **key** (PublicKey) - Required - validator public key
- **info** (Info) - Required - validator information

### Returns
ValidatorInfo
```

--------------------------------

### new Connection(endpoint, commitmentOrConfig?)

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Establishes a JSON RPC connection to the specified endpoint with an optional default commitment level or configuration object.

```APIDOC
## [CONSTRUCTOR] new Connection(endpoint, commitmentOrConfig?)

### Description
Establish a JSON RPC connection to a Solana node.

### Method
Constructor

### Endpoint
new Connection(endpoint: string, commitmentOrConfig?: Commitment | ConnectionConfig)

### Parameters
#### Path Parameters
- **endpoint** (string) - Required - URL to the fullnode JSON RPC endpoint
- **commitmentOrConfig** (Commitment | ConnectionConfig) - Optional - Optional default commitment level or optional ConnectionConfig configuration object

### Returns
- **Connection** - The newly created Connection instance

### Request Example
```typescript
const connection = new Connection('https://api.mainnet-beta.solana.com', 'confirmed');
```
```

--------------------------------

### compileInstructions

Source: https://solana-foundation.github.io/solana-web3.js/classes/MessageAccountKeys.html

Compiles transaction instructions into message-compiled instructions.

```APIDOC
## compileInstructions(instructions)

### Description
Compiles the given transaction instructions into message-compiled instructions.

### Parameters
- **instructions** (Required<TransactionInstructionCtorFields>[]) - Required - The transaction instructions to compile.

### Returns
- **MessageCompiledInstruction[]** - The compiled message instructions.
```

--------------------------------

### static compile(args: CompileV0Args): MessageV0

Source: https://solana-foundation.github.io/solana-web3.js/classes/MessageV0.html

Compiles the given arguments into a MessageV0 instance.

```APIDOC
## [METHOD] compile

### Description
Compiles the given arguments into a MessageV0 instance.

### Method
compile

### Parameters
- **args** (CompileV0Args) - Required - The arguments to compile.

### Returns
MessageV0
```

--------------------------------

### CreateSecp256k1InstructionWithPrivateKeyParams

Source: https://solana-foundation.github.io/solana-web3.js/types/CreateSecp256k1InstructionWithPrivateKeyParams.html

Type alias for parameters used to create a secp256k1 instruction with a private key.

```APIDOC
## Type Alias CreateSecp256k1InstructionWithPrivateKeyParams

### Description
Params for creating an secp256k1 instruction using a private key.

### Type Definition
```typescript
type CreateSecp256k1InstructionWithPrivateKeyParams = {
  instructionIndex?: number;
  message: Uint8Array | number[];
  privateKey: Uint8Array | number[];
};
```

### Properties

#### `Optional` instructionIndex
- **Type**: `number`
- **Description**: Optional instruction index.

#### message
- **Type**: `Uint8Array | number[]`
- **Description**: The message to be signed.

#### privateKey
- **Type**: `Uint8Array | number[]`
- **Description**: The private key used for signing.

```

--------------------------------

### LoaderV3Program.extendProgram

Source: https://solana-foundation.github.io/solana-web3.js/classes/LoaderV3Program.html

Creates a transaction instruction to extend a program's data.

```APIDOC
## LoaderV3Program.extendProgram

### Description
Creates a transaction instruction to extend a program's data.

### Method
`extendProgram(params: ExtendProgramParams): TransactionInstruction`

### Parameters
- **params** (ExtendProgramParams) - Required - Parameters for extending the program.

### Returns
`TransactionInstruction`

```

--------------------------------

### getBalanceAndContext

Source: https://solana-foundation.github.io/solana-web3.js/classes/Connection.html

Fetches the balance for the specified public key and returns it along with the context (slot).

```APIDOC
## getBalanceAndContext

### Description
Fetch the balance for the specified public key, return with context.

### Method
N/A (SDK method)

### Endpoint
N/A (SDK method)

### Parameters
- **publicKey** (PublicKey) - Required - The public key to fetch the balance for.
- **commitmentOrConfig** (Commitment | GetBalanceConfig) - Optional - A commitment level or configuration object.

### Returns
Promise<Readonly<{ context: Readonly<{ slot: Slot }>; value: Lamports }>>
```

--------------------------------

### load(connection, payer, program, elf, loaderProgramId): Promise<boolean>

Source: https://solana-foundation.github.io/solana-web3.js/classes/BpfLoader.html

Static method that loads a SBF program onto the blockchain. It takes a connection, payer account, program account, ELF data, and loader program ID, and returns a promise that resolves to a boolean indicating success.

```APIDOC
## load(connection, payer, program, elf, loaderProgramId): Promise<boolean>

### Description
Static method that loads a SBF program onto the blockchain. It takes a connection, payer account, program account, ELF data, and loader program ID, and returns a promise that resolves to a boolean indicating success.

### Method
Static load

### Parameters
- **connection** (Connection) - Required - The connection to use.
- **payer** (TransactionPartialSigner) - Required - Account that will pay program loading fees.
- **program** (TransactionPartialSigner) - Required - Account to load the program into.
- **elf** (number[] | Uint8Array<ArrayBufferLike>) - Required - The entire ELF containing the SBF program.
- **loaderProgramId** (PublicKey) - Required - The program id of the BPF loader to use.

### Returns
- **Promise<boolean>** - true if program was loaded successfully, false if program was already loaded.
```
Tokens:
Raw