@trustline.id/web3sdk 1.0.0

package/artifacts/contracts/Trustlined.sol/Trustlined.dbg.json

@@ -0,0 +1,4 @@
+{
+  "_format": "hh-sol-dbg-1",
+  "buildInfo": "../../build-info/59243712b3c2b7c16f9bd43f3a3a6442.json"
+}

package/artifacts/contracts/Trustlined.sol/Trustlined.json

@@ -0,0 +1,24 @@
+{
+  "_format": "hh-sol-artifact-1",
+  "contractName": "Trustlined",
+  "sourceName": "contracts/Trustlined.sol",
+  "abi": [
+    {
+      "inputs": [],
+      "name": "validationEngine",
+      "outputs": [
+        {
+          "internalType": "contract IValidationEngine",
+          "name": "",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    }
+  ],
+  "bytecode": "0x",
+  "deployedBytecode": "0x",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}

package/artifacts/contracts/examples/PaymentFirewall.sol/PaymentFirewall.dbg.json

@@ -0,0 +1,4 @@
+{
+  "_format": "hh-sol-dbg-1",
+  "buildInfo": "../../../build-info/59243712b3c2b7c16f9bd43f3a3a6442.json"
+}

package/artifacts/contracts/examples/PaymentFirewall.sol/PaymentFirewall.json

@@ -0,0 +1,71 @@
+{
+  "_format": "hh-sol-artifact-1",
+  "contractName": "PaymentFirewall",
+  "sourceName": "contracts/examples/PaymentFirewall.sol",
+  "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "compliance",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "nonpayable",
+      "type": "constructor"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address payable",
+          "name": "destination",
+          "type": "address"
+        }
+      ],
+      "name": "payEthers",
+      "outputs": [],
+      "stateMutability": "payable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "destination",
+          "type": "address"
+        },
+        {
+          "internalType": "address",
+          "name": "token",
+          "type": "address"
+        },
+        {
+          "internalType": "uint256",
+          "name": "value",
+          "type": "uint256"
+        }
+      ],
+      "name": "payTokens",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "validationEngine",
+      "outputs": [
+        {
+          "internalType": "contract IValidationEngine",
+          "name": "",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    }
+  ],
+  "bytecode": "0x608060405234801561000f575f5ffd5b5060405161077f38038061077f83398101604081905261002e916100c8565b806100388161003f565b50506100f5565b6100488161004b565b50565b5f546001600160a01b0316156100a75760405162461bcd60e51b815260206004820152601360248201527f416c726561647920696e697469616c697a656400000000000000000000000000604482015260640160405180910390fd5b5f80546001600160a01b0319166001600160a01b0392909216919091179055565b5f602082840312156100d8575f5ffd5b81516001600160a01b03811681146100ee575f5ffd5b9392505050565b61067d806101025f395ff3fe608060405260043610610033575f3560e01c80632be277aa14610037578063666c6f23146100585780637d4f064e1461006b575b5f5ffd5b348015610042575f5ffd5b506100566100513660046104d0565b6100bf565b005b61005661006636600461050e565b610297565b348015610076575f5ffd5b505f546100969073ffffffffffffffffffffffffffffffffffffffff1681565b60405173ffffffffffffffffffffffffffffffffffffffff909116815260200160405180910390f35b6040805160028082526060820183525f9260208301908036833701905050905033815f815181106100f2576100f2610530565b602002602001019073ffffffffffffffffffffffffffffffffffffffff16908173ffffffffffffffffffffffffffffffffffffffff1681525050838160018151811061014057610140610530565b602002602001019073ffffffffffffffffffffffffffffffffffffffff16908173ffffffffffffffffffffffffffffffffffffffff168152505061018381610426565b6040517f23b872dd00000000000000000000000000000000000000000000000000000000815233600482015273ffffffffffffffffffffffffffffffffffffffff8581166024830152604482018490525f91908516906323b872dd906064016020604051808303815f875af11580156101fe573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190610222919061055d565b905080610290576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601460248201527f556e61626c6520746f2070617920746f6b656e7300000000000000000000000060448201526064015b60405180910390fd5b5050505050565b6040805160028082526060820183525f9260208301908036833701905050905033815f815181106102ca576102ca610530565b602002602001019073ffffffffffffffffffffffffffffffffffffffff16908173ffffffffffffffffffffffffffffffffffffffff1681525050818160018151811061031857610318610530565b602002602001019073ffffffffffffffffffffffffffffffffffffffff16908173ffffffffffffffffffffffffffffffffffffffff168152505061035b81610426565b5f8273ffffffffffffffffffffffffffffffffffffffff16346040515f6040518083038185875af1925050503d805f81146103b1576040519150601f19603f3d011682016040523d82523d5f602084013e6103b6565b606091505b5050905080610421576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601460248201527f556e61626c6520746f20706179206574686572730000000000000000000000006044820152606401610287565b505050565b5f80546040517f6cfd0c0900000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff90911691636cfd0c09916104839133913491903690889060040161057c565b5f604051808303815f87803b15801561049a575f5ffd5b505af1158015610290573d5f5f3e3d5ffd5b73ffffffffffffffffffffffffffffffffffffffff811681146104cd575f5ffd5b50565b5f5f5f606084860312156104e2575f5ffd5b83356104ed816104ac565b925060208401356104fd816104ac565b929592945050506040919091013590565b5f6020828403121561051e575f5ffd5b8135610529816104ac565b9392505050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52603260045260245ffd5b5f6020828403121561056d575f5ffd5b81518015158114610529575f5ffd5b73ffffffffffffffffffffffffffffffffffffffff8616815284602082015260806040820152826080820152828460a08301375f60a084830181018290527fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0601f86011683018381038201606085015284519181018290526020850191839160c001905b808310156106395773ffffffffffffffffffffffffffffffffffffffff8451168252602082019150602084019350600183019250610600565b50999850505050505050505056fea26469706673582212207bf43939de66cc895afaacb5acc69d3afba60d2e02439c0e400a199c197dabd264736f6c634300081c0033",
+  "deployedBytecode": "0x608060405260043610610033575f3560e01c80632be277aa14610037578063666c6f23146100585780637d4f064e1461006b575b5f5ffd5b348015610042575f5ffd5b506100566100513660046104d0565b6100bf565b005b61005661006636600461050e565b610297565b348015610076575f5ffd5b505f546100969073ffffffffffffffffffffffffffffffffffffffff1681565b60405173ffffffffffffffffffffffffffffffffffffffff909116815260200160405180910390f35b6040805160028082526060820183525f9260208301908036833701905050905033815f815181106100f2576100f2610530565b602002602001019073ffffffffffffffffffffffffffffffffffffffff16908173ffffffffffffffffffffffffffffffffffffffff1681525050838160018151811061014057610140610530565b602002602001019073ffffffffffffffffffffffffffffffffffffffff16908173ffffffffffffffffffffffffffffffffffffffff168152505061018381610426565b6040517f23b872dd00000000000000000000000000000000000000000000000000000000815233600482015273ffffffffffffffffffffffffffffffffffffffff8581166024830152604482018490525f91908516906323b872dd906064016020604051808303815f875af11580156101fe573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190610222919061055d565b905080610290576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601460248201527f556e61626c6520746f2070617920746f6b656e7300000000000000000000000060448201526064015b60405180910390fd5b5050505050565b6040805160028082526060820183525f9260208301908036833701905050905033815f815181106102ca576102ca610530565b602002602001019073ffffffffffffffffffffffffffffffffffffffff16908173ffffffffffffffffffffffffffffffffffffffff1681525050818160018151811061031857610318610530565b602002602001019073ffffffffffffffffffffffffffffffffffffffff16908173ffffffffffffffffffffffffffffffffffffffff168152505061035b81610426565b5f8273ffffffffffffffffffffffffffffffffffffffff16346040515f6040518083038185875af1925050503d805f81146103b1576040519150601f19603f3d011682016040523d82523d5f602084013e6103b6565b606091505b5050905080610421576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601460248201527f556e61626c6520746f20706179206574686572730000000000000000000000006044820152606401610287565b505050565b5f80546040517f6cfd0c0900000000000000000000000000000000000000000000000000000000815273ffffffffffffffffffffffffffffffffffffffff90911691636cfd0c09916104839133913491903690889060040161057c565b5f604051808303815f87803b15801561049a575f5ffd5b505af1158015610290573d5f5f3e3d5ffd5b73ffffffffffffffffffffffffffffffffffffffff811681146104cd575f5ffd5b50565b5f5f5f606084860312156104e2575f5ffd5b83356104ed816104ac565b925060208401356104fd816104ac565b929592945050506040919091013590565b5f6020828403121561051e575f5ffd5b8135610529816104ac565b9392505050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52603260045260245ffd5b5f6020828403121561056d575f5ffd5b81518015158114610529575f5ffd5b73ffffffffffffffffffffffffffffffffffffffff8616815284602082015260806040820152826080820152828460a08301375f60a084830181018290527fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0601f86011683018381038201606085015284519181018290526020850191839160c001905b808310156106395773ffffffffffffffffffffffffffffffffffffffff8451168252602082019150602084019350600183019250610600565b50999850505050505050505056fea26469706673582212207bf43939de66cc895afaacb5acc69d3afba60d2e02439c0e400a199c197dabd264736f6c634300081c0033",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}

