Class ProgramClient

Hierarchy

ProgramClient

Index

Methods

getAuctionHouse getCandyMachine getCandyGuard getGateway getTokenMetadata register all allForCluster allForCurrentCluster get getSystem getToken getAssociatedToken

Properties

programs metaplex

Constructors

Methods

getAuctionHouse

getAuctionHouse(programs?: Program[]): Program
Parameters
- Optional programs: Program[]
Returns Program
- Defined in packages/js/src/plugins/auctionHouseModule/plugin.ts:166

getCandyMachine

getCandyMachine(programs?: Program[]): Program
Parameters
- Optional programs: Program[]
Returns Program
- Defined in packages/js/src/plugins/candyMachineModule/plugin.ts:183

getCandyGuard

getCandyGuard<T>(programs?: Program[]): T
Type Parameters
- T extends CandyGuardProgram
Parameters
- Optional programs: Program[]
Returns T
- Defined in packages/js/src/plugins/candyMachineModule/plugin.ts:184

getGateway

getGateway(programs?: Program[]): Program
Parameters
- Optional programs: Program[]
Returns Program
- Defined in packages/js/src/plugins/candyMachineModule/plugin.ts:185

getTokenMetadata

getTokenMetadata(programs?: Program[]): Program
Parameters
- Optional programs: Program[]
Returns Program
- Defined in packages/js/src/plugins/nftModule/plugin.ts:191

register

register(program: Program): void
Parameters
- program: Program
Returns void
- Defined in packages/js/src/plugins/programModule/ProgramClient.ts:13

all

all(overrides?: Program[]): Program[]
Parameters
- overrides: Program[] = []
Returns Program[]
- Defined in packages/js/src/plugins/programModule/ProgramClient.ts:17

allForCluster

allForCluster(cluster: Cluster, overrides?: Program[]): Program[]
Parameters
- cluster: Cluster
- overrides: Program[] = []
Returns Program[]
- Defined in packages/js/src/plugins/programModule/ProgramClient.ts:21

allForCurrentCluster

allForCurrentCluster(overrides?: Program[]): Program[]
Parameters
- overrides: Program[] = []
Returns Program[]
- Defined in packages/js/src/plugins/programModule/ProgramClient.ts:27

get

get<T>(nameOrAddress: string | PublicKey, overrides?: Program[]): T
Type Parameters
- T extends Program = Program
Parameters
- nameOrAddress: string | PublicKey
- overrides: Program[] = []
Returns T
- Defined in packages/js/src/plugins/programModule/ProgramClient.ts:31

getSystem

getSystem(programs?: Program[]): Program
Parameters
- Optional programs: Program[]
Returns Program
- Defined in packages/js/src/plugins/systemModule/plugin.ts:51

getToken

getToken(programs?: Program[]): Program
Parameters
- Optional programs: Program[]
Returns Program
- Defined in packages/js/src/plugins/tokenModule/plugin.ts:106

getAssociatedToken

getAssociatedToken(programs?: Program[]): Program
Parameters
- Optional programs: Program[]
Returns Program
- Defined in packages/js/src/plugins/tokenModule/plugin.ts:107

Properties

`Protected` programs

programs: Program[] = []

`Protected` `Readonly` metaplex

metaplex: Metaplex

Constructors

constructor

new ProgramClient(metaplex: Metaplex): ProgramClient
Parameters
- metaplex: Metaplex
Returns ProgramClient
- Defined in packages/js/src/plugins/programModule/ProgramClient.ts:11

Generated using TypeDoc