@fastish/contracts 0.1.0 → 0.1.1

package/Blocks.sol

@@ -0,0 +1,73 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.33;
+
+import {
+    ALLOCATION,
+    ALLOCATION_KEY,
+    AMOUNT,
+    AMOUNT_KEY,
+    ASSET,
+    ASSET_KEY,
+    AUTH,
+    AUTH_KEY,
+    BALANCE,
+    BALANCE_KEY,
+    BOUNTY,
+    BOUNTY_KEY,
+    BlockRef,
+    CUSTODY,
+    CUSTODY_KEY,
+    DataRef,
+    DataPairRef,
+    FUNDING,
+    FUNDING_KEY,
+    HostAmount,
+    LISTING,
+    LISTING_KEY,
+    Listing,
+    MAXIMUM,
+    MAXIMUM_KEY,
+    MINIMUM,
+    MINIMUM_KEY,
+    MemRef,
+    NODE,
+    NODE_KEY,
+    QUANTITY,
+    QUANTITY_KEY,
+    PARTY,
+    PARTY_KEY,
+    RATE,
+    RATE_KEY,
+    RECIPIENT,
+    RECIPIENT_KEY,
+    ROUTE,
+    ROUTE_EMPTY,
+    ROUTE_KEY,
+    STEP,
+    STEP_KEY,
+    TX,
+    TX_KEY,
+    Tx,
+    Writer,
+    AssetAmount
+} from "./contracts/blocks/Schema.sol";
+import {Blocks} from "./contracts/blocks/Readers.sol";
+import {Data} from "./contracts/blocks/Data.sol";
+import {Mem} from "./contracts/blocks/Mem.sol";
+import {
+    InvalidBlock,
+    MalformedBlocks,
+    UnexpectedAsset,
+    UnexpectedHost,
+    UnexpectedMeta,
+    ZeroNode,
+    ZeroRecipient
+} from "./contracts/blocks/Errors.sol";
+import {
+    BALANCE_BLOCK_LEN,
+    CUSTODY_BLOCK_LEN,
+    IncompleteWriter,
+    TX_BLOCK_LEN,
+    Writers,
+    WriterOverflow
+} from "./contracts/blocks/Writers.sol";

package/Commands.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.33;
+
+import {CommandBase, CommandContext} from "./contracts/commands/Base.sol";
+import {NoOperation} from "./contracts/core/Operation.sol";
+import {BALANCES, CLAIMS, CUSTODIES, PIPE, SETUP, TRANSACTIONS} from "./contracts/utils/Channels.sol";
+import {BorrowAgainstBalanceToBalance, BorrowAgainstCustodyToBalance} from "./contracts/commands/Borrow.sol";
+import {Burn} from "./contracts/commands/Burn.sol";
+import {Create} from "./contracts/commands/Create.sol";
+import {CreditBalanceToAccount} from "./contracts/commands/CreditTo.sol";
+import {DebitAccountToBalance} from "./contracts/commands/DebitFrom.sol";
+import {Deposit} from "./contracts/commands/Deposit.sol";
+import {Remove} from "./contracts/commands/Remove.sol";
+import {Fund} from "./contracts/commands/Fund.sol";
+import {
+    AddLiquidityFromBalancesToBalances,
+    AddLiquidityFromCustodiesToBalances,
+    RemoveLiquidityFromBalanceToBalances,
+    RemoveLiquidityFromCustodyToBalances
+} from "./contracts/commands/Liquidity.sol";
+import {LiquidateFromBalanceToBalances, LiquidateFromCustodyToBalances} from "./contracts/commands/Liquidate.sol";
+import {MintToBalances} from "./contracts/commands/Mint.sol";
+import {Pipe} from "./contracts/commands/Pipe.sol";
+import {Provision} from "./contracts/commands/Provision.sol";
+import {ReclaimToBalances} from "./contracts/commands/Reclaim.sol";
+import {RedeemFromBalanceToBalances, RedeemFromCustodyToBalances} from "./contracts/commands/Redeem.sol";
+import {RepayFromBalanceToBalances, RepayFromCustodyToBalances} from "./contracts/commands/Repay.sol";
+import {Settle} from "./contracts/commands/Settle.sol";
+import {StakeBalanceToBalances, StakeCustodyToBalances, StakeCustodyToPosition} from "./contracts/commands/Stake.sol";
+import {Supply} from "./contracts/commands/Supply.sol";
+import {SwapExactBalanceToBalance, SwapExactCustodyToBalance} from "./contracts/commands/Swap.sol";
+import {Transfer} from "./contracts/commands/Transfer.sol";
+import {UnstakeBalanceToBalances} from "./contracts/commands/Unstake.sol";
+import {Withdraw} from "./contracts/commands/Withdraw.sol";
+import {AllowAssets} from "./contracts/commands/admin/AllowAssets.sol";
+import {Destroy} from "./contracts/commands/admin/Destroy.sol";
+import {Authorize} from "./contracts/commands/admin/Authorize.sol";
+import {DenyAssets} from "./contracts/commands/admin/DenyAssets.sol";
+import {Init} from "./contracts/commands/admin/Init.sol";
+import {Relocate} from "./contracts/commands/admin/Relocate.sol";
+import {Allocate} from "./contracts/commands/admin/Allocate.sol";
+import {Unauthorize} from "./contracts/commands/admin/Unauthorize.sol";
+import {PeerBase} from "./contracts/peer/Base.sol";
+import {PeerAllowAssets} from "./contracts/peer/AllowAssets.sol";
+import {PeerDenyAssets} from "./contracts/peer/DenyAssets.sol";
+import {PeerPull} from "./contracts/peer/Pull.sol";
+import {PeerPush} from "./contracts/peer/Push.sol";

