Class BotegaLiquidityPoolClient

Hierarchy

DryRunCachingClient
- BotegaLiquidityPoolClient

Implements

IBotegaLiquidityPoolClient

Constructors

constructor

new BotegaLiquidityPoolClient(processId: string): BotegaLiquidityPoolClient
Parameters
- processId: string
Returns BotegaLiquidityPoolClient
Overrides DryRunCachingClient.constructor
- Defined in clients/autonomous-finance/botega/liquidity-pool/BotegaLiquidityPoolClient.ts:21

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 DryRunCachingClient._dryrun
- Defined in core/ao/client-variants/DryRunCachingClient.ts:26

clearCache

clearCache(): void
Clears the Cache

Returns void
Inherited from DryRunCachingClient.clearCache
- Defined in core/ao/client-variants/DryRunCachingClient.ts:21

`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>
Implementation of IBotegaLiquidityPoolClient.dryrun
Inherited from DryRunCachingClient.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
Implementation of IBotegaLiquidityPoolClient.getCallingWalletAddress
Inherited from DryRunCachingClient.getCallingWalletAddress
- Defined in core/ao/BaseClient.ts:139

getLPInfo

getLPInfo(): Promise<LPInfo>
Get information about the liquidity pool including token details and pool data

Returns Promise<LPInfo>
Pool information including token details and pool data
Implementation of IBotegaLiquidityPoolClient.getLPInfo
- Defined in clients/autonomous-finance/botega/liquidity-pool/BotegaLiquidityPoolClient.ts:30

getPrice

getPrice(quantity: string | number, tokenId: string): Promise<number>
Get price for a given quantity and token
Parameters
- quantity: string | number
  The quantity to get price for (number or string)
- tokenId: string
  The token ID
Returns Promise<number>
Price as a number
Implementation of IBotegaLiquidityPoolClient.getPrice
- Defined in clients/autonomous-finance/botega/liquidity-pool/BotegaLiquidityPoolClient.ts:50

getPriceOfTokenAInTokenB

getPriceOfTokenAInTokenB(quantity: string | number): Promise<number>
Get price of token A in terms of token B
Parameters
- quantity: string | number
  The quantity of token A
Returns Promise<number>
Price in token B
Implementation of IBotegaLiquidityPoolClient.getPriceOfTokenAInTokenB
- Defined in clients/autonomous-finance/botega/liquidity-pool/BotegaLiquidityPoolClient.ts:101

getPriceOfTokenBInTokenA

getPriceOfTokenBInTokenA(quantity: string | number): Promise<number>
Get price of token B in terms of token A
Parameters
- quantity: string | number
  The quantity of token B
Returns Promise<number>
Price in token A
Implementation of IBotegaLiquidityPoolClient.getPriceOfTokenBInTokenA
- Defined in clients/autonomous-finance/botega/liquidity-pool/BotegaLiquidityPoolClient.ts:110

getProcessId

getProcessId(): string
Returns string
Boolean indicating whether or not the client is set to run dryruns as messages. (non default behavior)
Implementation of IBotegaLiquidityPoolClient.getProcessId
Inherited from DryRunCachingClient.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
Implementation of IBotegaLiquidityPoolClient.getProcessInfo
Inherited from DryRunCachingClient.getProcessInfo
- Defined in core/ao/BaseClient.ts:154

getTokenA

getTokenA(): Promise<ITokenClient>
Get token A client instance

Returns Promise<ITokenClient>
Token A client
Implementation of IBotegaLiquidityPoolClient.getTokenA
- Defined in clients/autonomous-finance/botega/liquidity-pool/BotegaLiquidityPoolClient.ts:69

getTokenB

getTokenB(): Promise<ITokenClient>
Get token B client instance

Returns Promise<ITokenClient>
Token B client
Implementation of IBotegaLiquidityPoolClient.getTokenB
- Defined in clients/autonomous-finance/botega/liquidity-pool/BotegaLiquidityPoolClient.ts:85

getWallet

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

Returns any
the wallet used for message signing
Implementation of IBotegaLiquidityPoolClient.getWallet
Inherited from DryRunCachingClient.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.
Implementation of IBotegaLiquidityPoolClient.isReadOnly
Inherited from DryRunCachingClient.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)
Implementation of IBotegaLiquidityPoolClient.isRunningDryRunsAsMessages
Inherited from DryRunCachingClient.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>
Implementation of IBotegaLiquidityPoolClient.message
Inherited from DryRunCachingClient.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 DryRunCachingClient.messageResult
- Defined in core/ao/BaseClient.ts:168

`Protected`result

result(messageId: string): Promise<MessageResult>
Protected
Parameters
- messageId: string
Returns Promise<MessageResult>
Implementation of IBotegaLiquidityPoolClient.result
Inherited from DryRunCachingClient.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>
Implementation of IBotegaLiquidityPoolClient.results
Inherited from DryRunCachingClient.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
Implementation of IBotegaLiquidityPoolClient.setDryRunAsMessage
Inherited from DryRunCachingClient.setDryRunAsMessage
- Defined in core/ao/BaseClient.ts:119

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
Implementation of IBotegaLiquidityPoolClient.setWallet
Inherited from DryRunCachingClient.setWallet
- Defined in core/ao/BaseClient.ts:126

Class BotegaLiquidityPoolClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BotegaLiquidityPoolClient

Properties

Protected ReadonlybaseConfig

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

clearCache

Returns void

Protecteddryrun

Parameters

Returns Promise<DryRunResult>

getCallingWalletAddress

Returns Promise<string>

Throws

getLPInfo

Returns Promise<LPInfo>

getPrice

Parameters

Returns Promise<number>

getPriceOfTokenAInTokenB

Parameters

Returns Promise<number>

getPriceOfTokenBInTokenA

Parameters

Returns Promise<number>

getProcessId

Returns string

getProcessInfo

Returns Promise<Partial<FullArweaveTransaction>>

Throws

getTokenA

Returns Promise<ITokenClient>

getTokenB

Returns Promise<ITokenClient>

getWallet

Returns any

isReadOnly

Returns boolean

isRunningDryRunsAsMessages

Returns boolean

Protectedmessage

Parameters

Returns Promise<string>

messageResult

Parameters

Returns Promise<MessageResult>

Protectedresult

Parameters

Returns Promise<MessageResult>

Protectedresults

Parameters

Returns Promise<ResultsResponse>

setDryRunAsMessage

Parameters

Returns void

setWallet

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`baseConfig

`Protected`_dryrun

`Protected`dryrun

`Protected`message

`Protected`result

`Protected`results