Home Reference Source

Function

Static Public Summary
public

authorized(property: string): *

Layout for an Authorized object
public

clusterApiUrl(cluster: *, tls: *): *

Retrieves the RPC API URL for the specified cluster
public

decodeData(type: *, buffer: *): *

Decode instruction data buffer using an InstructionType
public
public

encodeData(type: *, fields: *): *

Populate a buffer of instruction data using an InstructionType
public

encodeLength(bytes: Array<number>, len: number)

public

getAlloc(type: Object, fields: Object): number

public

lockup(property: string): *

Layout for a Lockup object
public

promiseTimeout(promise: Promise<T>, timeoutMs: number): Promise<T|nullliteral>

public

publicKey(property: string): *

Layout for a public key
public

rustString(property: string): *

Layout for a Rust String type
public

async sendAndConfirmRawTransaction(connection: Connection, rawTransaction: Buffer, options: ConfirmOptions): Promise<TransactionSignature>

Send and confirm a raw transaction
public

Sign, send and confirm a transaction.
public

sleep(ms: number): Promise<void>

public

toBuffer(arr: *): *

public

uint64(property: string): *

Layout for a 64bit unsigned value

Static Public

public authorized(property: string): * source 

import {authorized} from '@solana/web3'

Layout for an Authorized object

Params:

NameTypeAttributeDescription
property string
  • optional
  • default: authorized

Return:

*

public clusterApiUrl(cluster: *, tls: *): * source 

import {clusterApiUrl} from '@solana/web3'

Retrieves the RPC API URL for the specified cluster

Params:

NameTypeAttributeDescription
cluster *
tls *

Return:

*

public decodeData(type: *, buffer: *): * source 

import {decodeData} from '@solana/web3'

Decode instruction data buffer using an InstructionType

Params:

NameTypeAttributeDescription
type *
buffer *

Return:

*

public decodeLength(bytes: Array<number>): number source 

import {decodeLength} from '@solana/web3'

Params:

NameTypeAttributeDescription
bytes Array<number>

Return:

number

public encodeData(type: *, fields: *): * source 

import {encodeData} from '@solana/web3'

Populate a buffer of instruction data using an InstructionType

Params:

NameTypeAttributeDescription
type *
fields *

Return:

*

public encodeLength(bytes: Array<number>, len: number) source 

import {encodeLength} from '@solana/web3'

Params:

NameTypeAttributeDescription
bytes Array<number>
len number

public getAlloc(type: Object, fields: Object): number source 

import {getAlloc} from '@solana/web3'

Params:

NameTypeAttributeDescription
type Object
fields Object

Return:

number

public lockup(property: string): * source 

import {lockup} from '@solana/web3'

Layout for a Lockup object

Params:

NameTypeAttributeDescription
property string
  • optional
  • default: lockup

Return:

*

public promiseTimeout(promise: Promise<T>, timeoutMs: number): Promise<T|nullliteral> source 

import {promiseTimeout} from '@solana/web3'

Params:

NameTypeAttributeDescription
promise Promise<T>
timeoutMs number

Return:

Promise<T|nullliteral>

public publicKey(property: string): * source 

import {publicKey} from '@solana/web3'

Layout for a public key

Params:

NameTypeAttributeDescription
property string
  • optional
  • default: publicKey

Return:

*

public rustString(property: string): * source 

import {rustString} from '@solana/web3'

Layout for a Rust String type

Params:

NameTypeAttributeDescription
property string
  • optional
  • default: string

Return:

*

public async sendAndConfirmRawTransaction(connection: Connection, rawTransaction: Buffer, options: ConfirmOptions): Promise<TransactionSignature> source 

import {sendAndConfirmRawTransaction} from '@solana/web3'

Send and confirm a raw transaction

If commitment option is not specified, defaults to 'max' commitment.

Params:

NameTypeAttributeDescription
connection Connection
rawTransaction Buffer
options ConfirmOptions
  • optional

Return:

Promise<TransactionSignature>

public async sendAndConfirmTransaction(connection: Connection, transaction: Transaction, signers: Array<Account>, options: ConfirmOptions): Promise<TransactionSignature> source 

import {sendAndConfirmTransaction} from '@solana/web3'

Sign, send and confirm a transaction.

If commitment option is not specified, defaults to 'max' commitment.

Params:

NameTypeAttributeDescription
connection Connection
transaction Transaction
signers Array<Account>
options ConfirmOptions
  • optional

Return:

Promise<TransactionSignature>

public sleep(ms: number): Promise<void> source 

import {sleep} from '@solana/web3'

Params:

NameTypeAttributeDescription
ms number

Return:

Promise<void>

public toBuffer(arr: *): * source 

import {toBuffer} from '@solana/web3'

Params:

NameTypeAttributeDescription
arr *

Return:

*

public uint64(property: string): * source 

import {uint64} from '@solana/web3'

Layout for a 64bit unsigned value

Params:

NameTypeAttributeDescription
property string
  • optional
  • default: uint64

Return:

*