Options
All
  • Public
  • Public/Protected
  • All
Menu

radicle-drips

Index

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Type Aliases

CallStruct

CallStruct: { data: PromiseOrValue<BytesLike>; target: PromiseOrValue<string>; value: PromiseOrValue<BigNumberish> }

Type declaration

  • data: PromiseOrValue<BytesLike>
  • target: PromiseOrValue<string>
  • value: PromiseOrValue<BigNumberish>

CollectableBalance

CollectableBalance: { collectableAmount: bigint; tokenAddress: string }

Type declaration

  • collectableAmount: bigint

    The amount which would be collected.

  • tokenAddress: string

    The token address.

CollectedEvent

CollectedEvent: { assetId: bigint; blockTimestamp: bigint; collected: bigint; id: string; userId: string }

Type declaration

  • assetId: bigint
  • blockTimestamp: bigint
  • collected: bigint
  • id: string
  • userId: string

CycleInfo

CycleInfo: { currentCycleSecs: bigint; currentCycleStartDate: Date; cycleDurationSecs: bigint; nextCycleStartDate: Date }

Type declaration

  • currentCycleSecs: bigint
  • currentCycleStartDate: Date
  • cycleDurationSecs: bigint
  • nextCycleStartDate: Date

DripsHistoryStruct

DripsHistoryStruct: { dripsHash: PromiseOrValue<BytesLike>; maxEnd: PromiseOrValue<BigNumberish>; receivers: DripsReceiverStruct[]; updateTime: PromiseOrValue<BigNumberish> }

Type declaration

  • dripsHash: PromiseOrValue<BytesLike>
  • maxEnd: PromiseOrValue<BigNumberish>
  • receivers: DripsReceiverStruct[]
  • updateTime: PromiseOrValue<BigNumberish>

DripsReceiver

DripsReceiver: { config: DripsReceiverConfig; userId: string }

Type declaration

DripsReceiverConfig

DripsReceiverConfig: { amountPerSec: bigint; dripId: bigint; duration: bigint; start: bigint }

Type declaration

  • amountPerSec: bigint

    The amount per second being dripped. When setting a config, it must be in the smallest unit (e.g., Wei), greater than 0 and be multiplied by 10 ^ 9 (constants.AMT_PER_SEC_MULTIPLIER).

  • dripId: bigint

    An arbitrary number used to identify a drip. When setting a config, it must be greater than or equal to 0. It's a part of the configuration but the protocol doesn't use it.

  • duration: bigint

    The duration (in seconds) of dripping. When setting a config, it must be greater than or equal to 0. If set to 0, the contract will drip until the balance runs out.

  • start: bigint

    The UNIX timestamp (in seconds) when dripping should start. When setting a config, it must be greater than or equal to 0. If set to 0, the contract will use the timestamp when drips are configured.

DripsReceiverSeenEvent

DripsReceiverSeenEvent: { blockTimestamp: bigint; config: bigint; dripsSetEvent: { assetId: bigint; id: string; receiversHash: string }; id: string; receiverUserId: bigint; senderUserId: bigint }

Type declaration

  • blockTimestamp: bigint
  • config: bigint
  • dripsSetEvent: { assetId: bigint; id: string; receiversHash: string }
    • assetId: bigint
    • id: string
    • receiversHash: string
  • id: string
  • receiverUserId: bigint
  • senderUserId: bigint

DripsReceiverStruct

DripsReceiverStruct: { config: PromiseOrValue<BigNumberish>; userId: PromiseOrValue<BigNumberish> }

Type declaration

  • config: PromiseOrValue<BigNumberish>
  • userId: PromiseOrValue<BigNumberish>

DripsSetEvent

DripsSetEvent: { assetId: bigint; balance: bigint; blockTimestamp: bigint; dripsHistoryHash: string; dripsReceiverSeenEvents: { config: bigint; id: string; receiverUserId: string }[]; id: string; maxEnd: bigint; receiversHash: string; userId: string }

