Class Sablier

Hierarchy

Model<SablierMethods>
- Sablier

Implements

Deployable

Constructors

constructor

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

Overrides Model.constructor
- Defined in src/models/sablier.ts:14
Parameters
- web3Connection: Web3Connection | Web3ConnectionOptions
- Optional contractAddress: string
Returns Sablier

Properties

Protected _contract

_contract: Web3Contract<SablierMethods, 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

addPauser

addPauser(account: string): Promise<TransactionReceipt<any>>

- Defined in src/models/sablier.ts:27
Parameters
- account: string
Returns Promise<TransactionReceipt<any>>

balanceOf

balanceOf(streamId: number, who: string): Promise<string>

- Defined in src/models/sablier.ts:85
Parameters
- streamId: number
- who: string
Returns Promise<string>

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>

cancelStream

cancelStream(streamId: number): Promise<TransactionReceipt<any>>

- Defined in src/models/sablier.ts:142
Parameters
- streamId: number
Returns Promise<TransactionReceipt<any>>

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>

createCompoundingStream

createCompoundingStream(recipient: string, deposit: string | number, tokenAddress: string, startTime: number, stopTime: number, senderSharePercentage: number, recipientSharePercentage: number): Promise<TransactionReceipt<any>>

- Defined in src/models/sablier.ts:118
Parameters
- recipient: string
- deposit: string | number
- tokenAddress: string
- startTime: number
- stopTime: number
- senderSharePercentage: number
- recipientSharePercentage: number
Returns Promise<TransactionReceipt<any>>

createStream

createStream(recipient: string, deposit: string | number, tokenAddress: string, startTime: number, stopTime: number): Promise<TransactionReceipt<any>>

- Defined in src/models/sablier.ts:109
Parameters
- recipient: string
- deposit: string | number
- tokenAddress: string
- startTime: number
- stopTime: number
Returns Promise<TransactionReceipt<any>>

deltaOf

deltaOf(streamId: number): Promise<number>

- Defined in src/models/sablier.ts:81
Parameters
- streamId: number
Returns Promise<number>

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(): Promise<TransactionReceipt<any>>

Implementation of Deployable.deployJsonAbi
- Defined in src/models/sablier.ts:18
Returns Promise<TransactionReceipt<any>>

fee

fee(): Promise<string>

- Defined in src/models/sablier.ts:31
Returns Promise<string>

getCompoundingStream

getCompoundingStream(streamId: number): Promise<SablierCompoundingStream>

- Defined in src/models/sablier.ts:94
Parameters
- streamId: number
Returns Promise<SablierCompoundingStream>

getEarnings

getEarnings(tokenAddress: string): Promise<string>

- Defined in src/models/sablier.ts:104
Parameters
- tokenAddress: string
Returns Promise<string>

getStream

getStream(streamId: number): Promise<SablierStream>

- Defined in src/models/sablier.ts:77
Parameters
- streamId: number
Returns Promise<SablierStream>

getTokenDecimals

getTokenDecimals(tokenAddress: string): Promise<undefined>

- Defined in src/models/sablier.ts:150
Parameters
- tokenAddress: string
Returns Promise<undefined>

getTokenDecimalsFromStream

getTokenDecimalsFromStream(streamId: number): Promise<undefined>

- Defined in src/models/sablier.ts:146
Parameters
- streamId: number
Returns Promise<undefined>

initialize

initialize(sender: string): Promise<TransactionReceipt<any>>

- Defined in src/models/sablier.ts:35
Parameters
- sender: string
Returns Promise<TransactionReceipt<any>>

interestOf

interestOf(streamId: number, amount: number): Promise<SablierInterest>

- Defined in src/models/sablier.ts:99
Parameters
- streamId: number
- amount: number
Returns Promise<SablierInterest>

isCompoundingStream

isCompoundingStream(streamId: number): Promise<boolean>

- Defined in src/models/sablier.ts:90
Parameters
- streamId: number
Returns Promise<boolean>

isPauser

isPauser(account: string): Promise<boolean>

- Defined in src/models/sablier.ts:39
Parameters
- account: string
Returns Promise<boolean>

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

nextStreamId

nextStreamId(): Promise<number>

- Defined in src/models/sablier.ts:43
Returns Promise<number>

owner

owner(): Promise<string>

- Defined in src/models/sablier.ts:47
Returns Promise<string>

pause

pause(): Promise<TransactionReceipt<any>>

- Defined in src/models/sablier.ts:51
Returns Promise<TransactionReceipt<any>>

paused

paused(): Promise<boolean>

- Defined in src/models/sablier.ts:55
Returns Promise<boolean>

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>

takeEarnings

takeEarnings(tokenAddress: string, amount: number): Promise<TransactionReceipt<any>>

- Defined in src/models/sablier.ts:71
Parameters
- tokenAddress: string
- amount: number
Returns Promise<TransactionReceipt<any>>

transferOwnership

transferOwnership(newOwner: string): Promise<TransactionReceipt<any>>

- Defined in src/models/sablier.ts:59
Parameters
- newOwner: string
Returns Promise<TransactionReceipt<any>>

unpause

unpause(): Promise<TransactionReceipt<any>>

- Defined in src/models/sablier.ts:63
Returns Promise<TransactionReceipt<any>>

updateFee

updateFee(feePercentage: number): Promise<TransactionReceipt<any>>

- Defined in src/models/sablier.ts:67
Parameters
- feePercentage: number
Returns Promise<TransactionReceipt<any>>

withdrawFromStream

withdrawFromStream(streamId: number, amount: string | number): Promise<TransactionReceipt<any>>

- Defined in src/models/sablier.ts:137
Parameters
- streamId: number
- amount: string | number
Returns Promise<TransactionReceipt<any>>

Generated using TypeDoc