AlignedContract
AlignedContract
Defined in: types.ts:625
Extends
Implements
Constructors
Constructor
new AlignedContract(stream, alignedProxy): AlignedContract;Defined in: types.ts:658
Parameters
| Parameter | Type |
|---|---|
stream | DecodedStream |
alignedProxy | { buffer: number[]; bump: number; endTime: BN; expiryPercentage: BN; expiryTime: BN; floorPrice: BN; initialAmountPerPeriod: BN; initialNetAmount: BN; initialPrice: BN; lastAmountUpdateTime: BN; lastPrice: BN; maxPercentage: BN; maxPrice: BN; minPercentage: BN; minPrice: BN; mint: PublicKey; period: BN; priceOracle: PublicKey; priceOracleType: DecodeEnum<{ kind: "enum"; variants: [{ name: "none"; }, { name: "test"; }, { name: "pyth"; }, { name: "switchboard"; }]; }, DecodedHelper<[{ name: "changeOracleParams"; type: { fields: [{ name: "oracleType"; type: { defined: { name: "oracleType"; }; }; }]; kind: "struct"; }; }, { name: "contract"; type: { fields: [{ docs: ["Bump Seed used to sign transactions"]; name: "bump"; type: "u8"; }, { docs: ["Original Contract sender"]; name: "sender"; type: "pubkey"; }, { docs: ["Original Contract sender tokens address"]; name: "senderTokens"; type: "pubkey"; }, { docs: ["Vesting Stream address"]; name: "stream"; type: "pubkey"; }, { docs: ["Type of the Oracle used to derive Token Price"]; name: "priceOracleType"; type: { defined: { name: "oracleType"; }; }; }]; kind: "struct"; }; }, { name: "createParams"; type: { fields: [{ docs: ["Timestamp when the tokens start vesting"]; name: "startTime"; type: "u64"; }, { docs: ["Deposited amount of tokens"]; name: "netAmountDeposited"; type: "u64"; }, { docs: ["Time step (period) in seconds per which the vesting/release occurs"]; name: "period"; type: "u64"; }, { docs: ["Base Amount released per period. Combined with `period`, we get a release rate."]; name: "amountPerPeriod"; type: "u64"; }, { docs: ["Vesting contract "cliff" timestamp"]; name: "cliff"; type: "u64"; }]; kind: "struct"; }; }, { name: "createTestOracleParams"; type: { fields: [{ name: "price"; type: "u64"; }, { name: "expo"; type: "i32"; }, { name: "conf"; type: "u64"; }, { name: "publishTime"; type: "i64"; }]; kind: "struct"; }; }], EmptyDefined>>; sender: PublicKey; senderTokens: PublicKey; startTime: BN; stream: PublicKey; streamCanceledTime: BN; tickSize: BN; } |
alignedProxy.buffer | number[] |
alignedProxy.bump | number |
alignedProxy.endTime | BN |
alignedProxy.expiryPercentage | BN |
alignedProxy.expiryTime | BN |
alignedProxy.floorPrice | BN |
alignedProxy.initialAmountPerPeriod | BN |
alignedProxy.initialNetAmount | BN |
alignedProxy.initialPrice | BN |
alignedProxy.lastAmountUpdateTime | BN |
alignedProxy.lastPrice | BN |
alignedProxy.maxPercentage | BN |
alignedProxy.maxPrice | BN |
alignedProxy.minPercentage | BN |
alignedProxy.minPrice | BN |
alignedProxy.mint | PublicKey |
alignedProxy.period | BN |
alignedProxy.priceOracle | PublicKey |
alignedProxy.priceOracleType | DecodeEnum<{ kind: "enum"; variants: [{ name: "none"; }, { name: "test"; }, { name: "pyth"; }, { name: "switchboard"; }]; }, DecodedHelper<[{ name: "changeOracleParams"; type: { fields: [{ name: "oracleType"; type: { defined: { name: "oracleType"; }; }; }]; kind: "struct"; }; }, { name: "contract"; type: { fields: [{ docs: ["Bump Seed used to sign transactions"]; name: "bump"; type: "u8"; }, { docs: ["Original Contract sender"]; name: "sender"; type: "pubkey"; }, { docs: ["Original Contract sender tokens address"]; name: "senderTokens"; type: "pubkey"; }, { docs: ["Vesting Stream address"]; name: "stream"; type: "pubkey"; }, { docs: ["Type of the Oracle used to derive Token Price"]; name: "priceOracleType"; type: { defined: { name: "oracleType"; }; }; }]; kind: "struct"; }; }, { name: "createParams"; type: { fields: [{ docs: ["Timestamp when the tokens start vesting"]; name: "startTime"; type: "u64"; }, { docs: ["Deposited amount of tokens"]; name: "netAmountDeposited"; type: "u64"; }, { docs: ["Time step (period) in seconds per which the vesting/release occurs"]; name: "period"; type: "u64"; }, { docs: ["Base Amount released per period. Combined with `period`, we get a release rate."]; name: "amountPerPeriod"; type: "u64"; }, { docs: ["Vesting contract "cliff" timestamp"]; name: "cliff"; type: "u64"; }]; kind: "struct"; }; }, { name: "createTestOracleParams"; type: { fields: [{ name: "price"; type: "u64"; }, { name: "expo"; type: "i32"; }, { name: "conf"; type: "u64"; }, { name: "publishTime"; type: "i64"; }]; kind: "struct"; }; }], EmptyDefined>> |
alignedProxy.sender | PublicKey |
alignedProxy.senderTokens | PublicKey |
alignedProxy.startTime | BN |
alignedProxy.stream | PublicKey |
alignedProxy.streamCanceledTime | BN |
alignedProxy.tickSize | BN |
Returns
AlignedContract
Overrides
Properties
Methods
remaining()
remaining(decimals): number;Defined in: types.ts:620
Parameters
| Parameter | Type |
|---|---|
decimals | number |
Returns
number
Implementation of
AlignedStream.remainingInherited from
unlocked()
unlocked(currentTimestamp): BN;Defined in: types.ts:613
Parameters
| Parameter | Type |
|---|---|
currentTimestamp | number |
Returns
BN
Implementation of
AlignedStream.unlocked