package/Core.sol

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.33;
+
+import {AccessControl} from "./contracts/core/Access.sol";
+import {Balances} from "./contracts/core/Balances.sol";
+import {Host} from "./contracts/core/Host.sol";
+import {FailedCall, NoOperation, OperationBase} from "./contracts/core/Operation.sol";
+import {Validator} from "./contracts/core/Validator.sol";
+import {HostDiscovery} from "./contracts/core/Host.sol";
+import {IHostDiscovery} from "./contracts/interfaces/IHostDiscovery.sol";

package/Events.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.33;
+
+import {AccessEvent} from "./contracts/events/Access.sol";
+import {AssetEvent} from "./contracts/events/Asset.sol";
+import {BalanceEvent} from "./contracts/events/Balance.sol";
+import {CollateralEvent} from "./contracts/events/Collateral.sol";
+import {CommandEvent} from "./contracts/events/Command.sol";
+import {DebtEvent} from "./contracts/events/Debt.sol";
+import {DepositEvent} from "./contracts/events/Deposit.sol";
+import {EventEmitter} from "./contracts/events/Emitter.sol";
+import {GovernedEvent} from "./contracts/events/Governed.sol";
+import {HostAnnouncedEvent} from "./contracts/events/HostAnnounced.sol";
+import {ListingEvent} from "./contracts/events/Listing.sol";
+import {PeerEvent} from "./contracts/events/Peer.sol";
+import {QuoteEvent} from "./contracts/events/Quote.sol";
+import {FastishEvent} from "./contracts/events/Fastish.sol";
+import {WithdrawalEvent} from "./contracts/events/Withdraw.sol";

package/README.md

@@ -11,15 +11,15 @@ It contains the reusable contracts, utilities, and encoding helpers that Fastish
 - Shared request/response block parsing and writing logic
 - Shared id, asset, account, and event encoding used across the protocol
 
-## Main Entry Points
-
-Most consumers should start from the barrel files in `contracts/`:
-
-- `contracts/Core.sol`: core host and validation building blocks
-- `contracts/Commands.sol`: base command contract plus standard command mixins
-- `contracts/Blocks.sol`: block schema, readers, and writers
-- `contracts/Utils.sol`: ids, assets, accounts, layout, strings, and value helpers
-- `contracts/Events.sol`: reusable event emitters and event contracts
+## Main Entry Points
+
+Most consumers should start from the package root entrypoints:
+
+- `@fastish/contracts/Core.sol`: core host and validation building blocks
+- `@fastish/contracts/Commands.sol`: base command contract plus standard command mixins
+- `@fastish/contracts/Blocks.sol`: block schema, readers, and writers
+- `@fastish/contracts/Utils.sol`: ids, assets, accounts, layout, strings, and value helpers
+- `@fastish/contracts/Events.sol`: reusable event emitters and event contracts
 
 ## Start Here
 
@@ -44,7 +44,7 @@ Extend `Host` when you want a Fastish host contract with admin command support a
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity ^0.8.33;
 
