Class SuiStreamClient

Hierarchy

BaseStreamClient
- SuiStreamClient

Index

Constructors

Methods

cancel create createMultiple extractErrorCode get getDefaultStreamflowFee getFees getOne getProgramId getTotalFee topup transfer update withdraw

Constructors

constructor

new SuiStreamClient(
    clusterUrl: string,
    cluster?: ICluster,
    ids?: ISuiIdParameters,
): SuiStreamClient
Parameters
- clusterUrl: string
- cluster: ICluster = ICluster.Mainnet
- Optionalids: ISuiIdParameters
Returns SuiStreamClient
Overrides BaseStreamClient.constructor
- Defined in packages/stream/sui/StreamClient.ts:52

Methods

cancel

cancel(
cancelData: IInteractData,
__namedParameters: ITransactionSuiExt,
): Promise<ITransactionResult>
Attempts canceling the specified stream.
Parameters
- cancelData: IInteractData
- __namedParameters: ITransactionSuiExt
Returns Promise<ITransactionResult>
Overrides BaseStreamClient.cancel
- Defined in packages/stream/sui/StreamClient.ts:198

create

create(
streamData: ICreateStreamData,
__namedParameters: ICreateStreamSuiExt,
): Promise<ICreateResult>
Creates a new stream/vesting contract.
Parameters
- streamData: ICreateStreamData
- __namedParameters: ICreateStreamSuiExt
Returns Promise<ICreateResult>
Overrides BaseStreamClient.create
- Defined in packages/stream/sui/StreamClient.ts:65

createMultiple

createMultiple(
multipleStreamData: ICreateMultipleStreamData,
__namedParameters: ICreateStreamSuiExt,
): Promise<IMultiTransactionResult>
Creates multiple stream/vesting contracts. We don't chain transactions in one Block so that one failed transaction does not revert all others.
Parameters
- multipleStreamData: ICreateMultipleStreamData
- __namedParameters: ICreateStreamSuiExt
Returns Promise<IMultiTransactionResult>
Overrides BaseStreamClient.createMultiple
- Defined in packages/stream/sui/StreamClient.ts:95

extractErrorCode

extractErrorCode(err: Error): string
Parameters
- err: Error
Returns string
Overrides BaseStreamClient.extractErrorCode
- Defined in packages/stream/sui/StreamClient.ts:349

get

get(): Promise<[string, Contract][]>
Returns Promise<[string, Contract][]>
Overrides BaseStreamClient.get
- Defined in packages/stream/sui/StreamClient.ts:306

getDefaultStreamflowFee

getDefaultStreamflowFee(): Promise<number>
Returns Promise<number>
Overrides BaseStreamClient.getDefaultStreamflowFee
- Defined in packages/stream/sui/StreamClient.ts:395

getFees

getFees(__namedParameters: IGetFeesData): Promise<IFees>
Parameters
- __namedParameters: IGetFeesData
Returns Promise<IFees>
Overrides BaseStreamClient.getFees
- Defined in packages/stream/sui/StreamClient.ts:354

getOne

getOne(__namedParameters: IInteractData): Promise<Contract>
Fetch stream data by its id (address).
Parameters
- __namedParameters: IInteractData
Returns Promise<Contract>
Overrides BaseStreamClient.getOne
- Defined in packages/stream/sui/StreamClient.ts:284

getProgramId

getProgramId(): string
Returns StreamClient protocol program ID.

Returns string
- Defined in packages/stream/sui/StreamClient.ts:414

getTotalFee

getTotalFee(
getFeesData: IGetFeesData,
chainSpecificParams?: any,
): Promise<number>
Returns total fee percent, streamflow fees + partner fees
Parameters
- getFeesData: IGetFeesData
  structure with address for which we need to derive fee, either sender or partner usually
- OptionalchainSpecificParams: any
  additional parameters required by chain client
Returns Promise<number>
fee as floating number, so if fee is 0.99%, it will return 0.99
Inherited from BaseStreamClient.getTotalFee
- Defined in packages/stream/common/BaseStreamClient.ts:63

topup

topup(
topupData: ITopUpData,
__namedParameters: ITransactionSuiExt,
): Promise<ITransactionResult>
Tops up stream account with specified amount.
Parameters
- topupData: ITopUpData
- __namedParameters: ITransactionSuiExt
Returns Promise<ITransactionResult>
Overrides BaseStreamClient.topup
- Defined in packages/stream/sui/StreamClient.ts:248

transfer

transfer(
transferData: ITransferData,
__namedParameters: ITransactionSuiExt,
): Promise<ITransactionResult>
Attempts changing the stream/vesting contract's recipient (effectively transferring the stream/vesting contract).
Parameters
- transferData: ITransferData
- __namedParameters: ITransactionSuiExt
Returns Promise<ITransactionResult>
Overrides BaseStreamClient.transfer
- Defined in packages/stream/sui/StreamClient.ts:223

update

update(
updateData: IUpdateData,
__namedParameters: ITransactionSuiExt,
): Promise<ITransactionResult>
Attempts updating the stream auto withdrawal params and amount per period
Parameters
- updateData: IUpdateData
- __namedParameters: ITransactionSuiExt
Returns Promise<ITransactionResult>
Overrides BaseStreamClient.update
- Defined in packages/stream/sui/StreamClient.ts:313

withdraw

withdraw(
__namedParameters: IWithdrawData,
__namedParameters: ITransactionSuiExt,
): Promise<ITransactionResult>
Attempts withdrawing from the specified stream.
Parameters
- __namedParameters: IWithdrawData
- __namedParameters: ITransactionSuiExt
Returns Promise<ITransactionResult>
Overrides BaseStreamClient.withdraw
- Defined in packages/stream/sui/StreamClient.ts:168

Class SuiStreamClient

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SuiStreamClient

Methods

cancel

Parameters

Returns Promise<ITransactionResult>

create

Parameters

Returns Promise<ICreateResult>

createMultiple

Parameters

Returns Promise<IMultiTransactionResult>

extractErrorCode

Parameters

Returns string

get

Returns Promise<[string, Contract][]>

getDefaultStreamflowFee

Returns Promise<number>

getFees

Parameters

Returns Promise<IFees>

getOne

Parameters

Returns Promise<Contract>

getProgramId

Returns string

getTotalFee

Parameters

Returns Promise<number>

topup

Parameters

Returns Promise<ITransactionResult>

transfer

Parameters

Returns Promise<ITransactionResult>

update

Parameters

Returns Promise<ITransactionResult>

withdraw

Parameters

Returns Promise<ITransactionResult>

Settings

On This Page