Class TokenFaucet

Hierarchy

TokenFaucet

Constructors

constructor

new TokenFaucet(connection: Connection, wallet: IWallet, programId: PublicKey, mint: PublicKey, opts?: ConfirmOptions, context?: BankrunContextWrapper): TokenFaucet
Parameters
- connection: Connection
- wallet: IWallet
- programId: PublicKey
- mint: PublicKey
- Optional opts: ConfirmOptions
- Optional context: BankrunContextWrapper
Returns TokenFaucet
- Defined in sdk/src/tokenFaucet.ts:33

Properties

connection

connection: Connection

`Optional` context

context?: BankrunContextWrapper

mint

mint: PublicKey

`Optional` opts

opts?: ConfirmOptions

program

program: Program<Idl>

provider

provider: AnchorProvider

wallet

wallet: IWallet

Methods

createAssociatedTokenAccountAndMintTo

createAssociatedTokenAccountAndMintTo(userPublicKey: PublicKey, amount: BN): Promise<[PublicKey, string]>
Parameters
- userPublicKey: PublicKey
- amount: BN
Returns Promise<[PublicKey, string]>
- Defined in sdk/src/tokenFaucet.ts:163

createAssociatedTokenAccountAndMintToInstructions

createAssociatedTokenAccountAndMintToInstructions(userPublicKey: PublicKey, amount: BN): Promise<[PublicKey, TransactionInstruction, TransactionInstruction]>
Parameters
- userPublicKey: PublicKey
- amount: BN
Returns Promise<[PublicKey, TransactionInstruction, TransactionInstruction]>
- Defined in sdk/src/tokenFaucet.ts:203

fetchState

fetchState(): Promise<any>
Returns Promise<any>
- Defined in sdk/src/tokenFaucet.ts:103

getAssosciatedMockUSDMintAddress

getAssosciatedMockUSDMintAddress(props: {
userPubKey: PublicKey;
}): Promise<PublicKey>
Parameters
- props: {
  userPubKey: PublicKey;
  }
  - userPubKey: PublicKey
Returns Promise<PublicKey>
- Defined in sdk/src/tokenFaucet.ts:225

getFaucetConfigPublicKey

getFaucetConfigPublicKey(): Promise<PublicKey>
Returns Promise<PublicKey>
- Defined in sdk/src/tokenFaucet.ts:81

getFaucetConfigPublicKeyAndNonce

getFaucetConfigPublicKeyAndNonce(): Promise<[PublicKey, number]>
Returns Promise<[PublicKey, number]>
- Defined in sdk/src/tokenFaucet.ts:57

getMintAuthority

getMintAuthority(): Promise<PublicKey>
Returns Promise<PublicKey>
- Defined in sdk/src/tokenFaucet.ts:69

getTokenAccountInfo

getTokenAccountInfo(props: {
userPubKey: PublicKey;
}): Promise<Account>
Parameters
- props: {
  userPubKey: PublicKey;
  }
  - userPubKey: PublicKey
Returns Promise<Account>
- Defined in sdk/src/tokenFaucet.ts:233

initialize

initialize(): Promise<string>
Returns Promise<string>
- Defined in sdk/src/tokenFaucet.ts:85

mintToUser

mintToUser(userTokenAccount: PublicKey, amount: BN): Promise<string>
Parameters
- userTokenAccount: PublicKey
- amount: BN
Returns Promise<string>
- Defined in sdk/src/tokenFaucet.ts:121

`Private` mintToUserIx

mintToUserIx(userTokenAccount: PublicKey, amount: BN): Promise<TransactionInstruction>
Parameters
- userTokenAccount: PublicKey
- amount: BN
Returns Promise<TransactionInstruction>
- Defined in sdk/src/tokenFaucet.ts:109

subscribeToTokenAccount

subscribeToTokenAccount(props: {
callback: ((accountInfo: Account) => void);
userPubKey: PublicKey;
}): Promise<boolean>
Parameters
- props: {
  callback: ((accountInfo: Account) => void);
  userPubKey: PublicKey;
  }
  - callback: ((accountInfo: Account) => void)
    - (accountInfo: Account): void
      
      Parameters
      
      accountInfo: Account
      
      Returns void
  - userPubKey: PublicKey
Returns Promise<boolean>
- Defined in sdk/src/tokenFaucet.ts:243

transferMintAuthority

transferMintAuthority(): Promise<string>
Returns Promise<string>
- Defined in sdk/src/tokenFaucet.ts:136

Class TokenFaucet

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

connection: Connection

wallet: IWallet

programId: PublicKey

mint: PublicKey

Optional opts: ConfirmOptions

Optional context: BankrunContextWrapper

Returns TokenFaucet

Properties

connection

Optional context

mint

Optional opts

program

provider

wallet

Methods

createAssociatedTokenAccountAndMintTo

Parameters

userPublicKey: PublicKey

amount: BN

Returns Promise<[PublicKey, string]>

createAssociatedTokenAccountAndMintToInstructions

Parameters

userPublicKey: PublicKey

amount: BN

Returns Promise<[PublicKey, TransactionInstruction, TransactionInstruction]>

fetchState

Returns Promise<any>

getAssosciatedMockUSDMintAddress

Parameters

props: { userPubKey: PublicKey; }

userPubKey: PublicKey

Returns Promise<PublicKey>

getFaucetConfigPublicKey

Returns Promise<PublicKey>

getFaucetConfigPublicKeyAndNonce

Returns Promise<[PublicKey, number]>

getMintAuthority

Returns Promise<PublicKey>

getTokenAccountInfo

Parameters

props: { userPubKey: PublicKey; }

userPubKey: PublicKey

Returns Promise<Account>

initialize

Returns Promise<string>

mintToUser

Parameters

userTokenAccount: PublicKey

amount: BN

Returns Promise<string>

Private mintToUserIx

Parameters

userTokenAccount: PublicKey

amount: BN

Returns Promise<TransactionInstruction>

subscribeToTokenAccount

Parameters

props: { callback: ((accountInfo: Account) => void); userPubKey: PublicKey; }

callback: ((accountInfo: Account) => void)

Parameters

accountInfo: Account

Returns void

userPubKey: PublicKey

Returns Promise<boolean>

transferMintAuthority

Returns Promise<string>

Settings

Member Visibility

Theme

`Optional` opts: ConfirmOptions

`Optional` context: BankrunContextWrapper

`Optional` context

`Optional` opts

props: {
userPubKey: PublicKey;
}

props: {
userPubKey: PublicKey;
}

`Private` mintToUserIx

props: {
callback: ((accountInfo: Account) => void);
userPubKey: PublicKey;
}