šŸŽ‰ Welcome to PartyFinance documentation!
Protocol
Contracts
interfaces
party
IPartyMemberActions

IPartyMemberActions

Contains party methods that can be called by any member of the party

Permissioned Party actions

deposit

function deposit(address user, uint256 amount, struct LibSignatures.Allocation allocation, struct LibSignatures.Sig approval) external

Deposits into the party

The user must be a member and the party must be opened

Parameters

NameTypeDescription
useraddressUser address that will be making the deposit
amountuint256Deposit amount in denomination asset
allocationstruct LibSignatures.AllocationDesired allocation of the deposit
approvalstruct LibSignatures.SigVerified sentinel signature of the desired deposit

withdraw

function withdraw(uint256 amountPT, struct LibSignatures.Allocation allocation, struct LibSignatures.Sig approval, bool liquidate) external

Withdraw funds from the party

The user must be a member

Parameters

NameTypeDescription
amountPTuint256Amount of PartyTokens of the requester to withdraw
allocationstruct LibSignatures.AllocationDesired allocation of the withdraw
approvalstruct LibSignatures.SigVerified sentinel signature of the desired withdraw
liquidateboolWhether to liquidate assets (convert all owned assets into denomination asset) or to withdraw assets as it is

leaveParty

function leaveParty(struct LibSignatures.Allocation allocation, struct LibSignatures.Sig approval, bool liquidate) external

Leave the party (withdraw all funds and remove membership)

The user must be a member

Parameters

NameTypeDescription
allocationstruct LibSignatures.AllocationDesired allocation of the withdraw
approvalstruct LibSignatures.SigVerified sentinel signature of the desired withdraw
liquidateboolWhether to liquidate assets (convert all owned assets into denomination asset) or to withdraw assets as it is