@peeramid-labs/sdk 3.15.0 → 3.16.0

package/docs/docs/interfaces/ContractCondition.md

@@ -0,0 +1,41 @@
+# Interface: ContractCondition
+
+## Table of contents
+
+### Properties
+
+- [have](ContractCondition.md#have)
+- [lock](ContractCondition.md#lock)
+- [burn](ContractCondition.md#burn)
+- [pay](ContractCondition.md#pay)
+- [bet](ContractCondition.md#bet)
+
+## Properties
+
+### have
+
+• **have**: [`TransactionProperties`](TransactionProperties.md)
+
+___
+
+### lock
+
+• **lock**: [`TransactionProperties`](TransactionProperties.md)
+
+___
+
+### burn
+
+• **burn**: [`TransactionProperties`](TransactionProperties.md)
+
+___
+
+### pay
+
+• **pay**: [`TransactionProperties`](TransactionProperties.md)
+
+___
+
+### bet
+
+• **bet**: [`TransactionProperties`](TransactionProperties.md)

package/docs/docs/interfaces/DailyProposal.md

@@ -0,0 +1,36 @@
+# Interface: DailyProposal
+
+Structure representing a single proposal in the system
+
+## Table of contents
+
+### Properties
+
+- [proposal](DailyProposal.md#proposal)
+- [score](DailyProposal.md#score)
+- [proposer](DailyProposal.md#proposer)
+- [exists](DailyProposal.md#exists)
+
+## Properties
+
+### proposal
+
+• **proposal**: \`0x$\{string}\`
+
+___
+
+### score
+
+• **score**: `bigint`
+
+___
+
+### proposer
+
+• **proposer**: \`0x$\{string}\`
+
+___
+
+### exists
+
+• **exists**: `boolean`

package/docs/docs/interfaces/JoinRequirementsInput.md

@@ -0,0 +1,20 @@
+# Interface: JoinRequirementsInput
+
+## Table of contents
+
+### Properties
+
+- [ethValues](JoinRequirementsInput.md#ethvalues)
+- [contracts](JoinRequirementsInput.md#contracts)
+
+## Properties
+
+### ethValues
+
+• **ethValues**: [`numericConditon`](numericConditon.md)
+
+___
+
+### contracts
+
+• **contracts**: [`configSmartRequirement`](configSmartRequirement.md)[]

package/docs/docs/interfaces/ProposalGlobalStats.md

@@ -0,0 +1,29 @@
+# Interface: ProposalGlobalStats
+
+Structure representing global statistics for a proposal
+
+## Table of contents
+
+### Properties
+
+- [aggregateScore](ProposalGlobalStats.md#aggregatescore)
+- [proposedTimes](ProposalGlobalStats.md#proposedtimes)
+- [repostedTimes](ProposalGlobalStats.md#repostedtimes)
+
+## Properties
+
+### aggregateScore
+
+• **aggregateScore**: `bigint`
+
+___
+
+### proposedTimes
+
+• **proposedTimes**: `bigint`
+
+___
+
+### repostedTimes
+
+• **repostedTimes**: `bigint`

package/docs/docs/interfaces/TransactionProperties.md

@@ -0,0 +1,20 @@
+# Interface: TransactionProperties
+
+## Table of contents
+
+### Properties
+
+- [data](TransactionProperties.md#data)
+- [amount](TransactionProperties.md#amount)
+
+## Properties
+
+### data
+
+• **data**: \`0x$\{string}\`
+
+___
+
+### amount
+
+• **amount**: `bigint`

package/docs/docs/interfaces/UBIParams.md

@@ -0,0 +1,29 @@
+# Interface: UBIParams
+
+Structure representing UBI parameters
+
+## Table of contents
+
+### Properties
+
+- [dailyClaimAmount](UBIParams.md#dailyclaimamount)
+- [dailySupportAmount](UBIParams.md#dailysupportamount)
+- [domainName](UBIParams.md#domainname)
+
+## Properties
+
+### dailyClaimAmount
+
+• **dailyClaimAmount**: `bigint`
+
+___
+
+### dailySupportAmount
+
+• **dailySupportAmount**: `bigint`
+
+___
+
+### domainName
+
+• **domainName**: \`0x$\{string}\`

package/docs/docs/interfaces/UserState.md

@@ -0,0 +1,22 @@
+# Interface: UserState
+
+Structure representing user state
+
+## Table of contents
+
+### Properties
+
+- [claimedToday](UserState.md#claimedtoday)
+- [supportSpent](UserState.md#supportspent)
+
+## Properties
+
+### claimedToday
+
+• **claimedToday**: `boolean`
+
+___
+
+### supportSpent
+
+• **supportSpent**: `bigint`

package/docs/docs/interfaces/VoteElement.md

@@ -0,0 +1,22 @@
+# Interface: VoteElement
+
+Structure representing a vote for a proposal
+
+## Table of contents
+
+### Properties
+
+- [proposal](VoteElement.md#proposal)
+- [amount](VoteElement.md#amount)
+
+## Properties
+
+### proposal
+
+• **proposal**: \`0x$\{string}\`
+
+___
+
+### amount
+
+• **amount**: `bigint`

package/docs/docs/interfaces/configSmartRequirement.md

@@ -0,0 +1,34 @@
+# Interface: configSmartRequirement
+
+## Table of contents
+
+### Properties
+
+- [contractAddress](configSmartRequirement.md#contractaddress)
+- [contractId](configSmartRequirement.md#contractid)
+- [contractType](configSmartRequirement.md#contracttype)
+- [contractRequirement](configSmartRequirement.md#contractrequirement)
+
+## Properties
+
+### contractAddress
+
+• **contractAddress**: \`0x$\{string}\`
+
+___
+
+### contractId
+
+• **contractId**: `string`
+
+___
+
+### contractType
+
+• **contractType**: [`ContractTypes`](../enums/ContractTypes.md)
+
+___
+
+### contractRequirement
+
+• **contractRequirement**: [`ContractCondition`](ContractCondition.md)

package/docs/docs/interfaces/numericConditon.md

@@ -0,0 +1,41 @@
+# Interface: numericConditon
+
+## Table of contents
+
+### Properties
+
+- [have](numericConditon.md#have)
+- [lock](numericConditon.md#lock)
+- [burn](numericConditon.md#burn)
+- [pay](numericConditon.md#pay)
+- [bet](numericConditon.md#bet)
+
+## Properties
+
+### have
+
+• **have**: `bigint`
+
+___
+
+### lock
+
+• **lock**: `bigint`
+
+___
+
+### burn
+
+• **burn**: `bigint`
+
+___
+
+### pay
+
+• **pay**: `bigint`
+
+___
+
+### bet
+
+• **bet**: `bigint`

package/docs/enums/ContractTypes.md

@@ -0,0 +1,27 @@
+# Enumeration: ContractTypes
+
+## Table of contents
+
+### Enumeration Members
+
+- [ERC20](ContractTypes.md#erc20)
+- [ERC1155](ContractTypes.md#erc1155)
+- [ERC721](ContractTypes.md#erc721)
+
+## Enumeration Members
+
+### ERC20
+
+• **ERC20** = ``0``
+
+___
+
+### ERC1155
+
+• **ERC1155** = ``1``
+
+___
+
+### ERC721
+
+• **ERC721** = ``2``