package/artifacts/contracts/interfaces/IValidationEngine.sol/IValidationEngine.dbg.json

@@ -0,0 +1,4 @@
+{
+  "_format": "hh-sol-dbg-1",
+  "buildInfo": "../../../build-info/59243712b3c2b7c16f9bd43f3a3a6442.json"
+}

package/artifacts/contracts/interfaces/IValidationEngine.sol/IValidationEngine.json

@@ -0,0 +1,125 @@
+{
+  "_format": "hh-sol-artifact-1",
+  "contractName": "IValidationEngine",
+  "sourceName": "contracts/interfaces/IValidationEngine.sol",
+  "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "sender",
+          "type": "address"
+        },
+        {
+          "internalType": "uint256",
+          "name": "value",
+          "type": "uint256"
+        },
+        {
+          "internalType": "bytes",
+          "name": "data",
+          "type": "bytes"
+        }
+      ],
+      "name": "checkTrustlineStatus",
+      "outputs": [
+        {
+          "internalType": "bool",
+          "name": "",
+          "type": "bool"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "sender",
+          "type": "address"
+        },
+        {
+          "internalType": "uint256",
+          "name": "value",
+          "type": "uint256"
+        },
+        {
+          "internalType": "bytes",
+          "name": "data",
+          "type": "bytes"
+        },
+        {
+          "internalType": "address[]",
+          "name": "addresses",
+          "type": "address[]"
+        }
+      ],
+      "name": "checkTrustlineStatus",
+      "outputs": [
+        {
+          "internalType": "bool",
+          "name": "",
+          "type": "bool"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "sender",
+          "type": "address"
+        },
+        {
+          "internalType": "uint256",
+          "name": "value",
+          "type": "uint256"
+        },
+        {
+          "internalType": "bytes",
+          "name": "data",
+          "type": "bytes"
+        }
+      ],
+      "name": "requireTrustline",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "sender",
+          "type": "address"
+        },
+        {
+          "internalType": "uint256",
+          "name": "value",
+          "type": "uint256"
+        },
+        {
+          "internalType": "bytes",
+          "name": "data",
+          "type": "bytes"
+        },
+        {
+          "internalType": "address[]",
+          "name": "addresses",
+          "type": "address[]"
+        }
+      ],
+      "name": "requireTrustline",
+      "outputs": [],
+      "stateMutability": "nonpayable",
+      "type": "function"
+    }
+  ],
+  "bytecode": "0x",
+  "deployedBytecode": "0x",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}

