@gala-chain/chaincode ∙ API

---

API > DexV3Contract

Class: DexV3Contract

Contents

• Extends
• Constructors
• new DexV3Contract()
• Methods
• AddLiquidity()
• AuthorizeBatchSubmitter()
• BatchEvaluate()
• BatchSubmit()
• CollectPositionFees()
• CollectProtocolFees()
• ConfigureDexFeeAddress()
• ConfigurePoolDexFee()
• CreatePool()
• DeauthorizeBatchSubmitter()
• DryRun()
• GetAddLiquidityEstimation()
• GetBatchSubmitAuthorities()
• GetChaincodeVersion()
• GetContractAPI()
• GetContractVersion()
• GetDexFeeConfigration()
• GetLiquidity()
• GetObjectByKey()
• GetObjectHistory()
• GetPoolData()
• GetPositionByID()
• GetPositions()
• GetRemoveLiquidityEstimation()
• GetSlot0()
• GetTickData()
• GetUserPositions()
• QuoteExactAmount()
• RemoveLiquidity()
• SetProtocolFee()
• Swap()
• TransferDexPosition()
• afterTransaction()
• aroundTransaction()
• beforeTransaction()
• createContext()
• getName()
• getVersion()
• unknownTransaction()
• _isContract()

Extends

• GalaContract

Constructors

new DexV3Contract()

new DexV3Contract(): DexV3Contract

Overrides

GalaContract.constructor

Source

chaincode/src/contracts/DexV3Contract.ts:106

Methods

AddLiquidity()

AddLiquidity(ctx, dto): Promise\<DexOperationResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: AddLiquidityDTO

Source

chaincode/src/contracts/DexV3Contract.ts:179

---

AuthorizeBatchSubmitter()

AuthorizeBatchSubmitter(ctx, dto): Promise\<BatchSubmitAuthoritiesResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: AuthorizeBatchSubmitterDto

Source

chaincode/src/contracts/DexV3Contract.ts:387

---

BatchEvaluate()

BatchEvaluate(ctx, batchDto): Promise\<GalaChainResponse\<unknown>[]>

Parameters

▪ ctx: GalaChainContext

▪ batchDto: BatchDto

Inherited from

GalaContract.BatchEvaluate

Source

chaincode/src/contracts/GalaContract.ts:238

---

BatchSubmit()

BatchSubmit(ctx, batchDto): Promise\<GalaChainResponse\<unknown>[]>

Parameters

▪ ctx: GalaChainContext

▪ batchDto: BatchDto

Overrides

GalaContract.BatchSubmit

Source

chaincode/src/contracts/DexV3Contract.ts:117

---

CollectPositionFees()

CollectPositionFees(ctx, dto): Promise\<DexOperationResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: CollectDto

Source

chaincode/src/contracts/DexV3Contract.ts:285

---

CollectProtocolFees()

CollectProtocolFees(ctx, dto): Promise\<CollectProtocolFeesResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: CollectProtocolFeesDto

Source

chaincode/src/contracts/DexV3Contract.ts:294

---

ConfigureDexFeeAddress()

ConfigureDexFeeAddress(ctx, dto): Promise\<DexFeeConfig>

Parameters

▪ ctx: GalaChainContext

▪ dto: ConfigureDexFeeAddressDto

Source

chaincode/src/contracts/DexV3Contract.ts:336

---

ConfigurePoolDexFee()

ConfigurePoolDexFee(ctx, dto): Promise\<ConfigurePoolDexFeeResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: ConfigurePoolDexFeeDto

Source

chaincode/src/contracts/DexV3Contract.ts:315

---

CreatePool()

CreatePool(ctx, dto): Promise\<CreatePoolResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: CreatePoolDto

Source

chaincode/src/contracts/DexV3Contract.ts:170

---

DeauthorizeBatchSubmitter()

DeauthorizeBatchSubmitter(ctx, dto): Promise\<BatchSubmitAuthoritiesResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: DeauthorizeBatchSubmitterDto

Source

chaincode/src/contracts/DexV3Contract.ts:399

---

DryRun()

DryRun(ctx, dto): Promise\<DryRunResultDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: DryRunDto

Inherited from

GalaContract.DryRun

Source

chaincode/src/contracts/GalaContract.ts:154

---

GetAddLiquidityEstimation()

GetAddLiquidityEstimation(ctx, dto): Promise\<GetAddLiquidityEstimationResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: GetAddLiquidityEstimationDto

Source

chaincode/src/contracts/DexV3Contract.ts:236

---

GetBatchSubmitAuthorities()

GetBatchSubmitAuthorities(ctx, dto): Promise\<BatchSubmitAuthoritiesResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: FetchBatchSubmitAuthoritiesDto

Source

chaincode/src/contracts/DexV3Contract.ts:411

---

GetChaincodeVersion()

GetChaincodeVersion(ctx): Promise\<string>

Parameters

▪ ctx: GalaChainContext

Inherited from

GalaContract.GetChaincodeVersion

Source

chaincode/src/contracts/GalaContract.ts:116

---

GetContractAPI()

GetContractAPI(ctx): Promise\<ContractAPI>

Parameters

▪ ctx: GalaChainContext

Inherited from

GalaContract.GetContractAPI

Source

chaincode/src/contracts/GalaContract.ts:125

---

GetContractVersion()

GetContractVersion(ctx): Promise\<string>

Parameters

▪ ctx: GalaChainContext

Inherited from

GalaContract.GetContractVersion

Source

