On-Ramp / Off-Ramp

packages/contracts-evm/contracts/
├── ramp/
│   └── RampSettlement.sol
└── factory/
    └── RampSettlementFactory.sol

packages/sdk/src/
├── core/
│   └── RampManager.ts
└── providers/
    └── ManualRampProvider.ts

function initiateOffRamp(bytes32 referenceId, address token, uint256 amount, string calldata providerRef) external;
function confirmOffRampSettlement(bytes32 referenceId) external; // SETTLER_ROLE
function refundOffRamp(bytes32 referenceId) external;             // MANAGER_ROLE

function recordOnRampSettlement(
    bytes32 referenceId, address recipient, address token, uint256 amount, string calldata providerRef
) external; // SETTLER_ROLE

enum SettlementStatus { NONE, PENDING, SETTLED, REFUNDED, RECORDED }

struct OffRampDeposit { address depositor; address token; uint256 amount; SettlementStatus status; uint256 initiatedAt; }
struct OnRampRecord   { address recipient; address token; uint256 amount; SettlementStatus status; uint256 recordedAt; }

function getOffRamp(bytes32 referenceId) external view returns (OffRampDeposit memory);
function getOnRamp(bytes32 referenceId) external view returns (OnRampRecord memory);

address public implementation;

function setImplementation(address newImplementation) external onlyOwner;
function deployRampSettlement(address admin_, address treasury_) external payable returns (address);

event RampSettlementDeployed(
    address indexed settlementAddress,
    address indexed deployer,
    address admin,
    address treasury,
    uint256 timestamp
);

interface RampProvider {
  readonly name: string;
  getQuote(input: RampQuoteInput): Promise<RampQuote>;
  initiateOnRamp(input: InitiateOnRampInput): Promise<RampSession>;
  initiateOffRamp(input: InitiateOffRampInput): Promise<RampSession>;
  getStatus(sessionId: string): Promise<RampSessionStatus>;
}

import { RampManager, ManualRampProvider, EVMAdapter } from "@ankarachain/sdk";

// Off-chain only (no settlement contract configured):
const ramp = new RampManager(new ManualRampProvider());

const quote   = await ramp.getQuote({
  direction: "off-ramp", fiatCurrency: "NGN", tokenSymbol: "mUSD", countryCode: "NG", tokenAmount: "100",
});
const session = await ramp.initiateOffRamp({
  tokenAmount: "100", tokenSymbol: "mUSD", fiatCurrency: "NGN", countryCode: "NG",
  payoutAccount: { type: "bank", accountNumber: "0123456789", bankCode: "058" },
});

const ramp = new RampManager(new ManualRampProvider(), adapter, {
  settlementAddress: "0xYourRampSettlement",
});

// caller approves the settlement contract to spend `tokenAmount` first, then:
await ramp.depositOffRamp(session.sessionId, tokenAddress, ethers.parseEther("100"));

// once the provider confirms the fiat payout succeeded:
await ramp.confirmOffRampSettlement(session.sessionId);

// or, if it failed:
await ramp.refundOffRamp(session.sessionId);

await ramp.recordOnRampSettlement(session.sessionId, recipientAddress, tokenAddress, mintedAmount);

cd packages/contracts-evm
npm run test -- --grep "Ramp"

cd packages/sdk
npm run test -- RampManager ManualRampProvider