Class CargoProgram

Hierarchy

ListenProgram<CargoAccounts, CargoIDL>
- CargoProgram

Index

Constructors

constructor

new CargoProgram(program: CargoIDLProgram): CargoProgram
Parameters
- program: CargoIDLProgram
Returns CargoProgram

Overrides ListenProgram<CargoAccounts, CargoIDL>.constructor

Properties

`Protected` accountClosedListener

accountClosedListener: null | ((update: AccountClosedUpdate) => void)

`Protected` `Readonly` accountDiscriminants

accountDiscriminants: {
    cargoPod: Readonly<Buffer>;
    cargoStatsDefinition: Readonly<Buffer>;
    cargoType: Readonly<Buffer>;
}

Type declaration

cargoPod: Readonly<Buffer>
cargoStatsDefinition: Readonly<Buffer>
cargoType: Readonly<Buffer>

`Protected` parsers

parsers: {
    cargoPod: (new (...args: never[]) => CargoPod & Account) & AccountStatic<CargoPod, CargoIDL>;
    cargoStatsDefinition: (new (...args: never[]) => CargoStatsDefinition & Account) & AccountStatic<CargoStatsDefinition, CargoIDL>;
    cargoType: (new (...args: never[]) => CargoType & Account) & AccountStatic<CargoType, CargoIDL>;
}

Type declaration

cargoPod: (new (...args: never[]) => CargoPod & Account) & AccountStatic<CargoPod, CargoIDL>
cargoStatsDefinition: (new (...args: never[]) => CargoStatsDefinition & Account) & AccountStatic<CargoStatsDefinition, CargoIDL>
cargoType: (new (...args: never[]) => CargoType & Account) & AccountStatic<CargoType, CargoIDL>

`Protected` program

program: ProgramMethods<CargoIDL>

Accessors

programId

get programId(): PublicKey
Returns PublicKey

Inherited from ListenProgram.programId

Methods

accountDiscriminant

accountDiscriminant(accountId: keyof CargoAccounts): Buffer
Parameters
- accountId: keyof CargoAccounts
Returns Buffer

Inherited from ListenProgram.accountDiscriminant

discriminantToAccountId

discriminantToAccountId(data: Buffer): null | {
discriminantLength: number;
key: "cargoPod" | "cargoType" | "cargoStatsDefinition";
}
Parameters
- data: Buffer
Returns null | {
discriminantLength: number;
key: "cargoPod" | "cargoType" | "cargoStatsDefinition";
}

Inherited from ListenProgram.discriminantToAccountId

discriminantToAccountIdNoSubarray

discriminantToAccountIdNoSubarray(discriminant: Buffer): null | {
discriminantLength: number;
key: "cargoPod" | "cargoType" | "cargoStatsDefinition";
}
Parameters
- discriminant: Buffer
Returns null | {
discriminantLength: number;
key: "cargoPod" | "cargoType" | "cargoStatsDefinition";
}

Inherited from ListenProgram.discriminantToAccountIdNoSubarray

provideAccountClosedEvent

provideAccountClosedEvent(key: PublicKey, oldOwner: PublicKey, newOwner: PublicKey, slot: number, confirmationStatus: TransactionConfirmationStatus | "recent", writeVersion: number, accountInfo: AccountInfo<Buffer>): void
Parameters
- key: PublicKey
- oldOwner: PublicKey
- newOwner: PublicKey
- slot: number
- confirmationStatus: TransactionConfirmationStatus | "recent"
- writeVersion: number
- accountInfo: AccountInfo<Buffer>
Returns void

Inherited from ListenProgram.provideAccountClosedEvent

provideAccountEvent

provideAccountEvent(account: KeyedAccountInfo, slot: number, confirmationStatus: TransactionConfirmationStatus | "recent", isStartup: boolean, writeVersion: number, unknownAccountHandler?: ((key: PublicKey) => void)): void
Parameters
- account: KeyedAccountInfo
- slot: number
- confirmationStatus: TransactionConfirmationStatus | "recent"
- isStartup: boolean
- writeVersion: number
- Optional unknownAccountHandler: ((key: PublicKey) => void)
  - - (key: PublicKey): void
    - Parameters
      
      key: PublicKey
      
      Returns void
Returns void

Inherited from ListenProgram.provideAccountEvent

provideDecodedAccountEvent

provideDecodedAccountEvent<AccountId>(accountId: AccountId, account: CargoAccounts[AccountId], slot: number, confirmationStatus: TransactionConfirmationStatus | "recent", isStartup: boolean, accountInfo: AccountInfo<Buffer>, writeVersion: number): void
Type Parameters
- AccountId extends keyof CargoAccounts
Parameters
- accountId: AccountId
- account: CargoAccounts[AccountId]
- slot: number
- confirmationStatus: TransactionConfirmationStatus | "recent"
- isStartup: boolean
- accountInfo: AccountInfo<Buffer>
- writeVersion: number
Returns void

