diff --git a/docs.wrm/basics/abi.wrm b/docs.wrm/basics/abi.wrm new file mode 100644 index 000000000..54df7aae9 --- /dev/null +++ b/docs.wrm/basics/abi.wrm @@ -0,0 +1,26 @@ +_section: ABI + +Explain about ABI here, what it does and does not do + +- encodes arbitrary (but defined) data structures to raw bytes + +_subsection: Call + +About encoding + +_heading: selector or signature hash (sighash) + +_heading: Results + +_subsection: Events + + +_subsection: Deployment + +About initcode + +Another paragraph [[link-bip-39]]. + +_heading: Foo? + +Bar? diff --git a/docs.wrm/basics/index.wrm b/docs.wrm/basics/index.wrm new file mode 100644 index 000000000..549835bd4 --- /dev/null +++ b/docs.wrm/basics/index.wrm @@ -0,0 +1,7 @@ +_section: Ethereum Basics @priority<99> + +Prelude here... + +_subsection: About stuff? + +Some info diff --git a/docs.wrm/config.js b/docs.wrm/config.js index 010d8e00d..423014a91 100644 --- a/docs.wrm/config.js +++ b/docs.wrm/config.js @@ -1,3 +1,4 @@ +import * as ethers from "../lib.esm/index.js"; import { version } from "../lib.esm/_version.js"; const title = "ethers"; @@ -11,12 +12,19 @@ const subtitle = (function(version) { export default { title, subtitle, - logo: "./logo.svg", - prefix: "v6-beta", + contextify: function(context) { + Object.assign(context, ethers); + context.provider = new ethers.InfuraProvider(); + //context.getAddress = ethers.getAddress; + context.Uint8Array = Uint8Array; + }, + srcBaseUrl: "https:/\/github.com/ethers-io/ethers.js/blob/v6-beta-exports/src.ts/{FILENAME}#L{LINENO}", + docRoot: ".", + codeRoot: "../src.ts/index.ts", links: [ "./links.txt", diff --git a/docs.wrm/getting-started.wrm b/docs.wrm/getting-started.wrm new file mode 100644 index 000000000..2f9ea8d8e --- /dev/null +++ b/docs.wrm/getting-started.wrm @@ -0,0 +1,3 @@ +_section: Getting Started @ @priority<100> + +The v6 getting started is ocming soon... diff --git a/docs.wrm/index.wrm b/docs.wrm/index.wrm new file mode 100644 index 000000000..2c8c158fb --- /dev/null +++ b/docs.wrm/index.wrm @@ -0,0 +1,21 @@ +_section: Documentation + +_subsection: What is Ethers? + +The ethers.js library aims to be a complete and compact library +for interacting with the Ethereum Blockchain and its ecosystem. + +It is ofen used to create decentralized applications (dapps), +wallets (such as [[link-metamask]] and [[link-tally]]) and +other tools and simple scripts that require reading and writing +to the blockchain. + +_subsection: About this documentation? + +These docs are still under construction, and are being expanded +every day. + +Developers new to Ethers shoud be sure to read through the +[[getting-started]] section. + +And the [[about-api]] is available for drilling down into more details. diff --git a/docs.wrm/license.wrm b/docs.wrm/license.wrm new file mode 100644 index 000000000..fcd77a91a --- /dev/null +++ b/docs.wrm/license.wrm @@ -0,0 +1,26 @@ +_section: License and Copyright @priority<-100> + +The ethers library (including all dependencies) are available under the +[[link-mit]], which permits a wide variety of uses. + +_subsection: MIT License + +Copyright © [Richard Moore](link-mail). + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/docs.wrm/links.txt b/docs.wrm/links.txt index efcbad4fe..8d7ea18f0 100644 --- a/docs.wrm/links.txt +++ b/docs.wrm/links.txt @@ -24,6 +24,7 @@ link-semver [semver](https://semver.org) link-solidity [Solidity](https://solidity.readthedocs.io/) link-solidity-errors [link-solidity-errors](https://docs.soliditylang.org/en/v0.8.4/abi-spec.html#errors) link-solidity-events [link-solidity-events](https://docs.soliditylang.org/en/v0.8.4/abi-spec.html#events) +link-tally [Tally](https://tallyho.org) link-alchemy-signup [link-alchemy-signup](https://dashboard.alchemyapi.io/signup?referral=55a35117-028e-4b7c-9e47-e275ad0acc6d) link-ankr-public [link-ankr-public](https://www.ankr.com/protocol/public/) link-ankr-premium [link-ankr-premium](https://www.ankr.com/protocol/plan/) @@ -48,7 +49,6 @@ link-web3-ipc [link-web3-ipc](https://github.com/ethereum/web3.js/tree/1.x/packa link-web3-ws [link-web3-ws](https://github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-ws) # Specifications -link-solc-output [link-solc-output](https://solidity.readthedocs.io/en/v0.6.0/using-the-compiler.html#output-description) link-base58 [Base58](https://en.bitcoinwiki.org/wiki/Base58) link-base64 [Base64](https://en.wikipedia.org/wiki/Base64) link-bip39-wordlists [BIP-39 Wordlists](https://github.com/bitcoin/bips/blob/master/bip-0039/bip-0039-wordlists.md) @@ -70,6 +70,8 @@ link-mit [MIT License](https://en.m.wikipedia.org/wiki/MIT_License) link-namehash [namehash](https://docs.ens.domains/contract-api-reference/name-processing#hashing-names) link-rlp [Recursive-Length Prefix](https://github.com/ethereum/wiki/wiki/RLP) link-pbkdf2 [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2) +link-solc-output [link-solc-output](https://solidity.readthedocs.io/en/v0.6.0/using-the-compiler.html#output-description) +link-solc-packed [Non-Standard Packed Mode](https://docs.soliditylang.org/en/v0.8.14/abi-spec.html#non-standard-packed-mode) link-uuid [UUID](https://www.ietf.org/rfc/rfc4122.txt) link-eip-155 [EIP-155](https://eips.ethereum.org/EIPS/eip-155) @@ -105,7 +107,7 @@ link-js-proxy [link-js-proxy](https://developer.mozilla.org/en-US/docs/Web/JavaS link-js-typedarray [link-js-typedarray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) link-ricmoo-humanreadableabi [link-ricmoo-humanreadableabi](https://blog.ricmoo.com/human-readable-contract-abis-in-ethers-js-141902f4d917) - +link-ricmoo-wisps [Wisps: The Magical World of Create2](https://blog.ricmoo.com/wisps-the-magical-world-of-create2-5c2177027604); link-other-ethereum-dev-docs [link-other-ethereum-dev-docs](https://ethereum.org/en/developers/docs/) link-wiki-basicauth [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)