@mean-dao/payment-streaming

export type Msp = { "version": "2.8.2"; "name": "msp"; "instructions": [ { "name": "createTreasury"; "docs": [ "Create Treasury" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "treasurer"; "isMut": true; "isSigner": true; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "slot"; "type": "u64"; }, { "name": "name"; "type": "string"; }, { "name": "treasuryType"; "type": "u8"; }, { "name": "autoClose"; "type": "bool"; }, { "name": "solFeePayedByTreasury"; "type": "bool"; }, { "name": "category"; "type": { "defined": "Category"; }; }, { "name": "subCategory"; "type": { "defined": "SubCategory"; }; } ]; }, { "name": "createStream"; "docs": [ "Create Stream" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "treasurer"; "isMut": false; "isSigner": true; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "beneficiary"; "isMut": false; "isSigner": false; }, { "name": "stream"; "isMut": true; "isSigner": true; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "feeTreasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "name"; "type": "string"; }, { "name": "startUtc"; "type": "u64"; }, { "name": "rateAmountUnits"; "type": "u64"; }, { "name": "rateIntervalInSeconds"; "type": "u64"; }, { "name": "allocationAssignedUnits"; "type": "u64"; }, { "name": "cliffVestAmountUnits"; "type": "u64"; }, { "name": "cliffVestPercent"; "type": "u64"; }, { "name": "feePayedByTreasurer"; "type": "bool"; } ]; }, { "name": "createStreamPda"; "docs": [ "Create Stream PDA" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "treasurer"; "isMut": false; "isSigner": true; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "beneficiary"; "isMut": false; "isSigner": false; }, { "name": "stream"; "isMut": true; "isSigner": false; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "feeTreasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "name"; "type": "string"; }, { "name": "startUtc"; "type": "u64"; }, { "name": "rateAmountUnits"; "type": "u64"; }, { "name": "rateIntervalInSeconds"; "type": "u64"; }, { "name": "allocationAssignedUnits"; "type": "u64"; }, { "name": "cliffVestAmountUnits"; "type": "u64"; }, { "name": "cliffVestPercent"; "type": "u64"; }, { "name": "feePayedByTreasurer"; "type": "bool"; }, { "name": "streamPdaSeed"; "type": "publicKey"; } ]; }, { "name": "createStreamTemplate"; "docs": [ "Create template" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "treasurer"; "isMut": false; "isSigner": true; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "template"; "isMut": true; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "startUtc"; "type": "u64"; }, { "name": "rateIntervalInSeconds"; "type": "u64"; }, { "name": "durationNumberOfUnits"; "type": "u64"; }, { "name": "cliffVestPercent"; "type": "u64"; }, { "name": "feePayedByTreasurer"; "type": "bool"; } ]; }, { "name": "modifyStreamTemplate"; "docs": [ "Edit template" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "treasurer"; "isMut": false; "isSigner": true; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "template"; "isMut": true; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "startUtc"; "type": "u64"; }, { "name": "rateIntervalInSeconds"; "type": "u64"; }, { "name": "durationNumberOfUnits"; "type": "u64"; }, { "name": "cliffVestPercent"; "type": "u64"; }, { "name": "feePayedByTreasurer"; "type": "bool"; } ]; }, { "name": "createTreasuryAndTemplate"; "docs": [ "Create Treasury" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "treasurer"; "isMut": true; "isSigner": true; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; }, { "name": "template"; "isMut": true; "isSigner": false; }, { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "name"; "type": "string"; }, { "name": "treasuryType"; "type": "u8"; }, { "name": "autoClose"; "type": "bool"; }, { "name": "solFeePayedByTreasury"; "type": "bool"; }, { "name": "category"; "type": { "defined": "Category"; }; }, { "name": "subCategory"; "type": { "defined": "SubCategory"; }; }, { "name": "startUtc"; "type": "u64"; }, { "name": "rateIntervalInSeconds"; "type": "u64"; }, { "name": "durationNumberOfUnits"; "type": "u64"; }, { "name": "cliffVestPercent"; "type": "u64"; }, { "name": "feePayedByTreasurer"; "type": "bool"; }, { "name": "slot"; "type": "u64"; } ]; }, { "name": "createStreamWithTemplate"; "docs": [ "Create stream with template" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "treasurer"; "isMut": false; "isSigner": true; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "beneficiary"; "isMut": false; "isSigner": false; }, { "name": "template"; "isMut": false; "isSigner": false; }, { "name": "stream"; "isMut": true; "isSigner": true; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "feeTreasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "name"; "type": "string"; }, { "name": "allocationAssignedUnits"; "type": "u64"; } ]; }, { "name": "createStreamPdaWithTemplate"; "docs": [ "Create stream with template" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "treasurer"; "isMut": false; "isSigner": true; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "beneficiary"; "isMut": false; "isSigner": false; }, { "name": "template"; "isMut": false; "isSigner": false; }, { "name": "stream"; "isMut": true; "isSigner": false; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "feeTreasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "name"; "type": "string"; }, { "name": "allocationAssignedUnits"; "type": "u64"; }, { "name": "streamPdaSeed"; "type": "publicKey"; } ]; }, { "name": "withdraw"; "docs": [ "Withdraw" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "beneficiary"; "isMut": true; "isSigner": true; }, { "name": "beneficiaryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; }, { "name": "stream"; "isMut": true; "isSigner": false; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "feeTreasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "amount"; "type": "u64"; } ]; }, { "name": "pauseStream"; "docs": [ "Pause Stream" ]; "accounts": [ { "name": "initializer"; "isMut": false; "isSigner": true; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "stream"; "isMut": true; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; } ]; }, { "name": "resumeStream"; "docs": [ "Resume Stream" ]; "accounts": [ { "name": "initializer"; "isMut": false; "isSigner": true; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "stream"; "isMut": true; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; } ]; }, { "name": "refreshTreasuryData"; "docs": [ "Refresh Treasury Balance" ]; "accounts": [ { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; } ]; }, { "name": "transferStream"; "docs": [ "Transfer Stream" ]; "accounts": [ { "name": "beneficiary"; "isMut": true; "isSigner": true; }, { "name": "stream"; "isMut": true; "isSigner": false; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "newBeneficiary"; "type": "publicKey"; } ]; }, { "name": "getStream"; "docs": [ "Get Stream" ]; "accounts": [ { "name": "stream"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; } ]; }, { "name": "addFunds"; "docs": [ "Adds funds the treasury" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "contributor"; "isMut": true; "isSigner": true; }, { "name": "contributorToken"; "isMut": true; "isSigner": false; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "feeTreasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "amount"; "type": "u64"; } ]; }, { "name": "allocate"; "docs": [ "Allocate units to a stream" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "treasurer"; "isMut": false; "isSigner": true; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "stream"; "isMut": true; "isSigner": false; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "feeTreasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "amount"; "type": "u64"; } ]; }, { "name": "closeStream"; "docs": [ "Close Stream" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "treasurer"; "isMut": true; "isSigner": true; }, { "name": "beneficiary"; "isMut": false; "isSigner": false; }, { "name": "beneficiaryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; }, { "name": "stream"; "isMut": true; "isSigner": false; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "feeTreasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; } ]; }, { "name": "closeTreasury"; "docs": [ "Close Treasury" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "treasurer"; "isMut": true; "isSigner": true; }, { "name": "destinationAuthority"; "isMut": true; "isSigner": false; }, { "name": "destinationTokenAccount"; "isMut": true; "isSigner": false; }, { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "feeTreasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; } ]; }, { "name": "treasuryWithdraw"; "docs": [ "Withdraw unallocated funds from treasury" ]; "accounts": [ { "name": "payer"; "isMut": true; "isSigner": true; }, { "name": "treasurer"; "isMut": true; "isSigner": true; }, { "name": "destinationAuthority"; "isMut": false; "isSigner": false; }, { "name": "destinationTokenAccount"; "isMut": true; "isSigner": false; }, { "name": "associatedToken"; "isMut": false; "isSigner": false; }, { "name": "treasury"; "isMut": true; "isSigner": false; }, { "name": "treasuryToken"; "isMut": true; "isSigner": false; }, { "name": "feeTreasury"; "isMut": true; "isSigner": false; }, { "name": "feeTreasuryToken"; "isMut": true; "isSigner": false; }, { "name": "associatedTokenProgram"; "isMut": false; "isSigner": false; }, { "name": "tokenProgram"; "isMut": false; "isSigner": false; }, { "name": "systemProgram"; "isMut": false; "isSigner": false; }, { "name": "rent"; "isMut": false; "isSigner": false; } ]; "args": [ { "name": "idlFileVersion"; "type": "u8"; }, { "name": "amount"; "type": "u64"; } ]; } ]; "accounts": [ { "name": "stream"; "type": { "kind": "struct"; "fields": [ { "name": "version"; "type": "u8"; }, { "name": "initialized"; "type": "bool"; }, { "name": "name"; "type": { "array": [ "u8", 32 ]; }; }, { "name": "treasurerAddress"; "type": "publicKey"; }, { "name": "rateAmountUnits"; "type": "u64"; }, { "name": "rateIntervalInSeconds"; "type": "u64"; }, { "name": "startUtc"; "docs": [ "The start timestamp in seconds" ]; "type": "u64"; }, { "name": "cliffVestAmountUnits"; "docs": [ "The amount availaible to withdraw inmidiately (without streaming)", "once the money stream starts.", "If both 'cliff_vest_amount_units' and 'cliff_vest_percent' are provided, the former will be used." ]; "type": "u64"; }, { "name": "cliffVestPercent"; "docs": [ "The percent of the allocation assigned that is availaible to withdraw", "inmidiately (without streaming) once the money stream starts.", "If both 'cliff_vest_amount_units' and 'cliff_vest_percent' are provided, the second (this field) will be used." ]; "type": "u64"; }, { "name": "beneficiaryAddress"; "type": "publicKey"; }, { "name": "beneficiaryAssociatedToken"; "type": "publicKey"; }, { "name": "treasuryAddress"; "type": "publicKey"; }, { "name": "allocationAssignedUnits"; "docs": [ "Amount of tokens allocated to the stream on creation or top up. If the", "treasurer decides to close the stream, the vested amount will be sent", "to the benefifiary and the unvested amount will be sent to the", "treasurer", "", "The allocation assigned will be affected by the following instructions:", "`addFunds`" ]; "type": "u64"; }, { "name": "allocationReservedUnits"; "docs": [ "Amount of tokens reserved to the stream. If the treasurer decides to", "close the stream, the total amount (vested and unvested) WILL be sent", "to the beneficiary", "", "[deprecated] The allocation reserved will be affected by the following instructions:", "`addFunds`" ]; "type": "u64"; }, { "name": "totalWithdrawalsUnits"; "docs": [ "Withdrawal tracking", "The total amount that has been withdrawn by the beneficiary" ]; "type": "u64"; }, { "name": "lastWithdrawalUnits"; "docs": [ "The last amount withdrew by the beneficiary" ]; "type": "u64"; }, { "name": "lastWithdrawalSlot"; "docs": [ "The slot number when the last withdrawal was executed" ]; "type": "u64"; }, { "name": "lastWithdrawalBlockTime"; "docs": [ "The blocktime value when the last withdrawal was executed" ]; "type": "u64"; }, { "name": "lastManualStopWithdrawableUnitsSnap"; "docs": [ "How can a stream STOP? -> There are 2 ways:", "1) by a Manual Action (recordable when it happens) or", "2) by Running Out Of Funds (not recordable when it happens, needs to be calculated)" ]; "type": "u64"; }, { "name": "lastManualStopSlot"; "type": "u64"; }, { "name": "lastManualStopBlockTime"; "type": "u64"; }, { "name": "lastManualResumeRemainingAllocationUnitsSnap"; "docs": [ "The remaining allocation units at the moment of the last manual resume", "must be set when calling the Resume Stream" ]; "type": "u64"; }, { "name": "lastManualResumeSlot"; "type": "u64"; }, { "name": "lastManualResumeBlockTime"; "type": "u64"; }, { "name": "lastKnownTotalSecondsInPausedStatus"; "docs": [ "The total seconds that have been paused since the start_utc", "increment when resume is called manually" ]; "type": "u64"; }, { "name": "lastAutoStopBlockTime"; "docs": [ "The last blocktime when the stream was stopped", "either manually or automaticaly (run out of funds)" ]; "type": "u64"; }, { "name": "feePayedByTreasurer"; "type": "bool"; }, { "name": "startUtcInSeconds"; "docs": [ "The start timestamp blocktime" ]; "type": "u64"; }, { "name": "createdOnUtc"; "docs": [ "Unix timestamp (in seconds) when the stream was created" ]; "type": "u64"; }, { "name": "category"; "docs": [ "Indicates the main product category such as `Vesting(1)`", "The default value is set to a `Default(0)` cateogry." ]; "type": "u8"; }, { "name": "subCategory"; "docs": [ "Indicates the sub product category such as `Advisor(1)`, Development(2)", "The default value is set to a `Default(0)` sub_cateogry." ]; "type": "u8"; } ]; }; }, { "name": "streamTemplate"; "type": { "kind": "struct"; "fields": [ { "name": "version"; "type": "u8"; }, { "name": "bump"; "type": "u8"; }, { "name": "startUtcInSeconds"; "docs": [ "The start timestamp blocktime" ]; "type": "u64"; }, { "name": "cliffVestPercent";