Type declaration

  • assetId: bigint
  • balance: bigint
  • blockTimestamp: bigint
  • dripsHistoryHash: string
  • dripsReceiverSeenEvents: { config: bigint; id: string; receiverUserId: string }[]
  • id: string
  • maxEnd: bigint
  • receiversHash: string
  • userId: string

DripsSetEventWithFullReceivers

DripsSetEventWithFullReceivers: { currentReceivers: { config: bigint; id: string; receiverUserId: string }[] } & DripsSetEvent

DripsState

DripsState: { balance: bigint; dripsHash: string; dripsHistoryHash: string; maxEnd: number; updateTime: number }

Type declaration

  • balance: bigint

    The balance when drips have been configured for the last time.

  • dripsHash: string

    The current drips receivers list hash.

  • dripsHistoryHash: string

    The current drips history hash.

  • maxEnd: number

    The current maximum end time of drips.

  • updateTime: number

    The time when drips have been configured for the last time.

GivenEvent

GivenEvent: { amount: bigint; assetId: bigint; blockTimestamp: bigint; id: string; receiverUserId: string; userId: string }

Type declaration

  • amount: bigint
  • assetId: bigint
  • blockTimestamp: bigint
  • id: string
  • receiverUserId: string
  • userId: string

NetworkConfig

NetworkConfig: { ADDRESS_DRIVER: string; ADDRESS_DRIVER_ADMIN: string; ADDRESS_DRIVER_ID: string; ADDRESS_DRIVER_LOGIC: string; CALLER: string; CHAIN: string; COMMIT_HASH: string; DEPLOYER: string; DEPLOYMENT_TIME: string; DRIPS_HUB: string; DRIPS_HUB_ADMIN: string; DRIPS_HUB_CYCLE_SECONDS: string; DRIPS_HUB_LOGIC: string; IMMUTABLE_SPLITS_DRIVER: string; IMMUTABLE_SPLITS_DRIVER_ADMIN: string; IMMUTABLE_SPLITS_DRIVER_ID: string; IMMUTABLE_SPLITS_DRIVER_LOGIC: string; NFT_DRIVER: string; NFT_DRIVER_ADMIN: string; NFT_DRIVER_ID: string; NFT_DRIVER_LOGIC: string; SUBGRAPH_URL: string; WALLET: string; WALLET_NONCE: string }

Type declaration

  • ADDRESS_DRIVER: string
  • ADDRESS_DRIVER_ADMIN: string
  • ADDRESS_DRIVER_ID: string
  • ADDRESS_DRIVER_LOGIC: string
  • CALLER: string
  • CHAIN: string
  • COMMIT_HASH: string
  • DEPLOYER: string
  • DEPLOYMENT_TIME: string
  • DRIPS_HUB: string
  • DRIPS_HUB_ADMIN: string
  • DRIPS_HUB_CYCLE_SECONDS: string
  • DRIPS_HUB_LOGIC: string
  • IMMUTABLE_SPLITS_DRIVER: string
  • IMMUTABLE_SPLITS_DRIVER_ADMIN: string
  • IMMUTABLE_SPLITS_DRIVER_ID: string
  • IMMUTABLE_SPLITS_DRIVER_LOGIC: string
  • NFT_DRIVER: string
  • NFT_DRIVER_ADMIN: string
  • NFT_DRIVER_ID: string
  • NFT_DRIVER_LOGIC: string
  • SUBGRAPH_URL: string
  • WALLET: string
  • WALLET_NONCE: string

NftSubAccount

NftSubAccount: { ownerAddress: string; tokenId: string }

Type declaration

  • ownerAddress: string
  • tokenId: string

Preset

Preset: PopulatedTransaction[]

ReceivableBalance

ReceivableBalance: { receivableAmount: bigint; tokenAddress: string }

Type declaration

  • receivableAmount: bigint

    The amount which would be received.

  • tokenAddress: string

    The token address.

ReceivedDripsEvent

ReceivedDripsEvent: { amount: bigint; assetId: bigint; blockTimestamp: bigint; id: string; receivableCycles: bigint; userId: string }

Type declaration

  • amount: bigint
  • assetId: bigint
  • blockTimestamp: bigint
  • id: string
  • receivableCycles: bigint
  • userId: string

