Class SweepstakesClient

See

specification

Hierarchy

BaseClient
- SweepstakesClient

Implements

ISweepstakesClient

Constructors

constructor

new SweepstakesClient(
sweepstakesConfig: SweepstakesClientConfig,
): SweepstakesClient
Parameters
- sweepstakesConfig: SweepstakesClientConfig
Returns SweepstakesClient
Overrides BaseClient.constructor
- Defined in clients/miscellaneous/sweepstakes/SweepstakesClient.ts:32

Properties

`Protected` `Readonly`baseConfig

baseConfig: BaseClientConfig

`Readonly`tokenClient

tokenClient: TokenClient

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

addSweepstakesEntrant

addSweepstakesEntrant(entrant: string, sweepstakesId: string): Promise<boolean>
Adds an entrant to the sweepstakes.
Parameters
- entrant: string
  Name of the entrant to add
- sweepstakesId: string
Returns Promise<boolean>
Promise resolving to true if successful
Implementation of ISweepstakesClient.addSweepstakesEntrant
- Defined in clients/miscellaneous/sweepstakes/SweepstakesClient.ts:100

deleteSweepstakesData

deleteSweepstakesData(sweepstakesId: string, pullId?: string): Promise<Boolean>
Deletes a sweepstakes or pull by ID
Parameters
- sweepstakesId: string
  ID of the sweepstakes to delete
- OptionalpullId: string
  ID of the pull to delete
Returns Promise<Boolean>
Promise resolving to true if successful
Implementation of ISweepstakesClient.deleteSweepstakesData
- Defined in clients/miscellaneous/sweepstakes/SweepstakesClient.ts:115

`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

pullSweepstakes

pullSweepstakes(sweepstakesId: string, details?: string): Promise<boolean>
Performs a sweepstakes pull to select a winner.
Parameters
- sweepstakesId: string
- Optionaldetails: string
Returns Promise<boolean>
Promise resolving to true if successful
Implementation of ISweepstakesClient.pullSweepstakes
- Defined in clients/miscellaneous/sweepstakes/SweepstakesClient.ts:132

registerSweepstakes

registerSweepstakes(entrants: string[], details: string): Promise<boolean>
Registers a new sweepstakes.
Parameters
- entrants: string[]
- details: string
Returns Promise<boolean>
Promise resolving to true if successful
Implementation of ISweepstakesClient.registerSweepstakes
- Defined in clients/miscellaneous/sweepstakes/SweepstakesClient.ts:71

`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

setSweepstakesEntrants

setSweepstakesEntrants(
entrants: string[],
sweepstakesId: string,
): Promise<boolean>
Sets the list of entrants for the sweepstakes.
Parameters
- entrants: string[]
  Array of entrant names
- sweepstakesId: string
Returns Promise<boolean>
Promise resolving to true if successful
Implementation of ISweepstakesClient.setSweepstakesEntrants
- Defined in clients/miscellaneous/sweepstakes/SweepstakesClient.ts:85

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

viewAllSweepstakes

viewAllSweepstakes(): Promise<ViewAllSweepstakesResponse>
Retrieves the list of all sweepstakes.

Returns Promise<ViewAllSweepstakesResponse>
Promise resolving to array of sweepstakes
Implementation of ISweepstakesClient.viewAllSweepstakes
- Defined in clients/miscellaneous/sweepstakes/SweepstakesClient.ts:175

viewSweepstakes

viewSweepstakes(sweepstakesId: string): Promise<SweepstakesData>
Retrieves the sweepstakes for a specific id.
Parameters
- sweepstakesId: string
  ID of the sweepstakes to view
Returns Promise<SweepstakesData>
Promise resolving to sweepstakes details
Implementation of ISweepstakesClient.viewSweepstakes
- Defined in clients/miscellaneous/sweepstakes/SweepstakesClient.ts:161

viewSweepstakesPull

viewSweepstakesPull(
sweepstakesId: string,
pullId: string,
): Promise<SweepstakesPull>
Retrieves details of a specific sweepstakes pull for a user.
Parameters
- sweepstakesId: string
- pullId: string
  ID of the pull to view
Returns Promise<SweepstakesPull>
Promise resolving to pull details
Implementation of ISweepstakesClient.viewSweepstakesPull
- Defined in clients/miscellaneous/sweepstakes/SweepstakesClient.ts:146

`Static`autoConfiguration

autoConfiguration(): Promise<SweepstakesClient>
Returns Promise<SweepstakesClient>
See
IAutoconfiguration.autoConfiguration
- Defined in clients/miscellaneous/sweepstakes/SweepstakesClient.ts:48

`Static`builder

builder(): TokenInterfacingClientBuilder<SweepstakesClient>
Returns TokenInterfacingClientBuilder<SweepstakesClient>
- Defined in clients/miscellaneous/sweepstakes/SweepstakesClient.ts:55

`Static`defaultBuilder

defaultBuilder(): Promise<TokenInterfacingClientBuilder<SweepstakesClient>>
Returns Promise<TokenInterfacingClientBuilder<SweepstakesClient>>
See
IDefaultBuilder.defaultBuilder
- Defined in clients/miscellaneous/sweepstakes/SweepstakesClient.ts:63

Class SweepstakesClient

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SweepstakesClient

Properties

Protected ReadonlybaseConfig

ReadonlytokenClient

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

addSweepstakesEntrant

Parameters

Returns Promise<boolean>

deleteSweepstakesData

Parameters

Returns Promise<Boolean>

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>

pullSweepstakes

Parameters

Returns Promise<boolean>

registerSweepstakes

Parameters

Returns Promise<boolean>

Protectedresult

Parameters

Returns Promise<MessageResult>

Protectedresults

Parameters

Returns Promise<ResultsResponse>

setDryRunAsMessage

Parameters

Returns void

setSweepstakesEntrants

Parameters

Returns Promise<boolean>

setWallet

Parameters

Returns void

viewAllSweepstakes

Returns Promise<ViewAllSweepstakesResponse>

viewSweepstakes

Parameters

Returns Promise<SweepstakesData>

viewSweepstakesPull

Parameters

Returns Promise<SweepstakesPull>

StaticautoConfiguration

Returns Promise<SweepstakesClient>

See

`Protected` `Readonly`baseConfig

`Readonly`tokenClient

`Protected`_dryrun

`Protected`dryrun

`Protected`message

`Protected`result

`Protected`results

`Static`autoConfiguration

`Static`builder

`Static`defaultBuilder