Class RaffleClient

See

specification

Hierarchy

BaseClient
- RaffleClient

Implements

IRaffleClient

Constructors

constructor

new RaffleClient(baseConfig: BaseClientConfig): RaffleClient
Parameters
- baseConfig: BaseClientConfig
Returns RaffleClient
Inherited from BaseClient.constructor
- Defined in core/ao/BaseClient.ts:38

Properties

`Protected` `Readonly`baseConfig

baseConfig: BaseClientConfig

Methods

`Protected`_dryrun

_dryrun(
    data?: any,
    tags?: Tags,
    anchor?: string,
    id?: string,
    owner?: string,
): Promise<DryRunResult>
Parameters
- data: any = ''
- tags: Tags = []
- Optionalanchor: string
- Optionalid: string
- Optionalowner: string
Returns Promise<DryRunResult>
Inherited from BaseClient._dryrun
- Defined in core/ao/BaseClient.ts:101

`Protected`dryrun

dryrun(
    data?: any,
    tags?: Tags,
    anchor?: string,
    id?: string,
    owner?: string,
): Promise<DryRunResult>
Protected
Parameters
- data: any = ''
- tags: Tags = []
- Optionalanchor: string
- Optionalid: string
- Optionalowner: string
Returns Promise<DryRunResult>
Inherited from BaseClient.dryrun
- Defined in core/ao/BaseClient.ts:92

getCallingWalletAddress

getCallingWalletAddress(): Promise<string>
Gets the wallet address associated with the client.

Returns Promise<string>
Promise resolving to the wallet address string

Throws
Error if client is in read-only mode
Inherited from BaseClient.getCallingWalletAddress
- Defined in core/ao/BaseClient.ts:139

getProcessId

getProcessId(): string
Returns string
Boolean indicating whether or not the client is set to run dryruns as messages. (non default behavior)
Inherited from BaseClient.getProcessId
- Defined in core/ao/BaseClient.ts:135

getProcessInfo

getProcessInfo(): Promise<Partial<FullArweaveTransaction>>
Retrieves the transaction that created this process. This transaction contains the initial state and configuration of the process in its tags.

Returns Promise<Partial<FullArweaveTransaction>>
Promise resolving to the transaction data containing process creation details

Throws
ArweaveGraphQLError if there is an error retrieving the transaction
Inherited from BaseClient.getProcessInfo
- Defined in core/ao/BaseClient.ts:154

getWallet

getWallet(): any
Gets the wallet this client uses to sign messages

Returns any
the wallet used for message signing
Inherited from BaseClient.getWallet
- Defined in core/ao/BaseClient.ts:158

isReadOnly

isReadOnly(): boolean
A Readonly Client can only perform dry run and result operations, however does not require a wallet to be used. If a wallet is specified on instantiation the client will additionally be able to use write operations (messages).

Returns boolean
Boolean indicating whether or not the client is for read operations only.
Inherited from BaseClient.isReadOnly
- Defined in core/ao/BaseClient.ts:150

isRunningDryRunsAsMessages

isRunningDryRunsAsMessages(): boolean
Returns boolean
Boolean indicating whether or not the client is set to run dryruns as messages. (non default behavior)
Inherited from BaseClient.isRunningDryRunsAsMessages
- Defined in core/ao/BaseClient.ts:146

`Protected`message

message(data?: string, tags?: Tags, anchor?: string): Promise<string>
Protected
Parameters
- data: string = ''
- tags: Tags = []
- Optionalanchor: string
Returns Promise<string>
Inherited from BaseClient.message
- Defined in core/ao/BaseClient.ts:50

messageResult

messageResult(
    data?: string,
    tags?: Tags,
    anchor?: string,
): Promise<MessageResult>
Parameters
- data: string = ''
- tags: Tags = []
- Optionalanchor: string
Returns Promise<MessageResult>
Inherited from BaseClient.messageResult
- Defined in core/ao/BaseClient.ts:168

pullRaffle

pullRaffle(): Promise<boolean>
Performs a raffle pull to select a winner.

Returns Promise<boolean>
Promise resolving to true if successful
Implementation of IRaffleClient.pullRaffle
- Defined in clients/miscellaneous/raffle/RaffleClient.ts:55

`Protected`result

result(messageId: string): Promise<MessageResult>
Protected
Parameters
- messageId: string
Returns Promise<MessageResult>
Inherited from BaseClient.result
- Defined in core/ao/BaseClient.ts:82

`Protected`results

results(
    from?: string,
    to?: string,
    limit?: number,
    sort?: SortOrder,
): Promise<ResultsResponse>
Protected
Parameters
- Optionalfrom: string
- Optionalto: string
- limit: number = 25
- sort: SortOrder = SortOrder.ASCENDING
Returns Promise<ResultsResponse>
Inherited from BaseClient.results
- Defined in core/ao/BaseClient.ts:66

setDryRunAsMessage

setDryRunAsMessage(enabled: boolean): void
Controls whether dryrun executes as a message or simulation.
Parameters
- enabled: boolean
  When true, dryrun will execute as a real message. When false (default), executes as a simulation.
