Aori is updating it’s API to support our upgraded and audited v2 settlement contract. Most of the changes to the API are small and migration should be relatively simple and non intrusive. Use this document as reference for updating your integration until the official Aori docs are completely updated.

Major Changes:

• Updated contract / zone addresses
• New SDK release version
• Updated API Endpoint URL’s
• Consolidation of API methods
• Simplification of AoriOrder object interface
• Standardization of Event Data Schema’s

Contents:

Endpoints / URLS:

New URL’s:

https://api.aori.io -

HTTP API to be able to send Requests statelessly, typically from end users.

wss://api.aori.io -

WebSocket API for market makers and solvers that want lower latency.

The primary Aori API endpoint url will be converted from rfq.aori.io to [api.aori.io](<http://api.aori.io>). Deployments of rfq.aori.io will remain live (but unmaintained) until all integrated parties have successfully migrated. A legacy version of the Aoriscan explorer will remain up at https://v1.aoriscan.io

If you’re using the aori sdk, you can also update your sdk version.

npm install @aori-io/[email protected]

Contract Changes:

New Zone Addresses:

*the latest zone address can always be obtained by using getDefaultZone() from the aori sdk

Key Changes:

• inputChainId & outputChainId condensed to chainId
• inputZone & outputZone condensed to zone
• addition of recipient : to specify a different address from offerer to receive the outputToken in the outputAmount
• addition of feeRecipient: to support distribution of a subsequent custom fee on top of baseFee to the specified feeRecipient for integrators with independent user bases looking to monetize their integration.

Interfaces:

<AoriOrder>:

Current (rfq.aori.io):

{
  "offerer": "0x..",
  "inputToken": "0x..",
  "inputAmount": 1000..,
  "inputChainId": 1,
  "inputZone": "0x..",
  "outputToken": "0x..",
  "outputAmount": 1000...,
  "outputChainId": 1,
  "outputZone": "0x..",
  "startTime": 1714857600,
  "endTime": 1714861200,
  "salt": 342515
  "counter": 0,
  "toWithdraw": false
}

New (api.aori.io):

{
  "offerer": "0x..",
  "chainId": 1,
  "zone": "0x..",
  "inputToken": "0x..",
  "inputAmount": 1000..,
  "outputToken": "0x..",
  "outputAmount": 1000...,
  "recipient": "0x..."
  "startTime": 1714857600,
  "endTime": 1714861200,
  "toWithdraw": true
}

*the AoriOrder type interface can be imported from the ts sdk

Changes:

• inputChainId & outputChainId condensed to chainId
• inputZone & outputZone condensed to zone
• addition of recipient : to specify a different address from offerer to receive the outputToken in the outputAmount
• removal of salt
• removal of counter

Methods:

New (api.aori.io):

Event Stream:

Subscribing to Events: