Skip to content

Document DeliveryProtectionOperator preset exports #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document DeliveryProtectionOperator preset exports #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 65 additions & 8 deletions sdk/deploy-operator.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ console.log('Existing (reused):', result.summary.existingCount)
| `escrowPeriodSeconds` | `bigint` | Escrow waiting period (e.g., `604800n` for 7 days) |
| `freezeDurationSeconds` | `bigint` | How long freezes last. Default: `0n` (permanent until unfrozen) |
| `operatorFeeBps` | `bigint` | Fee in basis points. Default: `0n` (no fee). `100n` = 1% |
| `authorizedCodehash` | `Hex` | Optional. Restricts which contract codehashes can record. Defaults to `bytes32(0)` (no restriction) |

<AccordionGroup>
<Accordion title="Deployment Result Type">
Expand Down Expand Up @@ -120,8 +121,23 @@ Deployment requires gas fees. Ensure your wallet has ETH on the target network.
For automated quality verification (AI garbage detection, schema validation), use the simpler delivery protection preset. No RefundRequest, Evidence, or Freeze contracts. The arbiter is the only address that can release funds.

```typescript
import { createPublicClient, createWalletClient, http } from 'viem';
import { baseSepolia } from 'viem/chains';
import { privateKeyToAccount } from 'viem/accounts';
import { deployDeliveryProtectionOperator } from '@x402r/core'

const publicClient = createPublicClient({
chain: baseSepolia,
transport: http(),
})

const account = privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`)
const walletClient = createWalletClient({
account,
chain: baseSepolia,
transport: http(),
})

const deployment = await deployDeliveryProtectionOperator(
walletClient,
publicClient,
Expand All @@ -144,15 +160,56 @@ console.log('ArbiterCondition:', deployment.arbiterConditionAddress)
| `arbiter` | `Address` | Only address that can call `release()` |
| `feeRecipient` | `Address` | Receives protocol fees |
| `escrowPeriodSeconds` | `bigint` | Verification window before auto-refund |
| `authorizedCodehash` | `Hex` | Optional. Restricts which contract codehashes can record. Defaults to `bytes32(0)` (no restriction) |

<Accordion title="Delivery Protection Slot Configuration">
| Slot | Contract | Purpose |
|------|----------|---------|
| `RELEASE_CONDITION` | StaticAddressCondition(arbiter) | Only arbiter can release |
| `AUTHORIZE_RECORDER` | EscrowPeriod | Records authorization time |
| `REFUND_IN_ESCROW_CONDITION` | EscrowPeriod | Anyone can refund after escrow expires |
| `REFUND_POST_ESCROW_CONDITION` | Receiver | Receiver can refund post-escrow |
</Accordion>
<AccordionGroup>
<Accordion title="Deployment Result Type">
```typescript
interface DeliveryProtectionOperatorDeployment {
operatorAddress: Address
escrowPeriodAddress: Address
arbiterConditionAddress: Address
operatorConfig: OperatorConfig
deployments: DeployResult[]
summary: {
newCount: number
existingCount: number
txHashes: `0x${string}`[]
}
}
```

Redeploying with the same parameters is idempotent (CREATE3). It detects existing contracts and skips them. Check `summary` for what was new vs reused.
</Accordion>

<Accordion title="Preview Addresses (No Deploy)">
Compute addresses without deploying:

```typescript
import { previewDeliveryProtectionOperator } from '@x402r/core'

const preview = await previewDeliveryProtectionOperator(publicClient, {
chainId: 84532,
arbiter: '0xArbiterServiceAddress',
feeRecipient: '0xYourAddress...',
escrowPeriodSeconds: 300n,
})

console.log('Operator will be at:', preview.operatorAddress)
console.log('EscrowPeriod will be at:', preview.escrowPeriodAddress)
console.log('ArbiterCondition will be at:', preview.arbiterConditionAddress)
```
</Accordion>

<Accordion title="Delivery Protection Slot Configuration">
| Slot | Contract | Purpose |
|------|----------|---------|
| `RELEASE_CONDITION` | StaticAddressCondition(arbiter) | Only arbiter can release |
| `AUTHORIZE_RECORDER` | EscrowPeriod | Records authorization time |
| `REFUND_IN_ESCROW_CONDITION` | EscrowPeriod | Anyone can refund after escrow expires |
| `REFUND_POST_ESCROW_CONDITION` | Receiver | Receiver can refund post-escrow |
</Accordion>
</AccordionGroup>

## Next Steps

Expand Down
Loading