@obolnetwork/obol-sdk 2.0.1 → 2.1.1

package/README.md

@@ -11,6 +11,12 @@ Checkout our [docs](https://docs.obol.org/docs/advanced/quickstart-sdk), [exampl
 ## Terms and Conditions
 To use obol-sdk and in order to be able to create a cluster definition or accept an invite to join a cluster, you must accept the [latest Obol terms and conditions](https://obol.org/terms.pdf) by calling acceptObolLatestTermsAndConditions.
 
+## ⚠️ Important Security Notice:
+If you're integrating this SDK with a **backend** (e.g., in Node.js), and you store a private key for executing splitter transactions, handle it with extreme caution. Ensure that:
+
+- The private key is securely stored (e.g., in an `.env` file).
+- Never commit or push your `.env` file containing the private key to version control.
+
 ## Contributing
 
 Please review the following guidelines:

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@obolnetwork/obol-sdk",
-    "version": "2.0.1",
+    "version": "2.1.1",
     "description": "A package for creating Distributed Validators using the Obol API.",
     "bugs": {
         "url": "https://github.com/obolnetwork/obol-sdk/issues"

package/dist/cjs/src/abi/Multicall.js

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiCallContract = void 0;
+exports.MultiCallContract = {
+    abi: [
+        {
+            constant: true,
+            inputs: [],
+            name: 'getCurrentBlockTimestamp',
+            outputs: [
+                {
+                    name: 'timestamp',
+                    type: 'uint256',
+                },
+            ],
+            payable: false,
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            constant: false,
+            inputs: [
+                {
+                    components: [
+                        {
+                            name: 'target',
+                            type: 'address',
+                        },
+                        {
+                            name: 'callData',
+                            type: 'bytes',
+                        },
+                    ],
+                    name: 'calls',
+                    type: 'tuple[]',
+                },
+            ],
+            name: 'aggregate',
+            outputs: [
+                {
+                    name: 'blockNumber',
+                    type: 'uint256',
+                },
+                {
+                    name: 'returnData',
+                    type: 'bytes[]',
+                },
+            ],
+            payable: false,
+            stateMutability: 'nonpayable',
+            type: 'function',
+        },
+        {
+            constant: true,
+            inputs: [],
+            name: 'getLastBlockHash',
+            outputs: [
+                {
+                    name: 'blockHash',
+                    type: 'bytes32',
+                },
+            ],
+            payable: false,
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            constant: true,
+            inputs: [
+                {
+                    name: 'addr',
+                    type: 'address',
+                },
+            ],
+            name: 'getEthBalance',
+            outputs: [
+                {
+                    name: 'balance',
+                    type: 'uint256',
+                },
+            ],
+            payable: false,
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            constant: true,
+            inputs: [],
+            name: 'getCurrentBlockDifficulty',
+            outputs: [
+                {
+                    name: 'difficulty',
+                    type: 'uint256',
+                },
+            ],
+            payable: false,
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            constant: true,
+            inputs: [],
+            name: 'getCurrentBlockGasLimit',
+            outputs: [
+                {
+                    name: 'gaslimit',
+                    type: 'uint256',
+                },
+            ],
+            payable: false,
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            constant: true,
+            inputs: [],
+            name: 'getCurrentBlockCoinbase',
+            outputs: [
+                {
+                    name: 'coinbase',
+                    type: 'address',
+                },
+            ],
+            payable: false,
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            constant: true,
+            inputs: [
+                {
+                    name: 'blockNumber',
+                    type: 'uint256',
+                },
+            ],
+            name: 'getBlockHash',
+            outputs: [
+                {
+                    name: 'blockHash',
+                    type: 'bytes32',
+                },
+            ],
+            payable: false,
+            stateMutability: 'view',
+            type: 'function',
+        },
+    ],
+};

package/dist/cjs/src/abi/OWR.js

@@ -0,0 +1,304 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OWRContract = exports.OWRFactoryContract = void 0;
+exports.OWRFactoryContract = {
+    abi: [
+        {
+            inputs: [
+                {
+                    internalType: 'string',
+                    name: '_ensName',
+                    type: 'string',
+                },
+                {
+                    internalType: 'address',
+                    name: '_ensReverseRegistrar',
+                    type: 'address',
+                },
+                {
+                    internalType: 'address',
+                    name: '_ensOwner',
+                    type: 'address',
+                },
+            ],
+            stateMutability: 'nonpayable',
+            type: 'constructor',
+        },
+        {
+            inputs: [],
+            name: 'Invalid__Recipients',
+            type: 'error',
+        },
+        {
+            inputs: [
+                {
+                    internalType: 'uint256',
+                    name: 'threshold',
+                    type: 'uint256',
+                },
+            ],
+            name: 'Invalid__ThresholdTooLarge',
+            type: 'error',
+        },
+        {
+            inputs: [],
+            name: 'Invalid__ZeroThreshold',
+            type: 'error',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: true,
+                    internalType: 'address',
+                    name: 'owr',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'address',
+                    name: 'recoveryAddress',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'address',
+                    name: 'principalRecipient',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'address',
+                    name: 'rewardRecipient',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'threshold',
+                    type: 'uint256',
+                },
+            ],
+            name: 'CreateOWRecipient',
+            type: 'event',
+        },
+        {
+            inputs: [
+                {
+                    internalType: 'address',
+                    name: 'recoveryAddress',
+                    type: 'address',
+                },
+                {
+                    internalType: 'address',
+                    name: 'principalRecipient',
+                    type: 'address',
+                },
+                {
+                    internalType: 'address',
+                    name: 'rewardRecipient',
+                    type: 'address',
+                },
+                {
+                    internalType: 'uint256',
+                    name: 'amountOfPrincipalStake',
+                    type: 'uint256',
+                },
+            ],
+            name: 'createOWRecipient',
+            outputs: [
+                {
+                    internalType: 'contract OptimisticWithdrawalRecipient',
+                    name: 'owr',
+                    type: 'address',
+                },
+            ],
+            stateMutability: 'nonpayable',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'owrImpl',
+            outputs: [
+                {
+                    internalType: 'contract OptimisticWithdrawalRecipient',
+                    name: '',
+                    type: 'address',
+                },
+            ],
+            stateMutability: 'view',
+            type: 'function',
+        },
+    ],
+};
+exports.OWRContract = {
+    abi: [
+        { inputs: [], stateMutability: 'nonpayable', type: 'constructor' },
+        { inputs: [], name: 'InvalidDistribution_TooLarge', type: 'error' },
+        {
+            inputs: [],
+            name: 'InvalidTokenRecovery_InvalidRecipient',
+            type: 'error',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'principalPayout',
+                    type: 'uint256',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'rewardPayout',
+                    type: 'uint256',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'pullFlowFlag',
+                    type: 'uint256',
+                },
+            ],
+            name: 'DistributeFunds',
+            type: 'event',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'amount',
+                    type: 'uint256',
+                },
+            ],
+            name: 'ReceiveETH',
+            type: 'event',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: false,
+                    internalType: 'address',
+                    name: 'recoveryAddressToken',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'address',
+                    name: 'recipient',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'amount',
+                    type: 'uint256',
+                },
+            ],
+            name: 'RecoverNonOWRecipientFunds',
+            type: 'event',
+        },
+        {
+            anonymous: false,
+            inputs: [
+                {
+                    indexed: false,
+                    internalType: 'address',
+                    name: 'account',
+                    type: 'address',
+                },
+                {
+                    indexed: false,
+                    internalType: 'uint256',
+                    name: 'amount',
+                    type: 'uint256',
+                },
+            ],
+            name: 'Withdrawal',
+            type: 'event',
+        },
+        {
+            inputs: [],
+            name: 'claimedPrincipalFunds',
+            outputs: [{ internalType: 'uint128', name: '', type: 'uint128' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'distributeFunds',
+            outputs: [],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'distributeFundsPull',
+            outputs: [],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'fundsPendingWithdrawal',
+            outputs: [{ internalType: 'uint128', name: '', type: 'uint128' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [{ internalType: 'address', name: 'account', type: 'address' }],
+            name: 'getPullBalance',
+            outputs: [{ internalType: 'uint256', name: '', type: 'uint256' }],
+            stateMutability: 'view',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'getTranches',
+            outputs: [
+                {
+                    internalType: 'address',
+                    name: 'principalRecipient',
+                    type: 'address',
+                },
+                { internalType: 'address', name: 'rewardRecipient', type: 'address' },
+                {
+                    internalType: 'uint256',
+                    name: 'amountOfPrincipalStake',
+                    type: 'uint256',
+                },
+            ],
+            stateMutability: 'pure',
+            type: 'function',
+        },
+        {
+            inputs: [
+                { internalType: 'address', name: 'nonOWRToken', type: 'address' },
+                { internalType: 'address', name: 'recipient', type: 'address' },
+            ],
+            name: 'recoverFunds',
+            outputs: [],
+            stateMutability: 'payable',
+            type: 'function',
+        },
+        {
+            inputs: [],
+            name: 'recoveryAddress',
+            outputs: [{ internalType: 'address', name: '', type: 'address' }],
+            stateMutability: 'pure',
+            type: 'function',
+        },
+        {
+            inputs: [{ internalType: 'address', name: 'account', type: 'address' }],
+            name: 'withdraw',
+            outputs: [],
+            stateMutability: 'nonpayable',
+            type: 'function',
+        },
+    ],
+};