@d20dao/vrf-sdk 0.1.1 → 0.2.0

package/contracts/interfaces/ID20VRF.sol

@@ -4,7 +4,11 @@ pragma solidity 0.8.28;
 import {RandomnessMapping} from "../libraries/RandomnessMapping.sol";
 
 interface ID20VRF {
-    function requestFee() external view returns (uint256);
+    /// @notice Exact fee for a request sent in this same transaction. Through eth_call the base fee is often reported as 0,
+    ///         so off-chain senders must quote with quoteFeeAt and the latest header baseFeePerGas plus a buffer.
+    function quoteFee(uint32 callbackGasLimit) external view returns (uint256);
+    /// @notice max(minFee, feeMultiplier * baseFee * (fulfillGasOverhead + callbackGasLimit)) over the current parameters.
+    function quoteFeeAt(uint32 callbackGasLimit, uint256 baseFee) external view returns (uint256);
     function requestRandomness(bytes32 clientSeed, uint32 callbackGasLimit, address _refundAddress)
         external payable returns (uint256 requestId);
     function requestMappedRandomness(

package/contracts/libraries/D20VRFRequests.sol

@@ -6,6 +6,7 @@ import {RandomnessMapping as M} from "./RandomnessMapping.sol";
 
 /// @notice Built-in request helpers for game contracts. All requests still callback with (id, rawWord).
 /// @dev Usage: using D20VRFRequests for ID20VRF; rng.d20(options). Inspect getMappedResult(id) after fulfillment.
+///      Each helper pays the exact same-transaction quote from the calling contract balance.
 library D20VRFRequests {
     struct Options { bytes32 clientSeed; uint32 callbackGasLimit; address refundAddress; }
     function diceRoll(ID20VRF rng, uint256 sides, uint32 count, Options memory o) internal returns (uint256) {
@@ -36,6 +37,6 @@ library D20VRFRequests {
         return _send(rng, M.Spec(M.Operation.Shuffle, 0, 0, population, population), o);
     }
     function _send(ID20VRF rng, M.Spec memory spec, Options memory o) private returns (uint256) {
-        return rng.requestMappedRandomness{value: rng.requestFee()}(o.clientSeed, o.callbackGasLimit, o.refundAddress, spec);
+        return rng.requestMappedRandomness{value: rng.quoteFee(o.callbackGasLimit)}(o.clientSeed, o.callbackGasLimit, o.refundAddress, spec);
     }
 }

package/dist/abi.d.ts

@@ -50,6 +50,10 @@ export declare const coordinatorAbi: readonly [{
     readonly inputs: readonly [];
     readonly name: "FailedCall";
     readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "FeeOverflow";
+    readonly type: "error";
 }, {
     readonly inputs: readonly [{
         readonly internalType: "uint256";
@@ -66,6 +70,10 @@ export declare const coordinatorAbi: readonly [{
     readonly inputs: readonly [];
     readonly name: "InsufficientCallbackGas";
     readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "InvalidBatch";
+    readonly type: "error";
 }, {
     readonly inputs: readonly [];
     readonly name: "InvalidCallbackGas";
@@ -150,6 +158,10 @@ export declare const coordinatorAbi: readonly [{
     readonly inputs: readonly [];
     readonly name: "RefundNotAvailable";
     readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "RenounceDisabled";
+    readonly type: "error";
 }, {
     readonly inputs: readonly [];
     readonly name: "RequestExpired";
@@ -226,6 +238,26 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly name: "CallbackAttempted";
     readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "uint256";
+        readonly name: "requestId";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "refundAddress";
+        readonly type: "address";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "FeeOverpaymentCredited";
+    readonly type: "event";
 }, {
     readonly anonymous: false;
     readonly inputs: readonly [{
@@ -276,6 +308,21 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly name: "FulfillmentEvidence";
     readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "uint256";
+        readonly name: "requestId";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint8";
+        readonly name: "reason";
+        readonly type: "uint8";
+    }];
+    readonly name: "FulfillmentSkipped";
+    readonly type: "event";
 }, {
     readonly anonymous: false;
     readonly inputs: readonly [{
@@ -417,6 +464,26 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly name: "OwnershipTransferred";
     readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: false;
+        readonly internalType: "uint256";
+        readonly name: "minFee";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint16";
+        readonly name: "feeMultiplier";
+        readonly type: "uint16";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint32";
+        readonly name: "fulfillGasOverhead";
+        readonly type: "uint32";
+    }];
+    readonly name: "PricingChanged";
+    readonly type: "event";
 }, {
     readonly anonymous: false;
     readonly inputs: readonly [{
@@ -512,6 +579,21 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly name: "RandomnessRequested";
     readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: false;
+        readonly internalType: "uint16";
+        readonly name: "previousBps";
+        readonly type: "uint16";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "uint16";
+        readonly name: "newBps";
+        readonly type: "uint16";
+    }];
+    readonly name: "RefundBpsChanged";
+    readonly type: "event";
 }, {
     readonly anonymous: false;
     readonly inputs: readonly [{
@@ -637,6 +719,46 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly stateMutability: "view";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "MAX_FEE_MULTIPLIER";
+    readonly outputs: readonly [{
+        readonly internalType: "uint16";
+        readonly name: "";
+        readonly type: "uint16";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "MAX_FULFILL_BATCH";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "MAX_FULFILL_GAS_OVERHEAD";
+    readonly outputs: readonly [{
+        readonly internalType: "uint32";
+        readonly name: "";
+        readonly type: "uint32";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "MAX_MIN_FEE";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [];
     readonly name: "MIN_CALLBACK_GAS";
@@ -647,6 +769,26 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly stateMutability: "view";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "MIN_FULFILL_GAS_OVERHEAD";
+    readonly outputs: readonly [{
+        readonly internalType: "uint32";
+        readonly name: "";
+        readonly type: "uint32";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "MIN_REFUND_BPS";
+    readonly outputs: readonly [{
+        readonly internalType: "uint16";
+        readonly name: "";
+        readonly type: "uint16";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [];
     readonly name: "REFUND_CALLBACK_GAS";
@@ -733,6 +875,16 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly stateMutability: "view";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "feeMultiplier";
+    readonly outputs: readonly [{
+        readonly internalType: "uint16";
+        readonly name: "";
+        readonly type: "uint16";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [];
     readonly name: "feeRecipient";
@@ -743,6 +895,16 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly stateMutability: "view";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "fulfillGasOverhead";
+    readonly outputs: readonly [{
+        readonly internalType: "uint32";
+        readonly name: "";
+        readonly type: "uint32";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [{
         readonly internalType: "uint256";
@@ -794,6 +956,57 @@ export declare const coordinatorAbi: readonly [{
     readonly outputs: readonly [];
     readonly stateMutability: "nonpayable";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint256[]";
+        readonly name: "ids";
+        readonly type: "uint256[]";
+    }, {
+        readonly components: readonly [{
+            readonly internalType: "uint256[2]";
+            readonly name: "pk";
+            readonly type: "uint256[2]";
+        }, {
+            readonly internalType: "uint256[2]";
+            readonly name: "gamma";
+            readonly type: "uint256[2]";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "c";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "s";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "seed";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "address";
+            readonly name: "uWitness";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint256[2]";
+            readonly name: "cGammaWitness";
+            readonly type: "uint256[2]";
+        }, {
+            readonly internalType: "uint256[2]";
+            readonly name: "sHashWitness";
+            readonly type: "uint256[2]";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "zInv";
+            readonly type: "uint256";
+        }];
+        readonly internalType: "struct VRF.Proof[]";
+        readonly name: "proofs";
+        readonly type: "tuple[]";
+    }];
+    readonly name: "fulfillRandomnessBatch";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [{
         readonly internalType: "uint256";
@@ -984,6 +1197,16 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly stateMutability: "view";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "initialMinFee";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [{
         readonly internalType: "uint256[2]";
@@ -1111,6 +1334,16 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly stateMutability: "pure";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "minFee";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [];
     readonly name: "nextRequestId";
@@ -1141,6 +1374,24 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly stateMutability: "view";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "pricing";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint16";
+        readonly name: "";
+        readonly type: "uint16";
+    }, {
+        readonly internalType: "uint32";
+        readonly name: "";
+        readonly type: "uint32";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [];
     readonly name: "protocolConfigurationHash";
@@ -1181,6 +1432,48 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly stateMutability: "view";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint32";
+        readonly name: "callbackGasLimit";
+        readonly type: "uint32";
+    }];
+    readonly name: "quoteFee";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint32";
+        readonly name: "callbackGasLimit";
+        readonly type: "uint32";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "baseFee";
+        readonly type: "uint256";
+    }];
+    readonly name: "quoteFeeAt";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "refundBps";
+    readonly outputs: readonly [{
+        readonly internalType: "uint16";
+        readonly name: "";
+        readonly type: "uint16";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [{
         readonly internalType: "uint256";
@@ -1223,11 +1516,15 @@ export declare const coordinatorAbi: readonly [{
     readonly inputs: readonly [];
     readonly name: "renounceOwnership";
     readonly outputs: readonly [];
-    readonly stateMutability: "nonpayable";
+    readonly stateMutability: "view";
     readonly type: "function";
 }, {
-    readonly inputs: readonly [];
-    readonly name: "requestFee";
+    readonly inputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "requestId";
+        readonly type: "uint256";
+    }];
+    readonly name: "requestFeePaid";
     readonly outputs: readonly [{
         readonly internalType: "uint256";
         readonly name: "";
@@ -1304,6 +1601,20 @@ export declare const coordinatorAbi: readonly [{
     }];
     readonly stateMutability: "payable";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "requestId";
+        readonly type: "uint256";
+    }];
+    readonly name: "requestRefundBps";
+    readonly outputs: readonly [{
+        readonly internalType: "uint16";
+        readonly name: "";
+        readonly type: "uint16";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [{
         readonly internalType: "uint256";
@@ -1380,6 +1691,34 @@ export declare const coordinatorAbi: readonly [{
     readonly outputs: readonly [];
     readonly stateMutability: "nonpayable";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "nextMinFee";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint16";
+        readonly name: "multiplier";
+        readonly type: "uint16";
+    }, {
+        readonly internalType: "uint32";
+        readonly name: "overhead";
+        readonly type: "uint32";
+    }];
+    readonly name: "setPricing";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint16";
+        readonly name: "next";
+        readonly type: "uint16";
+    }];
+    readonly name: "setRefundBps";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [{
         readonly internalType: "uint256";
@@ -1636,6 +1975,10 @@ export declare const epochEntropyAbi: readonly [{
     readonly inputs: readonly [];
     readonly name: "PreparationClosed";
     readonly type: "error";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "RenounceDisabled";
+    readonly type: "error";
 }, {
     readonly inputs: readonly [];
     readonly name: "UUPSUnauthorizedCallContext";
@@ -1648,6 +1991,26 @@ export declare const epochEntropyAbi: readonly [{
     }];
     readonly name: "UUPSUnsupportedProxiableUUID";
     readonly type: "error";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "uint64";
+        readonly name: "fromEpoch";
+        readonly type: "uint64";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "bytes32";
+        readonly name: "catalogHash";
+        readonly type: "bytes32";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "address[4]";
+        readonly name: "signers";
+        readonly type: "address[4]";
+    }];
+    readonly name: "CatalogScheduled";
+    readonly type: "event";
 }, {
     readonly anonymous: false;
     readonly inputs: readonly [{
@@ -1753,6 +2116,16 @@ export declare const epochEntropyAbi: readonly [{
     }];
     readonly stateMutability: "view";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "MAX_ATTESTATION_AGE";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [];
     readonly name: "MAX_PACKET_BYTES";
@@ -1829,6 +2202,20 @@ export declare const epochEntropyAbi: readonly [{
     }];
     readonly stateMutability: "view";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint64";
+        readonly name: "epochId";
+        readonly type: "uint64";
+    }];
+    readonly name: "catalogHashAt";
+    readonly outputs: readonly [{
+        readonly internalType: "bytes32";
+        readonly name: "hash";
+        readonly type: "bytes32";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [{
         readonly internalType: "uint64";
@@ -2104,6 +2491,20 @@ export declare const epochEntropyAbi: readonly [{
     readonly inputs: readonly [];
     readonly name: "renounceOwnership";
     readonly outputs: readonly [];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address[4]";
+        readonly name: "signers";
+        readonly type: "address[4]";
+    }, {
+        readonly internalType: "uint64";
+        readonly name: "fromEpoch";
+        readonly type: "uint64";
+    }];
+    readonly name: "scheduleCatalog";
+    readonly outputs: readonly [];
     readonly stateMutability: "nonpayable";
     readonly type: "function";
 }, {
@@ -2116,6 +2517,20 @@ export declare const epochEntropyAbi: readonly [{
     readonly outputs: readonly [];
     readonly stateMutability: "nonpayable";
     readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint64";
+        readonly name: "epochId";
+        readonly type: "uint64";
+    }];
+    readonly name: "signersAt";
+    readonly outputs: readonly [{
+        readonly internalType: "address[4]";
+        readonly name: "signers";
+        readonly type: "address[4]";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
 }, {
     readonly inputs: readonly [{
         readonly internalType: "address";