chaincode/src/contracts/GalaContract.ts:105

---

GetDexFeeConfigration()

GetDexFeeConfigration(ctx, dto): Promise\<DexFeeConfig>

Parameters

▪ ctx: GalaChainContext

▪ dto: ChainCallDTO

Source

chaincode/src/contracts/DexV3Contract.ts:327

---

GetLiquidity()

GetLiquidity(ctx, dto): Promise\<GetLiquidityResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: GetPoolDto

Source

chaincode/src/contracts/DexV3Contract.ts:215

---

GetObjectByKey()

GetObjectByKey(ctx, dto): Promise\<Record\<string, unknown>>

Parameters

▪ ctx: GalaChainContext

▪ dto: GetObjectDto

Inherited from

GalaContract.GetObjectByKey

Source

chaincode/src/contracts/GalaContract.ts:136

---

GetObjectHistory()

GetObjectHistory(ctx, dto): Promise\<Record\<string, unknown>>

Parameters

▪ ctx: GalaChainContext

▪ dto: GetObjectHistoryDto

Inherited from

GalaContract.GetObjectHistory

Source

chaincode/src/contracts/GalaContract.ts:145

---

GetPoolData()

GetPoolData(ctx, dto): Promise\<Pool>

Parameters

▪ ctx: GalaChainContext

▪ dto: GetPoolDto

Source

chaincode/src/contracts/DexV3Contract.ts:259

---

GetPositionByID()

GetPositionByID(ctx, dto): Promise\<DexPositionData>

Parameters

▪ ctx: GalaChainContext

▪ dto: GetPositionByIdDto

Source

chaincode/src/contracts/DexV3Contract.ts:369

---

GetPositions()

GetPositions(ctx, dto): Promise\<DexPositionData>

Parameters

▪ ctx: GalaChainContext

▪ dto: GetPositionDto

Source

chaincode/src/contracts/DexV3Contract.ts:360

---

GetRemoveLiquidityEstimation()

GetRemoveLiquidityEstimation(ctx, dto): Promise\<GetRemoveLiqEstimationResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: BurnEstimateDto

Source

chaincode/src/contracts/DexV3Contract.ts:273

---

GetSlot0()

GetSlot0(ctx, dto): Promise\<Slot0ResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: GetPoolDto

Source

chaincode/src/contracts/DexV3Contract.ts:206

---

GetTickData()

GetTickData(ctx, dto): Promise\<TickData>

Parameters

▪ ctx: GalaChainContext

▪ dto: GetTickDataDto

Source

chaincode/src/contracts/DexV3Contract.ts:378

---

GetUserPositions()

GetUserPositions(ctx, dto): Promise\<GetUserPositionsResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: GetUserPositionsDto

Source

chaincode/src/contracts/DexV3Contract.ts:224

---

QuoteExactAmount()

QuoteExactAmount(ctx, dto): Promise\<QuoteExactAmountResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: QuoteExactAmountDto

Source

chaincode/src/contracts/DexV3Contract.ts:248

---

RemoveLiquidity()

RemoveLiquidity(ctx, dto): Promise\<DexOperationResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: BurnDto

Source

chaincode/src/contracts/DexV3Contract.ts:197

---

SetProtocolFee()

SetProtocolFee(ctx, dto): Promise\<SetProtocolFeeResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: SetProtocolFeeDto

Source

chaincode/src/contracts/DexV3Contract.ts:306

---

Swap()

Swap(ctx, dto): Promise\<SwapResDto>

Parameters

▪ ctx: GalaChainContext

▪ dto: SwapDto

Source

chaincode/src/contracts/DexV3Contract.ts:188

---

TransferDexPosition()

TransferDexPosition(ctx, dto): Promise\<DexPositionOwner>

Parameters

▪ ctx: GalaChainContext

▪ dto: TransferDexPositionDto

Source

chaincode/src/contracts/DexV3Contract.ts:348

---

afterTransaction()

afterTransaction(ctx, result): Promise\<void>

Parameters

▪ ctx: GalaChainContext

▪ result: unknown

Inherited from

GalaContract.afterTransaction

Source

chaincode/src/contracts/GalaContract.ts:79

---

aroundTransaction()

aroundTransaction(ctx, fn, parameters): Promise\<void>

Parameters

▪ ctx: GalaChainContext

▪ fn: Function

▪ parameters: unknown

Inherited from

GalaContract.aroundTransaction

Source

chaincode/src/contracts/GalaContract.ts:74

---

beforeTransaction()

beforeTransaction(ctx): Promise\<void>

Parameters

▪ ctx: GalaChainContext

Inherited from

GalaContract.beforeTransaction

Source

chaincode/src/contracts/GalaContract.ts:69

---

createContext()

createContext(): GalaChainContext

Inherited from

GalaContract.createContext

Source

chaincode/src/contracts/GalaContract.ts:65

---

getName()

getName(): string

Inherited from

GalaContract.getName

Source

node_modules/fabric-contract-api/types/index.d.ts:33

---

getVersion()

getVersion(): string

Inherited from

GalaContract.getVersion

Source

chaincode/src/contracts/GalaContract.ts:61

---

unknownTransaction()

unknownTransaction(ctx): Promise\<void>

Parameters

▪ ctx: Context

Inherited from

GalaContract.unknownTransaction

Source

node_modules/fabric-contract-api/types/index.d.ts:30

---

_isContract()

static _isContract(): boolean

Inherited from

GalaContract._isContract

Source

node_modules/fabric-contract-api/types/index.d.ts:24