SplitEvent

SplitEvent: { amount: bigint; assetId: bigint; blockTimestamp: bigint; id: string; receiverId: string; userId: string }

Type declaration

  • amount: bigint
  • assetId: bigint
  • blockTimestamp: bigint
  • id: string
  • receiverId: string
  • userId: string

SplitResult

SplitResult: { collectableAmount: bigint; splitAmount: bigint }

Type declaration

  • collectableAmount: bigint

    The amount made collectable for the user on top of what was collectable before.

  • splitAmount: bigint

    The amount split to the user's splits receivers.

SplitsEntry

SplitsEntry: { id: string; senderId: string; userId: string; weight: bigint }

Type declaration

  • id: string
  • senderId: string
  • userId: string
  • weight: bigint

SplitsReceiverStruct

SplitsReceiverStruct: { userId: PromiseOrValue<BigNumberish>; weight: PromiseOrValue<BigNumberish> }

Type declaration

  • userId: PromiseOrValue<BigNumberish>
  • weight: PromiseOrValue<BigNumberish>

SplittableBalance

SplittableBalance: { splittableAmount: bigint; tokenAddress: string }

Type declaration

  • splittableAmount: bigint

    The amount which would be splitted.

  • tokenAddress: string

    The token address.

SqueezeArgs

SqueezeArgs: { dripsHistory: DripsHistoryStruct[]; historyHash: string; senderId: string; tokenAddress: string; userId: string }

Type declaration

  • dripsHistory: DripsHistoryStruct[]
  • historyHash: string
  • senderId: string
  • tokenAddress: string
  • userId: string

SqueezedDripsEvent

SqueezedDripsEvent: { amount: bigint; assetId: bigint; blockTimestamp: bigint; dripsHistoryHashes: string[]; id: string; senderId: string; userId: string }

Type declaration

  • amount: bigint
  • assetId: bigint
  • blockTimestamp: bigint
  • dripsHistoryHashes: string[]
  • id: string
  • senderId: string
  • userId: string

UserAssetConfig

UserAssetConfig: { amountCollected: bigint; assetId: bigint; balance: bigint; dripsEntries: { config: bigint; id: string; userId: string }[]; id: string; lastUpdatedBlockTimestamp: bigint }

Type declaration

  • amountCollected: bigint
  • assetId: bigint
  • balance: bigint
  • dripsEntries: { config: bigint; id: string; userId: string }[]
  • id: string
  • lastUpdatedBlockTimestamp: bigint

UserMetadata

UserMetadata: { key: string; value: string }

Type declaration

  • key: string
  • value: string

UserMetadataEntry

UserMetadataEntry: { id: string; key: string; lastUpdatedBlockTimestamp: bigint; userId: string; value: string }

Type declaration

  • id: string
  • key: string
  • lastUpdatedBlockTimestamp: bigint
  • userId: string
  • value: string

UserMetadataStruct

UserMetadataStruct: { key: PromiseOrValue<BytesLike>; value: PromiseOrValue<BytesLike> }

Type declaration

  • key: PromiseOrValue<BytesLike>
  • value: PromiseOrValue<BytesLike>

Variables

Const constants

constants: { AMT_PER_SEC_EXTRA_DECIMALS: number; AMT_PER_SEC_MULTIPLIER: number; ASSOCIATED_APP_KEY: string; ASSOCIATED_APP_KEY_BYTES: string; MAX_DRIPS_RECEIVERS: number; MAX_SPLITS_RECEIVERS: number; TOTAL_SPLITS_WEIGHT: number } = ...

Type declaration

  • AMT_PER_SEC_EXTRA_DECIMALS: number
  • AMT_PER_SEC_MULTIPLIER: number
  • ASSOCIATED_APP_KEY: string
  • ASSOCIATED_APP_KEY_BYTES: string
  • MAX_DRIPS_RECEIVERS: number
  • MAX_SPLITS_RECEIVERS: number
  • TOTAL_SPLITS_WEIGHT: number

Generated using TypeDoc