Skip to content

Commit

Permalink
✨ V1
Browse files Browse the repository at this point in the history
  • Loading branch information
z0r0z committed Feb 16, 2024
1 parent 55a6362 commit 0e07baa
Show file tree
Hide file tree
Showing 12 changed files with 187 additions and 99 deletions.
6 changes: 3 additions & 3 deletions .gas-snapshot
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ IETest:testBalanceInETH() (gas: 40280)
IETest:testCommandSendERC0() (gas: 102922)
IETest:testCommandSendETH() (gas: 69404)
IETest:testCommandSendUSDC() (gas: 135652)
IETest:testCommandSwapDAI() (gas: 101147)
IETest:testCommandSwapDAI() (gas: 110787)
IETest:testCommandSwapETH() (gas: 113487)
IETest:testCommandSwapForETH() (gas: 122654)
IETest:testCommandSwapUSDC() (gas: 157172)
IETest:testCommandSwapForETH() (gas: 130366)
IETest:testCommandSwapUSDC() (gas: 157128)
IETest:testCommandSwapUSDCForWBTC() (gas: 165068)
IETest:testDeploy() (gas: 2643012)
IETest:testENSNameOwnership() (gas: 83907)
Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ From natural language:

IE should deterministically and transparently operate to provide these utilities in an uncensorable medium like a Solidity smart contract.

[V0](./src/IE.sol) is a POC of this.
[V1](./src/IE.sol) is a POC of this.

## Command Syntax (⌘)

IE is approaching things from first-principles and a "show" rather than "tell" approach. There will be some experimentation.

Some things in V0 are likely very underoptimized for this particular use case.
Some things in V1 are likely very underoptimized for this particular use case.

The bigger project is to identify syntax and phrasing for common types of onchain transactions in English to start. The following are identified as categories and phrases that should demonstrate this for many if not most natural language commands to generate txs.

Expand All @@ -34,10 +34,10 @@ As you might notice, there are patterns. Because after all this is typical langu

Also, let's try and be as helpful as possible. If there is `msg.value` in a command, then we will assume ETH is involved.

Actions should also have aliases to catch more cases. Though it will be cheaper to use the primary word (for example, 'send' or 'swap' with preference to familiarity, and if there indecision, the shorter), it is helpful to do more and catch different ways of phrasing transactional commands, like "send" can equate "transfer" and "give" when it comes to onchain assets.
Actions should also have aliases to catch more cases. Though it will be cheaper to use the primary word (for example, 'send' or 'swap' with preference to familiarity, and if there indecision, the shorter), it is helpful to do more and catch different ways of phrasing transactional commands, like "send" can equate to "transfer" when it comes to onchain assets.

### Send
- *V0*
- *V1*

*Words: 4*

Expand All @@ -49,11 +49,18 @@ Actions should also have aliases to catch more cases. Though it will be cheaper
[action] [value] [asset] [to/for] [object]
- **send 1 ETH to/for vitalik**

aliases: *transfer*, *give*
aliases: *transfer*

### Swap
- *V1*

*Words: 5*

[action] [value] [asset] [to/for] [object]
- **swap 1 ETH to/for DAI**

aliases: *exchange*

## Getting Started

Run: `curl -L https://foundry.paradigm.xyz | bash && source ~/.bashrc && foundryup`
Expand Down
2 changes: 1 addition & 1 deletion docs/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title = ""
no-section-label = true
additional-js = ["solidity.min.js"]
additional-css = ["book.css"]
git-repository-url = "https://github.com/NaniDAO/IE"
git-repository-url = "https://github.com/NaniDAO/ie"

[output.html.fold]
enable = true
17 changes: 12 additions & 5 deletions docs/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ From natural language:

IE should deterministically and transparently operate to provide these utilities in an uncensorable medium like a Solidity smart contract.

[V0](./src/IE.sol) is a POC of this.
[V1](./src/IE.sol) is a POC of this.

## Command Syntax (⌘)

IE is approaching things from first-principles and a "show" rather than "tell" approach. There will be some experimentation.

Some things in V0 are likely very underoptimized for this particular use case.
Some things in V1 are likely very underoptimized for this particular use case.

The bigger project is to identify syntax and phrasing for common types of onchain transactions in English to start. The following are identified as categories and phrases that should demonstrate this for many if not most natural language commands to generate txs.

Expand All @@ -34,10 +34,10 @@ As you might notice, there are patterns. Because after all this is typical langu

Also, let's try and be as helpful as possible. If there is `msg.value` in a command, then we will assume ETH is involved.

Actions should also have aliases to catch more cases. Though it will be cheaper to use the primary word (for example, 'send' or 'swap' with preference to familiarity, and if there indecision, the shorter), it is helpful to do more and catch different ways of phrasing transactional commands, like "send" can equate "transfer" and "give" when it comes to onchain assets.
Actions should also have aliases to catch more cases. Though it will be cheaper to use the primary word (for example, 'send' or 'swap' with preference to familiarity, and if there indecision, the shorter), it is helpful to do more and catch different ways of phrasing transactional commands, like "send" can equate to "transfer" when it comes to onchain assets.

### Send
- *V0*
- *V1*

*Words: 4*

Expand All @@ -49,11 +49,18 @@ Actions should also have aliases to catch more cases. Though it will be cheaper
[action] [value] [asset] [to/for] [object]
- **send 1 ETH to/for vitalik**

aliases: *transfer*, *give*
aliases: *transfer*

### Swap
- *V1*

*Words: 5*

[action] [value] [asset] [to/for] [object]
- **swap 1 ETH to/for DAI**

aliases: *exchange*

## Getting Started

Run: `curl -L https://foundry.paradigm.xyz | bash && source ~/.bashrc && foundryup`
Expand Down
2 changes: 1 addition & 1 deletion docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
- [Home](README.md)
# src
- [IE](src/IE.sol/contract.IE.md)
- [IENSHelper](src/IE.sol/interface.IENSHelper.md)
- [IToken](src/IE.sol/interface.IToken.md)
- [IExecutor](src/IE.sol/interface.IExecutor.md)
- [IENSHelper](src/IE.sol/interface.IENSHelper.md)
- [ISwapRouter](src/IE.sol/interface.ISwapRouter.md)
Loading

0 comments on commit 0e07baa

Please sign in to comment.