Class NftClient

Hierarchy (View Summary)

TokenClient
- NftClient

Implements

INftClient

Constructors

constructor

new NftClient(configOrProcessId: TokenClientConfig): NftClient
Parameters
- configOrProcessId: TokenClientConfig
Returns NftClient
Overrides TokenClient.constructor
- Defined in clients/bazar/nft/NftClient.ts:15

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 TokenClient._dryrun
- Defined in core/ao/BaseClient.ts:101

balance

balance(identifier?: string): Promise<string>
Gets the balance of a specific identifier (address) in the token ledger. This is a read-only operation that queries the current state of the ledger.
Parameters
- Optionalidentifier: string
  The address to check the balance for
Returns Promise<string>
Promise resolving to the current balance as a string
Implementation of INftClient.balance
Inherited from TokenClient.balance
- Defined in clients/ao/token/TokenClient.ts:50

balances

balances(limit?: number, cursor?: string): Promise<DryRunResult>
Gets a paginated list of all balances in the token ledger. This is a read-only operation that returns all ledger/account balances.
Parameters
- limit: number = 1000
  Optional maximum number of balances to return per page
- Optionalcursor: string
  Optional pagination cursor for fetching subsequent pages
Returns Promise<DryRunResult>
Promise resolving to the dry run result containing the balances

Remarks
If ever used should refactor to return the balances in a list format
Implementation of INftClient.balances
Inherited from TokenClient.balances
- Defined in clients/ao/token/TokenClient.ts:65

`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 TokenClient.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 TokenClient.getCallingWalletAddress
- Defined in core/ao/BaseClient.ts:139

getInfo

getInfo(token?: string): Promise<TokenInfo>
Gets information about the token.
Parameters
- Optionaltoken: string
  Optional token process ID to get information for. If not provided, uses the current process ID.
Returns Promise<TokenInfo>
Promise resolving to TokenInfo with token information
Implementation of INftClient.getInfo
Inherited from TokenClient.getInfo
- Defined in clients/ao/token/TokenClient.ts:103

getProcessId

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

grant

grant(quantity: string, recipient?: string): Promise<boolean>
Grants tokens to a recipient address
Parameters
- quantity: string
  The amount of tokens to grant
- Optionalrecipient: string
  The recipient address, defaults to the calling wallet address
Returns Promise<boolean>
Promise resolving to boolean indicating success
Inherited from TokenClient.grant
- Defined in clients/ao/token/TokenClient.ts:156

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 TokenClient.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 TokenClient.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 TokenClient.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 TokenClient.messageResult
- Defined in core/ao/BaseClient.ts:168

mint

mint(quantity: string): Promise<boolean>
Mints new tokens, increasing the total supply. This operation can only be performed on the root token process.
Parameters
- quantity: string
  The amount of new tokens to create
Returns Promise<boolean>
Promise resolving to true if minting was successful
Implementation of INftClient.mint
Inherited from TokenClient.mint
- Defined in clients/ao/token/TokenClient.ts:143

`Protected`result

result(messageId: string): Promise<MessageResult>
Protected
Parameters
- messageId: string
Returns Promise<MessageResult>
Inherited from TokenClient.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 TokenClient.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 TokenClient.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
Inherited from TokenClient.setWallet
- Defined in core/ao/BaseClient.ts:126

transfer

transfer(
    recipient: string,
    quantity?: string,
    forwardedTags?: Tags,
): Promise<boolean>
Transfer an NFT to a recipient. If no quantity is specified, defaults to 1.
Parameters
- recipient: string
  The recipient's address
- quantity: string = NFT_QUANTITY
  Optional quantity to transfer (defaults to 1)
- OptionalforwardedTags: Tags
  Optional tags to forward with the transfer
Returns Promise<boolean>
Implementation of INftClient.transfer
Overrides TokenClient.transfer
- Defined in clients/bazar/nft/NftClient.ts:22

`Static`autoConfiguration

autoConfiguration(): TokenClient
Returns TokenClient
See
IAutoconfiguration.autoConfiguration
Inherited from TokenClient.autoConfiguration
- Defined in clients/ao/token/TokenClient.ts:26

`Static`builder

builder(): ClientBuilder<TokenClient>
Creates a builder for TokenClient instances

Returns ClientBuilder<TokenClient>
A new builder for TokenClient
Inherited from TokenClient.builder
- Defined in clients/ao/token/TokenClient.ts:35

`Static`defaultBuilder

defaultBuilder(): ClientBuilder<TokenClient>
Returns ClientBuilder<TokenClient>
See
IDefaultBuilder.defaultBuilder
Inherited from TokenClient.defaultBuilder
- Defined in clients/ao/token/TokenClient.ts:43

Class NftClient

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NftClient

Properties

Protected ReadonlybaseConfig

Methods

Protected_dryrun

Parameters

Returns Promise<DryRunResult>

balance

Parameters

Returns Promise<string>

balances

Parameters

Returns Promise<DryRunResult>

Remarks

Protecteddryrun

Parameters

Returns Promise<DryRunResult>

getCallingWalletAddress

Returns Promise<string>

Throws

getInfo

Parameters

Returns Promise<TokenInfo>

getProcessId

Returns string

getProcessInfo

Returns Promise<Partial<FullArweaveTransaction>>

Throws

getWallet

Returns any

grant

Parameters

Returns Promise<boolean>

isReadOnly

Returns boolean

isRunningDryRunsAsMessages

Returns boolean

Protectedmessage

Parameters

Returns Promise<string>

messageResult

Parameters

Returns Promise<MessageResult>

mint

Parameters

Returns Promise<boolean>

Protectedresult

Parameters

Returns Promise<MessageResult>

Protectedresults

Parameters

Returns Promise<ResultsResponse>

setDryRunAsMessage

Parameters

Returns void

setWallet

Parameters

Returns void

transfer

Parameters

Returns Promise<boolean>

StaticautoConfiguration

Returns TokenClient

See

Staticbuilder

Returns ClientBuilder<TokenClient>

StaticdefaultBuilder

Returns ClientBuilder<TokenClient>

See

Settings

`Protected` `Readonly`baseConfig

`Protected`_dryrun

`Protected`dryrun

`Protected`message

`Protected`result

`Protected`results

`Static`autoConfiguration

`Static`builder

`Static`defaultBuilder