Returns void
Inherited from BaseClient.setDryRunAsMessage
- Defined in core/ao/BaseClient.ts:119

setRaffleEntrants

setRaffleEntrants(entrants: string[]): Promise<boolean>
Sets the list of entrants for the raffle.
Parameters
- entrants: string[]
  Array of entrant names
Returns Promise<boolean>
Promise resolving to true if successful
Implementation of IRaffleClient.setRaffleEntrants
- Defined in clients/miscellaneous/raffle/RaffleClient.ts:41

setWallet

setWallet(wallet: any): void
Sets the wallet being used for this client. If the client is readonly it will now have write abilities.
Parameters
- wallet: any
  the wallet to use with this client.
Returns void
Inherited from BaseClient.setWallet
- Defined in core/ao/BaseClient.ts:126

viewEntrants

viewEntrants(userId: string): Promise<ViewEntrantsResponse>
Retrieves the list of entrants for a specific user's raffle.
Parameters
- userId: string
  ID of the user whose raffle entrants to view
Returns Promise<ViewEntrantsResponse>
Promise resolving to array of entrant names
Implementation of IRaffleClient.viewEntrants
- Defined in clients/miscellaneous/raffle/RaffleClient.ts:67

viewMostRecentPull

viewMostRecentPull(): Promise<RafflePull>
Retrieves the most recent raffle pull by finding the one with the highest ID.

Returns Promise<RafflePull>
Promise resolving to the most recent pull details
Implementation of IRaffleClient.viewMostRecentPull
- Defined in clients/miscellaneous/raffle/RaffleClient.ts:129

viewRaffleOwners

viewRaffleOwners(): Promise<ViewRaffleOwnersResponse>
Retrieves the list of all raffle owners.

Returns Promise<ViewRaffleOwnersResponse>
Promise resolving to array of user IDs
Implementation of IRaffleClient.viewRaffleOwners
- Defined in clients/miscellaneous/raffle/RaffleClient.ts:113

viewUserPull

viewUserPull(userId: string, pullId: string): Promise<RafflePull>
Retrieves details of a specific raffle pull for a user.
Parameters
- userId: string
  ID of the user whose pull to view
- pullId: string
  ID of the pull to view
Returns Promise<RafflePull>
Promise resolving to pull details
Implementation of IRaffleClient.viewUserPull
- Defined in clients/miscellaneous/raffle/RaffleClient.ts:81

viewUserPulls

viewUserPulls(_userId?: string): Promise<ViewPullsResponse>
Retrieves all raffle pulls for a specific user.
Parameters
- Optional_userId: string
Returns Promise<ViewPullsResponse>
Promise resolving to an object containing array of pulls
Implementation of IRaffleClient.viewUserPulls
- Defined in clients/miscellaneous/raffle/RaffleClient.ts:96

`Static`autoConfiguration

autoConfiguration(): RaffleClient
Returns RaffleClient
See
IAutoconfiguration.autoConfiguration
- Defined in clients/miscellaneous/raffle/RaffleClient.ts:26

`Static`defaultBuilder

defaultBuilder(): ClientBuilder<RaffleClient>
Returns ClientBuilder<RaffleClient>
See
IDefaultBuilder.defaultBuilder
- Defined in clients/miscellaneous/raffle/RaffleClient.ts:35

Class RaffleClient

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RaffleClient

Properties

Protected ReadonlybaseConfig

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

Protecteddryrun

Parameters

Returns Promise<DryRunResult>

getCallingWalletAddress

Returns Promise<string>

Throws

getProcessId

Returns string

getProcessInfo

Returns Promise<Partial<FullArweaveTransaction>>

Throws

getWallet

Returns any

isReadOnly

Returns boolean

isRunningDryRunsAsMessages

Returns boolean

Protectedmessage

Parameters

Returns Promise<string>

messageResult

Parameters

Returns Promise<MessageResult>

pullRaffle

Returns Promise<boolean>

Protectedresult

Parameters

Returns Promise<MessageResult>

Protectedresults

Parameters

Returns Promise<ResultsResponse>

setDryRunAsMessage

Parameters

Returns void

setRaffleEntrants

Parameters

Returns Promise<boolean>

setWallet

Parameters

Returns void

viewEntrants

Parameters

Returns Promise<ViewEntrantsResponse>

viewMostRecentPull

Returns Promise<RafflePull>

viewRaffleOwners

Returns Promise<ViewRaffleOwnersResponse>

viewUserPull

Parameters

Returns Promise<RafflePull>

viewUserPulls

Parameters

Returns Promise<ViewPullsResponse>

StaticautoConfiguration

Returns RaffleClient

See

StaticdefaultBuilder

Returns ClientBuilder<RaffleClient>

See

Settings

On This Page

`Protected` `Readonly`baseConfig

`Protected`_dryrun

`Protected`dryrun

`Protected`message

`Protected`result

`Protected`results

`Static`autoConfiguration

`Static`defaultBuilder