package/contracts/Trustlined.sol

@@ -0,0 +1,50 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8;
+
+import {IValidationEngine} from "./interfaces/IValidationEngine.sol";
+
+/// @title Trustline's Base Contract
+/// @author Trustline
+/// @notice This library provides functions for verifying the trust status of a transaction
+abstract contract Trustlined {
+    /// @notice The Trustline ValidationEngine contract address. It must be set before any of the provided functions can be used
+    /// @dev Multiple dapps can share the same ValidationEngine contract
+    /// @dev This contract is set by the owner and must implement the IValidationOracle interface
+    IValidationEngine public validationEngine;
+
+    /// @dev Both a constructor and initializer functions are defined to support both upgradeable and non-upgradeable deployment scenarios
+    constructor(address validationEngine_) {
+        __Trustlined_init(validationEngine_);
+    }
+
+    function __Trustlined_init(address validation_) internal {
+        __Trustlined_init_unchained(validation_);
+    }
+
+    function __Trustlined_init_unchained(address validationEngine_) internal {
+        require(address(validationEngine) == address(0), "Already initialized");
+        validationEngine = IValidationEngine(validationEngine_);
+    }
+
+    /// @notice Checks if a transaction is trusted
+    /// @param addresses An array of addresses that will be verified by the policy
+    function checkTrustlineStatus(address[] memory addresses) internal view returns (bool) {
+        return validationEngine.checkTrustlineStatus(msg.sender, msg.value, msg.data, addresses);
+    }
+
+    /// @notice Checks if a transaction is trusted
+    function checkComplianceStatus() internal view returns (bool) {
+        return validationEngine.checkTrustlineStatus(msg.sender, msg.value, msg.data);
+    }
+
+    /// @notice Requires a trusted transaction
+    /// @param addresses An array of addresses that will be verified by the policy
+    function requireTrustline(address[] memory addresses) internal {
+        validationEngine.requireTrustline(msg.sender, msg.value, msg.data, addresses);
+    }
+
+    /// @notice Requires a trusted transaction
+    function requireTrustline() internal {
+        validationEngine.requireTrustline(msg.sender, msg.value, msg.data);
+    }
+}

