Class UniswapV3RouterBridge

Hierarchy

Model<UniswapV3RouterBridgeMethods>
- UniswapV3RouterBridge

Implements

Deployable

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new UniswapV3RouterBridge(web3Connection: Web3Connection | Web3ConnectionOptions, contractAddress?: string): UniswapV3RouterBridge

Overrides Model.constructor
- Defined in src/models/uniswap-v3-router-bridge.ts:10
Parameters
- web3Connection: Web3Connection | Web3ConnectionOptions
- Optional contractAddress: string
Returns UniswapV3RouterBridge

Properties

Protected _contract

_contract: Web3Contract<UniswapV3RouterBridgeMethods, any>

Readonly abi

abi: AbiItem[]

Optional Readonly contractAddress

contractAddress?: string

Accessors

account

get account(): Account

Inherited from Model.account
- Defined in src/base/model.ts:48
Returns the Account associated with this connection

Returns Account

Protected connection

get connection(): Web3Connection

Inherited from Model.connection
- Defined in src/base/model.ts:38
Pointer to the Web3Connection assigned to this contract class

Returns Web3Connection

contract

get contract(): Web3Contract<Methods, any>

Inherited from Model.contract
- Defined in src/base/model.ts:21
Returns the Web3Contract class representing this contract

Returns Web3Contract<Methods, any>

web3

get web3(): default

Inherited from Model.web3
- Defined in src/base/model.ts:43
Returns the Web3 class assigned to this connection

Returns default

Methods

callTx

callTx<ReturnData>(method: ContractCallMethod<ReturnData>): Promise<ReturnData>

Inherited from Model.callTx
- Defined in src/base/model.ts:93
Return a property value from the contract

Type Parameters
- ReturnData = any
Parameters
- method: ContractCallMethod<ReturnData>
Returns Promise<ReturnData>

connect

connect(): Promise<boolean>

Inherited from Model.connect
- Defined in src/base/model.ts:72
Alias for Web3Connection.connect(); Will load contract if success

Returns Promise<boolean>

Protected deploy

deploy(deployOptions: DeployOptions, account?: Account): Promise<TransactionReceipt<any>>

Inherited from Model.deploy
- Defined in src/base/model.ts:147
Deploy the loaded abi contract

Parameters
- deployOptions: DeployOptions
- Optional account: Account
Returns Promise<TransactionReceipt<any>>

deployJsonAbi

deployJsonAbi(_swapRouter: string): Promise<TransactionReceipt<any>>

Implementation of Deployable.deployJsonAbi
- Defined in src/models/uniswap-v3-router-bridge.ts:14
Parameters
- _swapRouter: string
Returns Promise<TransactionReceipt<any>>

loadAbi

loadAbi(): void

Inherited from Model.loadAbi
- Defined in src/base/model.ts:53
Permissive way of initializing the contract, used primarily for deploys. Prefer to use loadContract

Returns void

loadContract

loadContract(): void

Inherited from Model.loadContract
- Defined in src/base/model.ts:61
Preferred way of initializing and loading a contract

throws
Errors.MissingContractAddress

Returns void

sendTx

sendTx(method: ContractSendMethod, value?: any): Promise<TransactionReceipt<any>>

Inherited from Model.sendTx
- Defined in src/base/model.ts:100
Interact with, or change a value of, a property on the contract

Parameters
- method: ContractSendMethod
- Optional value: any
Returns Promise<TransactionReceipt<any>>

sendUnsignedTx

sendUnsignedTx(method: ContractSendMethod, value?: any, __namedParameters?: Partial<Web3ConnectionOptions>): Promise<TransactionReceipt<any>>

Inherited from Model.sendUnsignedTx
- Defined in src/base/model.ts:118
Send unsigned transaction

Parameters
- method: ContractSendMethod
- Optional value: any
- __namedParameters: Partial<Web3ConnectionOptions> = {}
Returns Promise<TransactionReceipt<any>>

start

start(): Promise<void>

Inherited from Model.start
- Defined in src/base/model.ts:85
Alias for Web3Connection.start(); Will load contract if success

Returns Promise<void>

swapExactInputSingleEx

swapExactInputSingleEx(tokenIn: string, tokenOut: string, poolFee: undefined, amountIn: number, amountOutMinimum: number): Promise<number>

- Defined in src/models/uniswap-v3-router-bridge.ts:27
Parameters
- tokenIn: string
- tokenOut: string
- poolFee: undefined
- amountIn: number
- amountOutMinimum: number
Returns Promise<number>

swapExactOutputSingleEx

swapExactOutputSingleEx(tokenIn: string, tokenOut: string, poolFee: undefined, amountOut: number, amountInMaximum: number): Promise<number>

- Defined in src/models/uniswap-v3-router-bridge.ts:36
Parameters
- tokenIn: string
- tokenOut: string
- poolFee: undefined
- amountOut: number
- amountInMaximum: number
Returns Promise<number>

swapRouter

swapRouter(): Promise<string>

- Defined in src/models/uniswap-v3-router-bridge.ts:23
Returns Promise<string>

Generated using TypeDoc