-import {Host} from "fastish/contracts/Core.sol";
+import {Host} from "@fastish/contracts/Core.sol";
 
 contract ExampleHost is Host {
     constructor(address fastish)
@@ -69,7 +69,7 @@ Extend `CommandBase` when you want a Fastish command mixin that runs inside the
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity ^0.8.33;
 
-import {CommandBase, CommandContext} from "fastish/contracts/Commands.sol";
+import {CommandBase, CommandContext} from "@fastish/contracts/Commands.sol";
 
 string constant NAME = "myCommand";
 string constant ROUTE = "route(uint foo, uint bar)";
@@ -114,13 +114,13 @@ npm install @fastish/contracts
 npm run compile
 ```
 
-The stable import surface for consumers is:
-
-- `fastish/contracts/Core.sol`
-- `fastish/contracts/Commands.sol`
-- `fastish/contracts/Blocks.sol`
-- `fastish/contracts/Utils.sol`
-- `fastish/contracts/Events.sol`
+The stable import surface for consumers is:
+
+- `@fastish/contracts/Core.sol`
+- `@fastish/contracts/Commands.sol`
+- `@fastish/contracts/Blocks.sol`
+- `@fastish/contracts/Utils.sol`
+- `@fastish/contracts/Events.sol`
 
 ## When To Use This Repo
 

package/Schema.sol

@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.33;
+
+import {
+    ALLOCATION,
+    ALLOCATION_KEY,
+    AMOUNT,
+    AMOUNT_KEY,
+    ASSET,
+    ASSET_KEY,
+    AUTH,
+    AUTH_KEY,
+    AUTH_PROOF_LEN,
+    AUTH_TOTAL_LEN,
+    BALANCE,
+    BALANCE_KEY,
+    BOUNTY,
+    BOUNTY_KEY,
+    BlockPairRef,
+    BlockRef,
+    CUSTODY,
+    CUSTODY_KEY,
+    DataPairRef,
+    DataRef,
+    FUNDING,
+    FUNDING_KEY,
+    HostAmount,
+    UserAmount,
+    LISTING,
+    LISTING_KEY,
+    Listing,
+    MAXIMUM,
+    MAXIMUM_KEY,
+    MINIMUM,
+    MINIMUM_KEY,
+    MemRef,
+    NODE,
+    NODE_KEY,
+    QUANTITY,
+    QUANTITY_KEY,
+    PARTY,
+    PARTY_KEY,
+    RATE,
+    RATE_KEY,
+    RECIPIENT,
+    RECIPIENT_KEY,
+    ROUTE,
+    ROUTE_EMPTY,
+    ROUTE_KEY,
+    STEP,
+    STEP_KEY,
+    TX,
+    TX_KEY,
+    Tx,
+    Writer,
+    AssetAmount
+} from "./contracts/blocks/Schema.sol";

package/Utils.sol

@@ -0,0 +1,105 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.33;
+
+import {
+    CLAIMS,
+    BALANCES,
+    CUSTODIES,
+    PIPE,
+    SETUP,
+    TRANSACTIONS
+} from "./contracts/utils/Channels.sol";
+import {
+    ACCOUNT_FAMILY,
+    accountEvmAddr,
+    accountPrefix,
+    addrOr,
+    ADMIN_PREFIX,
+    ensureEvmAccount,
+    InvalidAccount,
+    isAdminAccount,
+    toAdminAccount,
+    toUserAccount,
+    USER_PREFIX
+} from "./contracts/utils/Accounts.sol";
+import {
+    BadAmount,
+    ensureAmount,
+    ensureAssetRef,
+    ensureBalanceRef,
+    ERC20_PREFIX,
+    ERC721_PREFIX,
+    InvalidAsset,
+    isAsset32,
+    localErc20Addr,
+    localErc721Issuer,
+    resolveAmount,
+    toErc20Asset,
+    toErc721Asset,
+    toValueAsset,
+    VALUE_PREFIX,
+    ZeroAmount
+} from "./contracts/utils/Assets.sol";
+import {ECDSA} from "./contracts/utils/ECDSA.sol";
+import {
+    COMMAND_ARGS,
+    COMMAND_PREFIX,
+    ensureCommand,
+    ensureHost,
+    HOST_PREFIX,
+    InvalidId,
+    isCommand,
+    isHost,
+    isPeer,
+    localHostAddr,
+    localNodeAddr,
+    NODE_FAMILY,
+    PEER_ARGS,
+    PEER_PREFIX,
+    toCommandId,
+    toCommandSelector,
+    toHostId,
+    toPeerId,
+    toPeerSelector
+} from "./contracts/utils/Ids.sol";
+import {
+    ACCOUNT,
+    ADMIN,
+    ASSET,
+    COMMAND,
+    ERC20,
+    ERC721,
+    EVM32,
+    EVM64,
+    HOST,
+    NODE,
+    PEER,
+    USER,
+    VALUE
+} from "./contracts/utils/Layout.sol";
+import {bytes32ToString} from "./contracts/utils/Strings.sol";
+import {
+    applyBps,
+    beforeBps,
+    isFamily,
+    isLocal,
+    isLocalFamily,
+    matchesBase,
+    MAX_BPS,
+    max8,
+    max16,
+    max24,
+    max32,
+    max40,
+    max64,
+    max96,
+    max128,
+    max160,
+    routeSchema1,
+    routeSchema2,
+    toLocalBase,
+    toLocalFamily,
+    toUnspecifiedBase,
+    ValueOverflow
+} from "./contracts/utils/Utils.sol";
+import {InsufficientValue, msgValue, useValue, ValueBudget} from "./contracts/utils/Value.sol";

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@fastish/contracts",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Solidity contracts and protocol building blocks for Fastish hosts and commands.",
   "private": false,
   "license": "GPL-3.0-only",
   "type": "module",
   "files": [
+    "*.sol",
     "contracts/**/*.sol",
     "README.md",
     "LICENSE"