Questions tagged [documentation]
The documentation tag has no summary.
43 questions
0 votes
0 answers
14 views
Looking for an IDE that has built in documentation lookups for keywords or plugins that do this
From remix to vscode I haven't found an IDE that is providing support for documentation lookups for solidity keywords. I'm hoping for either hover tips or I press f1 or some other keybinding while my ...
1 vote
2 answers
195 views
Generating NatSpec boilerplate for Solidity functions in Visual Studio Code
I would like to document my smart contracts functions using NatSpec Format. Is there a VSCode extension I can use to do this, that basically generates that boilerplate code for me to fill in?
- 885
0 votes
1 answer
89 views
Setting up a Chainlink node in a Docker container on MacOS (Documentation Issue)
I've gotten most of the way through the LINK docs on how to build a chainlink node in container and the only issue I have not been able to trouble shoot is this error I keep getting in my ZSH terminal ...
- 11
1 vote
1 answer
79 views
Confusion with layout of string variables in storage
From solidity docs, in section Layout of State Variables in Storage > bytes and strings There is this explanation (v: v0.8.21): In particular: if the data is at most 31 bytes long, the elements ...
- 47
2 votes
2 answers
215 views
What is an Internal function type variable?
I was going through solidity documentation and found this paragraph inside "Function Types" section https://docs.soliditylang.org/en/v0.8.21/types.html#user-defined-value-types A function of ...
- 25
2 votes
1 answer
235 views
--solc --userdoc --devdoc File not found. Searched the following locations: ""
When trying to generate user documentation and developer documentation from the NatSpec of a smart contract with solc --userdoc --devdoc MarketPlaceCustodial.sol by following the official ...
- 834
0 votes
1 answer
56 views
Call contract's function
I'm new in solidity and blockchain itself. Typed myself contract for Voting in VSCode and tried to figure out how I can run code and research workflow and etc. During researching figured out that for ...
- 3
0 votes
1 answer
38 views
metamask documentation for frontend development
Where can I find some valid documentation to understand what kind of parameters and call should I do in my javascript file in the html pages of a client to interact with deployed smart contracts ...
1 vote
1 answer
195 views
How to get solidity-docgen to properly render multi-paragraph @devs
When solidity-docgen generates a Markdown doc file it doesn't seem to be able to properly handle a case like: /** * @dev Returns whether `spender` is allowed to manage `tokenId`. * * Requirements: ...
- 126
1 vote
1 answer
450 views
How to document events (Natspec)?
I am trying to add comments/documents following the Natspec. I didn't understand how to document events emitted inside a function. Is there a standard defined for this? I saw this GitHub issue but I ...
- 242
0 votes
1 answer
35 views
Values added inside of an object that are not parameters of the function
I've seen this in Solidity several times, but I can't find it in the documentation nor do I know how to describe it in a search engine. Say you have a function: function buyItem(uint256 _upc) ...
- 3
1 vote
1 answer
209 views
Generate documentation from ABI json
Is there a tool to generate readable documentation given a ABI json file? For example let's say I have this simple ABI: [ { "inputs": [], "name": "retrieve", &...
- 111
0 votes
1 answer
112 views
Documentation for brownie env variables
I'm using brownie for a while to interact with ethereum, and I've always used ETHERSCAN_TOKEN to publish the source code in Etherscan, however I'm unable to find this env variable in the documentation....
anon
0 votes
1 answer
185 views
What is the best way to accept ether payment without using a third party payment service?
I am new in Ethereum blockchain technology. I wanted to make a payment gateway for accepting Ethereum. I ran ethereum rinkeby testnet on my local machine and tested Ether transfer to another wallet. I ...
2 votes
2 answers
1k views
Chainlink Beginner Tutorial: call to PriceConsumerV3.getLatestPrice errored: [object Object]
I have followed the steps in the Chainlink docs Beginner's tutorial, as described here: https://docs.chain.link/docs/beginners-tutorial/ Everything appears to work until the last paragraph: Click &...
- 21