Class Budget

Hierarchy

  • default
    • Budget

Constructors

constructor

Properties

abi address bytecode provider

Methods

balance call dgpAddress fund getEventLogs getProposalIndex governanceAddress proposalCount proposalVoteStatus proposals send settleBudget voteForProposal

Constructors

constructor

  • new Budget(address, provider): Budget

  • Parameters

    • address: string
    • provider: Provider

    Returns Budget

Properties

abi

abi: any[]

address

address: string

bytecode

bytecode: undefined | string

provider

provider: Provider

Methods

balance

  • balance(): Promise<bigint>

  • Get the contract balance

    Returns Promise<bigint>

    the balance of the contract in satoshi

call

  • call(method, args): Promise<undefined | Result>

  • Perform calltocontract

    Parameters

    • method: string

      The contract method to call

    • args: any[]

      The arguments

    Returns Promise<undefined | Result>

    see Result

dgpAddress

  • dgpAddress(): Promise<string>

  • Get the DGP contract address

    Returns Promise<string>

    the EVM style address of the DGP contract

fund

  • fund(amount?, gasLimit?): Promise<Transaction>

  • Deposits MRX into the Budget contract

    Parameters

    • amount: undefined | string = '0'
    • gasLimit: undefined | number = 250000

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

getEventLogs

  • getEventLogs(): Promise<EventLogs>

  • Get receipts from a transaction

    Returns Promise<EventLogs>

    an EventLogs object

getProposalIndex

  • getProposalIndex(proposalId): Promise<bigint>

  • Get the index of a specific proposal

    Parameters

    • proposalId: bigint

      the id of the proposal

    Returns Promise<bigint>

governanceAddress

  • governanceAddress(): Promise<string>

  • Get the Governance contract address

    Returns Promise<string>

    the EVM style address of the Governance contract

proposalCount

proposalVoteStatus

  • proposalVoteStatus(proposalId): Promise<Vote>

  • Get a proposal's vote status

    Parameters

    • proposalId: bigint

      the id of the proposal

    Returns Promise<Vote>

    the status of the vote

proposals

  • proposals(proposalId): Promise<Proposal>

  • Get a specific proposal by id

    Parameters

    • proposalId: bigint

      the id of the proposal

    Returns Promise<Proposal>

    the propsal

send

  • send(method, args, value?, gasLimit?, gasPrice?): Promise<{
        hash160: string;
        sender: string;
        txid: string;
    }>

  • Perform sendtocontract

    Parameters

    • method: string

      The contract method to send to

    • args: any[]

      The arguments to use

    • Optionalvalue: string

      The amount to send to the contract

    • OptionalgasLimit: number

      The amount of gas units allowed

    • OptionalgasPrice: number

      The satoshi price per gas

    Returns Promise<{
        hash160: string;
        sender: string;
        txid: string;
    }>

    see Result

settleBudget

  • settleBudget(amount?, gasLimit?): Promise<Transaction>

  • Settles the monthly budget

    Parameters

    • amount: undefined | string = '0'
    • gasLimit: undefined | number = 250000

      the optional limit for gas units that can be consumed

    Returns Promise<Transaction>

    an array of TransactionReceipt objects

voteForProposal

  • voteForProposal(proposalId, vote, gasLimit?): Promise<Transaction>

  • Cast a vote for a proposal

    Parameters

    • proposalId: bigint

      the id of the proposal

    • vote: Vote

      the Vote to cast

    • gasLimit: undefined | number = 250000

    Returns Promise<Transaction>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods