@goplausible/algorand-mcp 3.0.7

package/dist/resources/knowledge/taxonomy/algokit:utils:typescript:v8-migration.md

@@ -0,0 +1,102 @@
+# v8 migration
+
+Version 8 of AlgoKit Utils adds support for algosdk@3. This algosdk version has a number of major breaking changes and as a result we have also needed to make some breaking changes to support it. All changes between version 7 and 8 have been made to support algosdk@3.
+
+Depending on the complexity of your project, you may find that first migrating to version 7, then migrating to version 8 is easier and offers a more gradual experience. Either way this migration will heavily reference the [v7 migration guide](./v7-migration.md) as it documents the majority of changes you will likely need to make.
+
+## <6.1.0 Migration Guide
+
+### Migrating
+
+#### Step 1 - Learn about the changes between version 7 and 8
+
+First read the [>=7.0.0 migration guide](#700-migration-guide) below to familiarise yourself with the version 7 to 8 changes. This will give you the context needed to successfully execute the next step.
+
+#### Step 2 - Migrate using the version 7 migration guide
+
+Using the context gathered from Step 1, you should have all the information you need to migrate using the [version 7 migration guide](./v7-migration.md#610-migration-guide).
+
+A simple example of the before and after follows:
+
+```typescript
+/**** Before ****/
+import * as algokit from '@algorandfoundation/algokit-utils'
+const algod = algokit.getAlgoClient()
+const account = await algokit.mnemonicAccountFromEnvironment(
+  {
+    name: 'MY_ACCOUNT',
+    fundWith: algokit.algos(2),
+  },
+  algod,
+)
+const payment = await algokit.transferAlgos({
+  from: account.addr,
+  to: 'RECEIVER',
+  amount: algokit.algos(1),
+})
+
+/**** After ****/
+import { AlgorandClient } from '@algorandfoundation/algokit-utils'
+const algorand = await AlgorandClient.fromEnvironment()
+const account = await algorand.account.fromEnvironment('MY_ACCOUNT', (2).algo())
+const payment = await algorand.send.payment({
+  sender: account, // NOTE: .addr has been removed from the v7 version of this same code
+  receiver: 'RECEIVER',
+  amount: (1).algo(),
+})
+```
+
+## >=6.1.0<7.0.0 Migration Guide
+
+### Migrating
+
+#### Step 1 - Learn about the changes between version 7 and 8
+
+First read the [>=7.0.0 migration guide](#700-migration-guide) below to familiarise yourself with the version 7 to 8 changes. This will give you the context needed to successfully execute the next step.
+
+#### Step 2 - Migrate using the version 7 migration guide
+
+Using the context gathered from Step 1, you should have all the information you need to migrate using the [version 7 migration guide](./v7-migration.md#610-migration-guide-1).
+
+## >=7.0.0 Migration Guide
+
+This migration path assumes you have actioned all the deprecation notices as part of moving to the `>=7.0.0` version and you are using the `AlgorandClient` and it's related abstractions. Given this, all changes you'll need to make are directly related to upgrading from algosdk@2 to algosdk@3.
+
+While AlgoKit utils now wraps most of the algosdk functionality, it's likely you may have functionality that uses algosdk directly. As as result you may need to refer to the [algosdk v3 migration guide](https://github.com/algorand/js-algorand-sdk/blob/develop/v2_TO_v3_MIGRATION_GUIDE.md.
+
+### Migrating
+
+#### Step 1 - Accommodate usages of addresses
+
+The biggest change in this release is that addresses are consistently typed using `Address` from algosdk@3. The vast majority of AlgoKit Utils methods that previously took a `string` for an account address now take `string | Address`. The impact of this change should be minimal, as `string` is still accepted.
+
+Any changes needed here should be related to converting an algosdk `Account` or `Address` type into the type the function expects.
+
+One scenario that requires a `string` rather than `string | Address` is passing an address as an ABI method arg. This is due to algosdk not supporting this type as an `ABIValue`. When passing an `Address` as an ABI method arg, you'll need to convert to the encoded address representation using `toString()`, like below:
+
+```typescript
+const alice = algorand.account.random()
+const bob = algorand.account.random()
+
+const result = await appClient.send.call({
+  sender: alice,
+  method: 'hello',
+  args: [bob.addr.toString()], // NOTE: the conversion to the encoded string representation
+})
+```
+
+It's also worth noting that the account utils (`algorand.account.random()` in this scenario) returns a type which combines `Address`, `Account` and `TransactionSignerAccount`, so that you can simply pass the object (`alice` in this case) returned into a function that accepts an `Address` or `Account`, which allows you to remove `.addr` in a lot of cases.
+
+#### Step 2 - Remove usages of performAtomicTransactionComposerDryrun
+
+The dryrun feature has long been deprecated and it isn't compatible with algosdk@3, as a result we had to remove support for it. It's likely you can instead use the simulate feature like below:
+
+```typescript
+const payment = await algorand.createTransaction.payment({
+  sender: 'SENDER',
+  receiver: 'RECEIVER',
+  amount: (1).algo(),
+})
+
+const result = await algorand.newGroup().addTransaction(payment).simulate()
+```

package/dist/resources/knowledge/taxonomy/arcs:ARC-template.md

@@ -0,0 +1,48 @@
+---
+arc: <to be assigned>
+title: <The ARC title is a few words, not a complete sentence>
+description: <Description is one full (short) sentence>
+author: <a comma separated list of the author's or authors' name + GitHub username (in parenthesis), or name and email (in angle brackets).  Example, FirstName LastName (@GitHubUsername), FirstName LastName <foo@bar.com>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)>
+discussions-to: <URL>
+status: Draft
+type: <Standards Track, Meta, or Informational>
+category (*only required for Standards Track): <Interface, or ARC>
+subcategory: <General, Asa, Application, Explorer or Wallet>
+created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
+requires (*optional): <ARC number(s)>
+---
+
+This is the suggested template for new ARCs.
+
+Note that an ARC number will be assigned by an editor. When opening a pull request to submit your ARC, please use an abbreviated title in the filename, `arc-draft_title_abbrev.md`.
+
+The title should be 44 characters or less. It should not repeat the ARC number in title, irrespective of the category.
+
+## Abstract
+Abstract is a multi-sentence (short paragraph) technical summary. This should be a very terse and human-readable version of the specification section. Someone should be able to read only the abstract to get the gist of what this specification does.
+
+## Motivation
+The motivation section should describe the "why" of this ARC. What problem does it solve? Why should someone want to implement this standard? What benefit does it provide to the Algorand ecosystem? What use cases does this ARC address?
+
+## Specification
+The key words "**MUST**", "**MUST NOT**", "**REQUIRED**", "**SHALL**", "**SHALL NOT**", "**SHOULD**", "**SHOULD NOT**", "**RECOMMENDED**", "**MAY**", and "**OPTIONAL**" in this document are to be interpreted as described in <a href="https://www.ietf.org/rfc/rfc2119.txt">RFC-2119</a>.
+
+The technical specification should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow competing, interoperable implementations for any of the current Algorand platforms (go-algorand, ...).
+
+## Rationale
+The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages.
+
+## Backwards Compatibility
+All ARCs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The ARC must explain how the author proposes to deal with these incompatibilities. ARC submissions without a sufficient backwards compatibility treatise may be rejected outright.
+
+## Test Cases
+Test cases for an implementation are mandatory for ARCs that are affecting consensus changes.  If the test suite is too large to reasonably be included inline, then consider adding it as one or more files in `../assets/arc-####/`.
+
+## Reference Implementation
+An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification.  If the implementation is too large to reasonably be included inline, then consider adding it as one or more files in `../assets/arc-####/`.
+
+## Security Considerations
+All ARCs must contain a section that discusses the security implications/considerations relevant to the proposed change. Include information that might be important for security discussions, surfaces risks and can be used throughout the life cycle of the proposal. E.g. include security-relevant design decisions, concerns, important discussions, implementation-specific guidance and pitfalls, an outline of threats and risks and how they are being addressed. ARC submissions missing the "Security Considerations" section will be rejected. An ARC cannot proceed to status "Final" without a Security Considerations discussion deemed sufficient by the reviewers.
+
+## Copyright
+Copyright and related rights waived via <a href="https://creativecommons.org/publicdomain/zero/1.0/">CCO</a>.

package/dist/resources/knowledge/taxonomy/arcs:README.md

@@ -0,0 +1,41 @@
+# ARCs: Algorand Requests for Comments
+
+## Mission
+This repository serves to provide a location for the proposal and discussion of ARCs.
+
+To know an ARC's status, please refer to https://arc.algorand.foundation/.
+
+## Status
+Please consider anything which is not published on https://github.com/algorandfoundation/ARCs as a working paper.
+
+And please consider anything published at https://github.com/algorandfoundation/ARCs with a status of "draft" as an incomplete draft.
+
+We recommend only using ARCs with the status "Final", "Living" or "Last Call".
+
+## Process
+Before submitting a new ARC, please have a look at [ARC-0](ARCs/arc-0000.md).
+
+## Validation
+
+Pull requests in this repository must pass automated validation checks:
+
+* HTML formatting and broken links are checked using [html-proofer](https://rubygems.org/gems/html-proofer).
+
+* ARC front matter and formatting are [checked](https://github.com/algorandfoundation/ARCs/blob/master/.github/workflows/auto-merge-bot.yml) using [ARC Validator](https://github.com/algorandfoundation/arcw).
+
+To install `arcw` and validate the ARCs repository:
+
+> You will need [Rust/cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
+
+```console
+git clone git@github.com:algorandfoundation/arcw.git
+cargo install --path=arcw arcw
+arcw Path-to-ARCs-Folder/ARCs/ARCs/arc-xxxx.md
+```
+
+
+Here is a dedicated part on the [forum](https://forum.algorand.org/c/arc/19) to talk  about ARCs.
+
+To discuss ARCs ideas, see the open [Pull Requests](https://github.com/algorandfoundation/ARCs/pulls) of this repository. 
+
+To discuss ARC drafts, use the corresponding issue in the [issue tracker](https://github.com/algorandfoundation/ARCs/issues).

package/dist/resources/knowledge/taxonomy/arcs:assets:arc-0012:README.md

@@ -0,0 +1,30 @@
+# ARC12 Contracts
+
+The contracts for ARC12 can be found under [contracts/](https://github.com/algorandfoundation/ARCs/tree/main/assets/arc-0012/contracts).
+
+[contracts/arc12.ts](./contracts/arc12.ts) contains the TEALScript source code for the Master and Vault contracts. The approval programs for the respective contracts that is generated by TEALScript can also be found in [contracts/](https://github.com/algorandfoundation/ARCs/tree/main/assets/arc-0012/contracts).
+
+## Tests
+
+1. `cd contracts`
+2. `python -v venv .venv`
+3. `source .venv/bin/activate`
+4. `pip install -r tests/requirements.txt`
+5. `pytest tests/`
+
+## Modifying Source
+
+1. `cd contracts`
+2. `yarn install`
+3. Modify `arc12.ts`
+4. Compile with `npx tealscript arc12.ts`
+
+# ARC12 SDK
+
+A reference TypeScript SDK for ARC12 can be found under [arc12-sdk/](https://github.com/algorandfoundation/ARCs/tree/main/assets/arc-0012/arc12-sdk).
+
+## Tests
+
+1. `cd arc12-sdk`
+2. `npm install`
+3. `npx jest`

package/dist/resources/knowledge/taxonomy/arcs:assets:arc-0034:TemplateForm.md

@@ -0,0 +1,58 @@
+---
+id: <proposal number (same as PR)>
+period: <Period number (Integer) (When do you want to submit your proposal)>
+title: <The proposal title is a few words, not a complete sentence>
+author: <a comma separated list of the author's or authors' name + GitHub username (in parenthesis), or name and email (in angle brackets).  Example, FirstName LastName (@GitHubUsername), FirstName LastName <foo@bar.com>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)>
+email: <Email address to start the contract process >
+discussions-to: <Indicating the URL where the proposal is being discussed>
+company_name: <Name of the company>
+category: <dApps, Tools, Community, Other>
+focus_area: <Banking,DEX,Defi,Deployment,Education,Gaming,IDE,Identity,Libraries,Metaverse,Monitoring,Node,NFT,Oracle,Social,Storage,Teal,User Onboarding,Wallet, Other>
+open_source: <Yes, No>
+funding_type: <Proactive, Retroactive>
+amount_requested: <Amount (integer) requested in ALGO, it should be at least 10000>
+delivery_date: <project delivery date, in ISO 8601 (yyyy-mm-dd) format>
+status: <Draft, Final, Approved>
+---
+
+>Proposals that do not include information on all template sections will be rejected.
+>Please, before submitting the grant proposal, review the contract template and ensure you're comfortable with its terms.  <a href="https://drive.google.com/file/d/1dsKwQGhnS3h_PrSkoidhnvqlX7soLpZ-/view">Contract Template</a> 
+
+## Abstract
+A summary of the project, including how the Algorand ecosystem would benefit  (proactive)/ has benefitted (retroactive) from its implementation.
+
+## Team
+Information about the team members and their qualifications, including relevant experience and skills.
+
+## Experience with Algorand
+Details about the team's experience with the Algorand protocol and any previous projects built on it.
+> eg
+    > Using SDKs 
+    > Building applications
+    > Understanding of DApps
+    > Knowledge about the ecosystem
+    > Running nodes
+
+## Present Proposal
+A detailed plan for the development and implementation of the proposal.
+
+To enhance clarity and accountability, we're asking proposers to detail the maintenance period, availability, and sustainability plans for their projects. This includes information on potential costs and the duration for which services will be offered at no or reduced cost
+
+### Deliverable
+Proposals must include clear, non-technical descriptions of deliverables. We encourage the use of multimedia (blog/video) to help explain your proposal's benefits to the community. 
+
+Proposals that do not specify deliverables and a process to check deliverables will be rejected.
+
+## Future Blueprint
+> This part can be optional for one-time grants.
+A high-level plan, defining an overarching strategic objective and capturing the major steps planned for achieving the project at a greater scale.
+
+> For Milestone-based grants, please refer to <a href="https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0034.md#submit-a-proposal"> How to submit a proposal</a>.
+
+## Benefits for the community
+A description of the potential benefits that the proposal could bring to the Algorand community and its users.
+
+## Additional information
+Any other relevant details or documentation that the team would like to include in the proposal.
+> To prevent malicious links and allow front-end to display links properly, **External Links** should be in this format `<a href="https://arc.algorand.foundation/">ARC</a>`
+> To create a new tab when people click on your links, you can use `target="_blank"` like this `<a href="https://arc.algorand.foundation/" target="_blank" >ARC</a>`

package/dist/resources/knowledge/taxonomy/arcs:assets:arc-0062:README.md

@@ -0,0 +1,16 @@
+# ARC-62 Reference Implementation
+
+This is the reference implementation of ASA Circulating Supply App based on the
+[ARC-62 specification](../../ARCs/arc-0062.md).
+
+## Example
+
+Install the project Python dependencies:
+
+`poetry install`
+
+Run the test:
+
+```shell
+poetry run pytest -s -v tests/test_get_circulating_supply.py::test_pass_get_circulating_supply
+``` 

package/dist/resources/knowledge/taxonomy/arcs:pages:nfts.md

@@ -0,0 +1,24 @@
+---
+layout: page
+title: Algorand NFTs Matrix 
+permalink: /nfts
+---
+## Status
+Allowed Status are:
+* OK
+* --
+
+Name should be in alphabetical order.
+
+## ARCS
+
+| 3  | 16 | 18 | 19 | 20 | 69 | 72 | Name |
+| -- | -- | -- | -- | -- | -- | -- | ---- |
+| OK | OK | -- | -- | -- | OK | -- | 2inyhorse |
+| -- | -- | -- | -- | -- | OK | -- | Algoana |
+| OK | OK | -- | OK | -- | -- | -- | Algoana v2 |
+| OK | OK | -- | -- | -- | OK | -- | STUPIDHORSE |
+| OK | -- | -- | -- | -- | OK | -- | STUPIDPONY |
+| OK | OK | -- | -- | -- | OK | -- | tinyhorse |
+
+**Disclaimer:** This website is under constant modification.

package/dist/resources/knowledge/taxonomy/arcs:pages:wallets.md

@@ -0,0 +1,74 @@
+---
+layout: page
+title: Algorand Wallet Compatiblity Matrix
+permalink: /wallets
+---
+## Status
+Allowed Status are:
+- Supported
+- Not Supported
+- Planned
+- EXPERIMENTAL
+- UNKNOWN
+- DEPRECATED
+
+## Wallet ARCs
+
+| ARCS           | Daffi         | Defly         | Exodus        | Pera Wallet   |
+| -------------- | ------------- | ------------- | ------------- | ------------- |
+| [1][ARC-1]     | UNKNOWN       | Supported     | Supported     | Supported     |
+| [5][ARC-5]     | UNKNOWN       | Supported     | Supported     | Supported     |
+| [6][ARC-6]     | UNKNOWN       | Not Supported | Not Supported | Not Supported |
+| [7][ARC-7]     | UNKNOWN       | Not Supported | Supported     | Not Supported |
+| [8][ARC-8]     | UNKNOWN       | Not Supported | Supported     | Not Supported |
+| [9][ARC-9]     | UNKNOWN       | Not Supported | Supported     | Not Supported |
+| [10][ARC-10]   | UNKNOWN       | Not Supported | Supported     | Not Supported |
+| [11][ARC-11]   | UNKNOWN       | Not Supported | Supported     | Not Supported |
+| [25][ARC-25]   | UNKNOWN       | Supported     | Supported     | Supported     |
+| [35][ARC-35]   | UNKNOWN       | Supported     | Not Supported | Planned       |
+
+[ARC-1]: ../ARCs/arc-0001.md "Algorand Wallet Transaction Signing API"
+[ARC-5]: ../ARCs/arc-0005.md "Wallet Transaction Signing API (Functional)"
+[ARC-6]: ../ARCs/arc-0006.md "Algorand Wallet Address Discovery API"
+[ARC-7]: ../ARCs/arc-0007.md "Algorand Wallet Post Transactions API"
+[ARC-8]: ../ARCs/arc-0008.md "Algorand Wallet Sign and Post API"
+[ARC-9]: ../ARCs/arc-0009.md "Algorand Wallet Algodv2 and Indexer API"
+[ARC-10]: ../ARCs/arc-0010.md "Algorand Wallet Reach Minimum Requirements"
+[ARC-11]: ../ARCs/arc-0011.md "Algorand Wallet Reach Browser Spec"
+[ARC-25]: ../ARCs/arc-0025.md "Algorand WalletConnect v1 API"
+[ARC-35]: ../ARCs/arc-0035.md "Algorand Offline Wallet Backup Protocol"
+
+## NFT & Token ARCs
+
+| ARCS           | Daffi         | Defly         | Exodus        | Pera Wallet   |
+| -------------- | ------------- | ------------- | ------------- | ------------- |
+| [3][ARC-3]     | UNKNOWN       | UNKNOWN       | Supported     | UNKNOWN       |
+| [16][ARC-16]   | UNKNOWN       | UNKNOWN       | Supported     | UNKNOWN       |
+| [19][ARC-19]   | UNKNOWN       | UNKNOWN       | Supported     | UNKNOWN       |
+| [20][ARC-20]   | UNKNOWN       | UNKNOWN       | Not Supported | UNKNOWN       |
+| [69][ARC-69]   | UNKNOWN       | UNKNOWN       | Supported     | UNKNOWN       |
+| [72][ARC-72]   | UNKNOWN       | UNKNOWN       | Not Supported | UNKNOWN       |
+| [200][ARC-200] | UNKNOWN       | UNKNOWN       | Not Supported | UNKNOWN       |
+
+[ARC-3]: ../ARCs/arc-0003.md "Conventions Fungible/Non-Fungible Tokens"
+[ARC-16]: ../ARCs/arc-0016.md "Convention for declaring traits of an NFT's"
+[ARC-19]: ../ARCs/arc-0019.md "Templating of NFT ASA URLs for mutability"
+[ARC-20]: ../ARCs/arc-0020.md "Smart ASA"
+[ARC-69]: ../ARCs/arc-0069.md "ASA Parameters Conventions, Digital Media"
+[ARC-72]: ../ARCs/arc-0072.md "Algorand Smart Contract NFT Specification"
+[ARC-200]: ../ARCs/arc-0200.md "Algorand Smart Contract Token Specification"
+
+
+## BIPS
+
+| BIPS           | Daffi         | Defly         | Exodus        | Pera Wallet   |
+| -------------- | ------------- | ------------- | ------------- | ------------- |
+| [32][BIP-32]   | UNKNOWN       | Not supported | Supported     | Not supported |
+| [39][BIP-39]   | UNKNOWN       | Planned       | Supported     | Planned       |
+| [44][BIP-44]   | UNKNOWN       | Not supported | Supported     | Not supported |
+
+[BIP-32]: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki "Hierarchical Deterministic Wallets"
+[BIP-39]: https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki "Mnemonic code for generating deterministic keys"
+[BIP-44]: https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki "Multi-Account Hierarchy for Deterministic Wallets"
+
+**Disclaimer:** This website is under constant modification.