Treasury

SIP Protocol API Reference v0.15.1

SIP Protocol API Reference / Treasury

Class: Treasury

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9638

Treasury class - manages DAO treasury with multi-sig support

Accessors

treasuryId

Get Signature

get treasuryId(): string

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9653

Returns

string

name

Get Signature

get name(): string

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9654

Returns

string

chain

Get Signature

get chain(): ChainId

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9655

Returns

ChainId

signingThreshold

Get Signature

get signingThreshold(): number

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9656

Returns

number

members

Get Signature

get members(): TreasuryMember[]

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9657

Returns

TreasuryMember[]

masterViewingKey

Get Signature

get masterViewingKey(): ViewingKey | undefined

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9658

Returns

ViewingKey | undefined

Methods

create()

static create(params): Promise<Treasury>

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9648

Create a new treasury

Parameters

params

CreateTreasuryParams

Returns

Promise<Treasury>

fromConfig()

static fromConfig(config): Treasury

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9652

Load a treasury from config

Parameters

config

TreasuryConfig

Returns

Treasury

getConfig()

getConfig(): TreasuryConfig

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9662

Get treasury configuration

Returns

TreasuryConfig

getMember()

getMember(address): TreasuryMember | undefined

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9666

Get a member by address

Parameters

address

string

Returns

TreasuryMember | undefined

isSigner()

isSigner(address): boolean

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9670

Check if an address is a signer

Parameters

address

string

Returns

boolean

canCreateProposal()

canCreateProposal(address): boolean

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9674

Check if an address can create proposals

Parameters

address

string

Returns

boolean

getSigners()

getSigners(): TreasuryMember[]

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9678

Get all signers

Returns

TreasuryMember[]

createPaymentProposal()

createPaymentProposal(params): Promise<TreasuryProposal>

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9682

Create a single payment proposal

Parameters

params

CreatePaymentProposalParams

Returns

Promise<TreasuryProposal>

createBatchProposal()

createBatchProposal(params): Promise<TreasuryProposal>

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9686

Create a batch payment proposal

Parameters

params

CreateBatchProposalParams

Returns

Promise<TreasuryProposal>

getProposal()

getProposal(proposalId): TreasuryProposal | undefined

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9690

Get a proposal by ID

Parameters

proposalId

string

Returns

TreasuryProposal | undefined

getAllProposals()

getAllProposals(): TreasuryProposal[]

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9694

Get all proposals

Returns

TreasuryProposal[]

getPendingProposals()

getPendingProposals(): TreasuryProposal[]

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9698

Get pending proposals

Returns

TreasuryProposal[]

signProposal()

signProposal(proposalId, signerAddress, privateKey, approve?): Promise<TreasuryProposal>

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9702

Sign a proposal

Parameters

proposalId

string

signerAddress

string

privateKey

`0x${string}`

approve?

boolean

Returns

Promise<TreasuryProposal>

executeProposal()

executeProposal(proposalId): Promise<ShieldedPayment[]>

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9706

Execute an approved proposal

Parameters

proposalId

string

Returns

Promise<ShieldedPayment[]>

cancelProposal()

cancelProposal(proposalId, cancellerAddress): TreasuryProposal

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9710

Cancel a proposal (only by proposer or owner)

Parameters

proposalId

string

cancellerAddress

string

Returns

TreasuryProposal

grantAuditorAccess()

grantAuditorAccess(auditorId, auditorName, granterAddress, scope?, validUntil?): AuditorViewingKey

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9714

Grant viewing access to an auditor

Parameters

auditorId

string

auditorName

string

granterAddress

string

scope?

"all" | "inbound" | "outbound"

validUntil?

number

Returns

AuditorViewingKey

revokeAuditorAccess()

revokeAuditorAccess(auditorId, revokerAddress): boolean

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9718

Revoke auditor access

Parameters

auditorId

string

revokerAddress

string

Returns

boolean

getAuditorKeys()

getAuditorKeys(): AuditorViewingKey[]

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9722

Get all auditor keys

Returns

AuditorViewingKey[]

updateBalance()

updateBalance(token, balance): void

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9726

Update balance for a token (called after deposits/withdrawals)

Parameters

token

Asset

balance

bigint

Returns

void

getBalance()

getBalance(token): TreasuryBalance | undefined

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9730

Get balance for a token

Parameters

token

Asset

Returns

TreasuryBalance | undefined

getAllBalances()

getAllBalances(): TreasuryBalance[]

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9734

Get all balances

Returns

TreasuryBalance[]

toJSON()

toJSON(): string

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9742

Serialize treasury to JSON

Returns

string

fromJSON()

static fromJSON(json): Treasury

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:9746

Deserialize treasury from JSON

Parameters

json

string

Returns

Treasury