package/contracts/examples/PaymentFirewall.sol

@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8;
+
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {Trustlined, IValidationEngine} from "../Trustlined.sol";
+
+/// @title PaymentFirewall
+/// @author Trustline
+/// @notice This contract is a firewall ensuring all funds going in and out are compliant
+contract PaymentFirewall is Trustlined {
+    constructor(address compliance) Trustlined(compliance) {}
+
+    /// @notice Pay native ethers to a recipient
+    /// @param destination The recipient address
+    function payEthers(address payable destination) public payable {
+        address[] memory addresses = new address[](2);
+        addresses[0] = msg.sender;
+        addresses[1] = destination;
+        requireTrustline(addresses);
+        (bool sent, ) = destination.call{value: msg.value}("");
+        require(sent, "Unable to pay ethers");
+    }
+
+    /// @notice Pay ERC20 tokens to a recipient
+    /// @param destination The recipient address
+    /// @param token The ERC20 token address
+    /// @param value The amount of tokens to pay
+    function payTokens(address destination, address token, uint256 value) external {
+        address[] memory addresses = new address[](2);
+        addresses[0] = msg.sender;
+        addresses[1] = destination;
+        requireTrustline(addresses);
+        bool sent = IERC20(token).transferFrom(msg.sender, destination, value);
+        require(sent, "Unable to pay tokens");
+    }
+}
+
+/*
+
+*/

package/contracts/interfaces/IValidationEngine.sol