Inherited from ListenProgram.provideDecodedAccountEvent

setAccountClosedListener

setAccountClosedListener(listener: ((update: AccountClosedUpdate) => null | void)): void
Parameters
- listener: ((update: AccountClosedUpdate) => null | void)
  - - (update: AccountClosedUpdate): null | void
    - Parameters
      
      update: AccountClosedUpdate
      
      Returns null | void
Returns void

Inherited from ListenProgram.setAccountClosedListener

setAccountListener

setAccountListener<AccountId>(accountId: AccountId, accountType: (new (...args: never[]) => CargoAccounts[AccountId]), listener: null | AccountUpdateHandler<CargoAccounts[AccountId]>): void
Type Parameters
- AccountId extends keyof CargoAccounts
Parameters
- accountId: AccountId
- accountType: (new (...args: never[]) => CargoAccounts[AccountId])
  - - new (...args: never[]): CargoAccounts[AccountId]
    - Parameters
      
      Rest ...args: never[]
      
      Returns CargoAccounts[AccountId]
- listener: null | AccountUpdateHandler<CargoAccounts[AccountId]>
Returns void

Inherited from ListenProgram.setAccountListener

`Static` buildProgram

buildProgram(programId: PublicKey, provider?: default, coder?: Coder<string, string>): CargoIDLProgram
Parameters
- programId: PublicKey
- Optional provider: default
- Optional coder: Coder<string, string>
Returns CargoIDLProgram

Class CargoProgram

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

program: CargoIDLProgram

Returns CargoProgram

Properties

Protected accountClosedListener

Protected Readonly accountDiscriminants

Type declaration

cargoPod: Readonly<Buffer>

cargoStatsDefinition: Readonly<Buffer>

cargoType: Readonly<Buffer>

Protected parsers

Type declaration

cargoPod: (new (...args: never[]) => CargoPod & Account) & AccountStatic<CargoPod, CargoIDL>

cargoStatsDefinition: (new (...args: never[]) => CargoStatsDefinition & Account) & AccountStatic<CargoStatsDefinition, CargoIDL>

cargoType: (new (...args: never[]) => CargoType & Account) & AccountStatic<CargoType, CargoIDL>

Protected program

Accessors

programId

Returns PublicKey

Methods

accountDiscriminant

Parameters

accountId: keyof CargoAccounts

Returns Buffer

discriminantToAccountId

Parameters

data: Buffer

Returns null | { discriminantLength: number; key: "cargoPod" | "cargoType" | "cargoStatsDefinition"; }

discriminantToAccountIdNoSubarray

Parameters

discriminant: Buffer

Returns null | { discriminantLength: number; key: "cargoPod" | "cargoType" | "cargoStatsDefinition"; }

provideAccountClosedEvent

Parameters

key: PublicKey

oldOwner: PublicKey

newOwner: PublicKey

slot: number

confirmationStatus: TransactionConfirmationStatus | "recent"

writeVersion: number

accountInfo: AccountInfo<Buffer>

Returns void

provideAccountEvent

Parameters

account: KeyedAccountInfo

slot: number

confirmationStatus: TransactionConfirmationStatus | "recent"

isStartup: boolean

writeVersion: number

Optional unknownAccountHandler: ((key: PublicKey) => void)

Parameters

key: PublicKey

Returns void

Returns void

provideDecodedAccountEvent

Type Parameters

AccountId extends keyof CargoAccounts

Parameters

accountId: AccountId

account: CargoAccounts[AccountId]

slot: number

confirmationStatus: TransactionConfirmationStatus | "recent"

isStartup: boolean

accountInfo: AccountInfo<Buffer>

writeVersion: number

Returns void

setAccountClosedListener

Parameters

listener: ((update: AccountClosedUpdate) => null | void)

Parameters

update: AccountClosedUpdate

`Protected` accountClosedListener

`Protected` `Readonly` accountDiscriminants

`Protected` parsers

`Protected` program

Returns null | {
discriminantLength: number;
key: "cargoPod" | "cargoType" | "cargoStatsDefinition";
}

Returns null | {
discriminantLength: number;
key: "cargoPod" | "cargoType" | "cargoStatsDefinition";
}

`Optional` unknownAccountHandler: ((key: PublicKey) => void)

`Rest` ...args: never[]

`Static` buildProgram

`Optional` provider: default

`Optional` coder: Coder<string, string>