Skip to main content

Class: ChromaticAccount

Represents a Chromatic Account and provides methods to interact with it.

Constructors

constructor

new ChromaticAccount(_client)

Creates a new instance of ChromaticAccount.

Parameters

NameTypeDescription
_clientClientThe Chromatic Client instance.

Defined in

packages/sdk-viem/src/entities/ChromaticAccount.ts:23

Methods

balance

balance(token, accountAddress?): Promise<bigint>

Retrieves the balance of a specific token in the Chromatic Account.

Parameters

NameTypeDescription
token`0x${string}`The address of the token.
accountAddress?`0x${string}`The address of the account (optional).

Returns

Promise<bigint>

A promise that resolves to the balance of the token.

Defined in

packages/sdk-viem/src/entities/ChromaticAccount.ts:96


balances

balances(tokens, accountAddress?): Promise<{ balance: bigint ; token: `0x${string}` }[]>

Retrieves the balances of multiple tokens in the Chromatic Account.

Parameters

NameTypeDescription
tokens`0x${string}`[]An array of token addresses.
accountAddress?`0x${string}`The address of the account (optional).

Returns

Promise<{ balance: bigint ; token: `0x${string}` }[]>

A promise that resolves to an array of TokenBalancesResult objects.

Defined in

packages/sdk-viem/src/entities/ChromaticAccount.ts:113


contracts

contracts(): Object

Retrieves the contract instances associated with the Chromatic Account.

Returns

Object

An object containing the contract instances.

NameType
account(address: `0x${string}`) => ContractChromaticAccount
router() => ContractChromaticRouter

Defined in

packages/sdk-viem/src/entities/ChromaticAccount.ts:29


createAccount

createAccount(): Promise<TransactionReceipt>

Creates a new Chromatic Account.

Returns

Promise<TransactionReceipt>

A promise that resolves to the transaction receipt of the account creation.

Defined in

packages/sdk-viem/src/entities/ChromaticAccount.ts:47


getAccount

getAccount(): Promise<`0x${string}`>

Retrieves the current Chromatic Account.

Returns

Promise<`0x${string}`>

A promise that resolves to the Chromatic Account details.

Defined in

packages/sdk-viem/src/entities/ChromaticAccount.ts:62


getPositionIds

getPositionIds(marketAddress, accountAddress?): Promise<readonly bigint[]>

Retrieves the position IDs associated with a specific market.

Parameters

NameTypeDescription
marketAddress`0x${string}`The address of the market.
accountAddress?`0x${string}`The address of the account (optional).

Returns

Promise<readonly bigint[]>

A promise that resolves to an array of position IDs.

Defined in

packages/sdk-viem/src/entities/ChromaticAccount.ts:76