@@ -0,0 +1,54 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8;
+
+/// @title Trustline's Validation interface
+/// @author Trustline
+/// @notice This interface defines the functions that must be implemented by the validation contract
+/// @dev This interface is used by the Trustlined contract to interact with Trustline's Validation contract
+interface IValidationEngine {
+    /// @notice Checks if a transaction is trusted
+    /// @param sender The transaction sender
+    /// @param value Transaction value in wei
+    /// @param data Transaction payload data
+    /// @param addresses An array of addresses that will be verified by the policy
+    function checkTrustlineStatus(
+        address sender,
+        uint256 value,
+        bytes calldata data,
+        address[] memory addresses
+    ) external view returns (bool);
+
+    /// @notice Checks if a transaction is trusted
+    /// @param sender The transaction sender
+    /// @param value Transaction value in wei
+    /// @param data Transaction payload data
+    function checkTrustlineStatus(
+        address sender,
+        uint256 value,
+        bytes calldata data
+    ) external view returns (bool);
+
+    /// @notice Requires a trusted transaction
+    /// @dev reverts if the transaction is not compliant
+    /// @param sender The transaction sender
+    /// @param value Transaction value in wei
+    /// @param data Transaction payload data
+    /// @param addresses An array of addresses that will be verified by the policy
+    function requireTrustline(
+        address sender,
+        uint256 value,
+        bytes calldata data,
+        address[] memory addresses
+    ) external;
+
+    /// @notice Requires a trusted transaction
+    /// @dev reverts if the transaction is not compliant
+    /// @param sender The transaction sender
+    /// @param value Transaction value in wei
+    /// @param data Transaction payload data
+    function requireTrustline(
+        address sender,
+        uint256 value,
+        bytes calldata data
+    ) external;
+}

package/dist/bundle.js

@@ -0,0 +1,35 @@
+(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.Trustlined = f()}})(function(){var define,module,exports;return (function(){function r(e,n,t){function o(i,f){if(!n[i]){if(!e[i]){var c="function"==typeof require&&require;if(!f&&c)return c(i,!0);if(u)return u(i,!0);var a=new Error("Cannot find module '"+i+"'");throw a.code="MODULE_NOT_FOUND",a}var p=n[i]={exports:{}};e[i][0].call(p.exports,function(r){var n=e[i][1][r];return o(n||r)},p,p.exports,r,e,n,t)}return n[i].exports}for(var u="function"==typeof require&&require,i=0;i<t.length;i++)o(t[i]);return o}return r})()({1:[function(require,module,exports){
+module.exports={
+  "_format": "hh-sol-artifact-1",
+  "contractName": "Trustlined",
+  "sourceName": "contracts/Trustlined.sol",
+  "abi": [
+    {
+      "inputs": [],
+      "name": "validationEngine",
+      "outputs": [
+        {
+          "internalType": "contract IValidationEngine",
+          "name": "",
+          "type": "address"
+        }
+      ],
+      "stateMutability": "view",
+      "type": "function"
+    }
+  ],
+  "bytecode": "0x",
+  "deployedBytecode": "0x",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}
+
+},{}],2:[function(require,module,exports){
+const Trustlined = require('./artifacts/contracts/Trustlined.sol/Trustlined.json');
+
+module.exports = {
+    Trustlined
+};
+
+},{"./artifacts/contracts/Trustlined.sol/Trustlined.json":1}]},{},[2])(2)
+});

package/index.js

@@ -0,0 +1,5 @@
+const Trustlined = require('./artifacts/contracts/Trustlined.sol/Trustlined.json');
+
+module.exports = {
+    Trustlined
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@trustline.id/web3sdk",
+  "description": "Protects EVM-compatible smart contracts from unauthorized access and malicious transactions",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "compile": "hardhat compile",
+    "build": "mkdir -p dist && npm run compile && node build.js",
+    "clean": "rm -rf dist artifacts cache"
+  },
+  "files": [
+    "dist",
+    "artifacts",
+    "index.js",
+    "contracts"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TrustLine-id/web3sdk.git"
+  },
+  "keywords": [
+    "solidity",
+    "ethereum",
+    "smart",
+    "contracts",
+    "security",
+    "compliance",
+    "trustline"
+  ],
+  "author": "Trustline <contact@trustline.id>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/TrustLine-id/web3sdk/issues"
+  },
+  "homepage": "https://www.trustline.id",
+  "dependencies": {
+    "@openzeppelin/contracts": "^5.0.0"
+  },
+  "devDependencies": {
+    "browserify": "^17.0.1",
+    "hardhat": "^2.22.17",
+    "path": "^0.12.7"
+  }
+}