Skip to content

README: Add information from the Agave readme#18

Merged
joncinque merged 1 commit intoanza-xyz:masterfrom
joncinque:readme
Feb 10, 2025
Merged

README: Add information from the Agave readme#18
joncinque merged 1 commit intoanza-xyz:masterfrom
joncinque:readme

Conversation

@joncinque
Copy link
Copy Markdown
Collaborator

Problem

The README for this repository is missing information about how to get started, which is included in the Agave README.

Summary of changes

Add information about setting up and running tests

#### Problem

The README for this repository is missing information about how to get
started, which is included in the Agave README.

#### Summary of changes

Add information about setting up and running tests
@joncinque joncinque requested a review from yihau February 10, 2025 12:40
@joncinque joncinque enabled auto-merge (squash) February 10, 2025 12:40
Copy link
Copy Markdown
Member

@yihau yihau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🪖

@joncinque joncinque merged commit 61a7e73 into anza-xyz:master Feb 10, 2025
@joncinque joncinque deleted the readme branch February 10, 2025 13:01
febo added a commit to febo/solana-sdk that referenced this pull request Sep 21, 2025
* Use macro rules

* Update directory structure
febo added a commit to febo/solana-sdk that referenced this pull request Sep 22, 2025
* Use macro rules

* Update directory structure
febo added a commit to febo/solana-sdk that referenced this pull request Sep 22, 2025
* Use macro rules

* Update directory structure
febo added a commit to febo/solana-sdk that referenced this pull request Sep 24, 2025
* Use macro rules

* Update directory structure
febo added a commit to febo/solana-sdk that referenced this pull request Sep 25, 2025
* Use macro rules

* Update directory structure
febo added a commit to febo/solana-sdk that referenced this pull request Oct 2, 2025
* Use macro rules

* Update directory structure
febo added a commit to febo/solana-sdk that referenced this pull request Oct 2, 2025
* Use macro rules

* Update directory structure
febo added a commit to febo/solana-sdk that referenced this pull request Oct 3, 2025
* Use macro rules

* Update directory structure
febo added a commit to febo/solana-sdk that referenced this pull request Oct 16, 2025
* Use macro rules

* Update directory structure
febo added a commit to febo/solana-sdk that referenced this pull request Oct 17, 2025
* Use macro rules

* Update directory structure
febo added a commit to febo/solana-sdk that referenced this pull request Oct 18, 2025
* Use macro rules

* Update directory structure
febo added a commit that referenced this pull request Oct 23, 2025
* Add derive address helpers

* Update lock file

* Fix doc links

* Add missing dependency

* Refactor directory structure (#18)

* Use macro rules

* Update directory structure

* Add account info and pubkey helpers (#21)

* Rename unchecked methods (#22)

* Add map and filter_map to Ref and RefMut (#27)

* Add map and filter_map to Ref and RefMut

* Add unit tests

* Apply suggestions

* Add bit flag for original data length (#28)

* Add bit flag

* Remove declarative macro

* Add `checked_create_program_address` helper (#30)

* Add unchecked helper

* Fix lint

* Add inline

* Rename to checked

* Cosmetics

* Fix sol log params

* A close macro implementation for AccountInfo (#42)

* Added close and based_close

* added docs comments + wrapped up and tested both function

* cargo clippy and fmt

* added the new close and changed the name for

* fixed and tested after comments

* Fixed Realloc Macro (#45)

* Fixed compiler bitching about realloc

* Added a better alterantive to the black_box

* Fixed latest comments

* deleted some line after the refactor

* Update comments

* Fix last u64 owner index on close (#55)

* Fix clippy warnings (#59)

* Improve close unchecked

* sdk: Improve comments (#64)

* [wip]: Add new scripts

* [wip]: Use matric strategy

* [wip]: Fix members parsing

* [wip]: Add CI env variables

* [wip]: Remove nothrow

* [wip]: Filter changes

* [wip]: Add audit step

* [wip]: Add semver checks

* [wip]: Refactor publish workflow

* [wip]: Refactor

* [wip]: Fix commands

* Fix formatting

* Remove detect changes step

* Review comments

* Fix lint comments

* Expand crate comment

* Ignore crate comment tests

* Add missing docs

* More missing docs

* Add missing release component

* Pin cargo-release version

* Fix merge

* Review comments

* sdk: Lightweight borrow check (#65)

* [wip]: Add new scripts

* [wip]: Add CI env variables

* [wip]: Remove nothrow

* [wip]: Filter changes

* [wip]: Add audit step

* [wip]: Add semver checks

* [wip]: Refactor publish workflow

* [wip]: Refactor

* [wip]: Fix commands

* Fix formatting

* Remove detect changes step

* Add check methods

* Use check variant on close

* Fix merge

* Address review comments (#78)

* [wip]: Address review comments

* [wip]: Fix pointer reference

* [wip]: Add logger buffer size tests

* Remove unused

* More logger tests

* Rename program to cpi

* Remove dynamic allocation

* Fixed signed tests

* Fix review comments

* Fix unsigned test case

* Add is_owner_by helper

* Account borrow state check (#147)

* Improve fallback and docs

* Add borrow state check

* Add inline

* Review comments

* Revert doc link merge change

* Update doc comments on close account (#173)

* Update doc comments

* Update sdk/pinocchio/src/account_info.rs

Co-authored-by: Jon C <me@jonc.dev>

* Update sdk/pinocchio/src/account_info.rs

Co-authored-by: Jon C <me@jonc.dev>

---------

Co-authored-by: Jon C <me@jonc.dev>

* Remove *const cast (#170)

* Add cargo miri test to CI (#178)

* Add miri step

* Fix miri issues

* Install miri component

* Deprecate AccountInfo::realloc (#174)

* Add resize

* Deprecate realloc

* Simplify program entrypoint (#166)

* Fix review comments

* Revert offset increment change

* Add invoke instruction helper

* Typos

* Remove new helpers

* Remove unused

* Address review comments

* Tweak inline attributes

* Use invoke signed unchecked

* Refactor inline

* Renamed to with_bounds

* Update docs

* Revert change

* Add constant length check

* Simplify accounts deserialization

* Invert borrow state logic

* Use expr instead

* Add missing import

* Address review comments

* Revert unnecessary repr

* Fix rebase

* Tweak docs

* Fix doc reference

* Fix miri errors

* More review comments

* Simplify realloc logic (#175)

* Simplify realloc logic

* Address review comments

* Fix `assign` unsoundness (#180)

* Fix assign unsoundness

* Remove unsafe

* ci: Add spellcheck step (#164)

* Add invoke instruction helper

* Typos

* Remove new helpers

* Remove unused

* Address review comments

* Tweak inline attributes

* Use invoke signed unchecked

* Refactor inline

* Renamed to with_bounds

* Update docs

* Revert change

* Add constant length check

* Add spellcheck step

* Tweak action

* Fix typos

* More fixes

* Yet more fixes

* Fixes

* Add j1 option

* More and more fixes

* Add missing acronym

* Fix merge

* Fix spelling

* Fix spelling

* Clarify the use of constant values (#200)

* Add comments on constants

* Improve offset comments

* Add bitmask to dictionary

* Renamed to field_at_offset

* Ignore `zero_init` parameter (#203)

Ignore zero_init parameter

* Add resize_unchecked method to account info (#230)

* add resize_unchecked method to account info

* Apply suggestion from @febo

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Apply suggestion from @febo

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Apply suggestion from @febo

Co-authored-by: Fernando Otero <febo@anza.xyz>

---------

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Feat: Add debug/copy derives and enable missing debug/copy lint (#228)

* Add debug/copy derives and enable missing debug/copy lint

* Update sdk/pinocchio/src/sysvars/rent.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/entrypoint/mod.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/instruction.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/sysvars/clock.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/sysvars/fees.rs

* Update sdk/pinocchio/src/sysvars/fees.rs

* Update sdk/pinocchio/src/sysvars/instructions.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/sysvars/instructions.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/sysvars/instructions.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/sysvars/clock.rs

* Fix syntax error in Instructions struct derive macro

---------

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Feat: make AccountInfo::data_ptr public (#232)

* make data_ptr public

* Update sdk/pinocchio/src/account_info.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* add some tests for data ptr

* Fix spelling

---------

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Feat: Add try_maps on AccountInfo Ref/RefMut (#229)

* Add try_maps on AccountInfo Ref/RefMut

* update tests and api for try map ref

* pinocchio: Move `NON_DUP_MARKER` const (#245)

Move NON_DUP_MARKER const

* chore: fix typo in comment (#240)

Signed-off-by: vetclippy <vetclippy@icloud.com>

* pinocchio: Add `pubkey_eq` helper (#248)

* Add pubkey_eq helper

* Fix typo

* Update pubkey comparison

* Add proptest

* Add unlikely

* Replace proptest

* pinocchio: Add `AccountInfo` invariant details (#254)

Add invariant details

* Add account view

* Improve account borrows

* Add constructor

* Add account_ptr method

* Add copy feature

* Add docs configuration

* Rename to address

* Use clone

* Remove unused

* Add missing doc_auto_cfg

* Fix lints

* Add no_std check

* Rename account type

---------

Signed-off-by: vetclippy <vetclippy@icloud.com>
Co-authored-by: Jean Marchand (Exotic Markets) <jeanno11@orange.fr>
Co-authored-by: Leonardo Donatacci <125566964+L0STE@users.noreply.github.com>
Co-authored-by: Dimitris Apostolou <dimitris.apostolou@icloud.com>
Co-authored-by: Jon C <me@jonc.dev>
Co-authored-by: Sammy Harris <41593264+stegaBOB@users.noreply.github.com>
Co-authored-by: vetclippy <vetclippy@icloud.com>
febo added a commit to febo/solana-sdk that referenced this pull request Oct 23, 2025
* Use macro rules

* Update directory structure
febo added a commit to febo/solana-sdk that referenced this pull request Nov 19, 2025
* Use macro rules

* Update directory structure
febo added a commit that referenced this pull request Nov 21, 2025
* Add derive address helpers

* Update lock file

* Fix doc links

* Add missing dependency

* Address review comments (#78)

* [wip]: Address review comments

* [wip]: Fix pointer reference

* [wip]: Add logger buffer size tests

* Remove unused

* More logger tests

* Rename program to cpi

* Remove dynamic allocation

* Fixed signed tests

* Fix review comments

* Fix unsigned test case

* Add is_owner_by helper

* Deprecate AccountInfo::realloc (#174)

* Add resize

* Deprecate realloc

* Ignore `zero_init` parameter (#203)

Ignore zero_init parameter

* Remove unused

* Refactor directory structure (#18)

* Use macro rules

* Update directory structure

* Add from_slice helper (#23)

* Fix signer from helpers

* Add signer macro

* Fix doctest

* Add `checked_create_program_address` helper (#30)

* Add unchecked helper

* Fix lint

* Add inline

* Rename to checked

* Cosmetics

* Fix sol log params

* sdk: Improve comments (#64)

* [wip]: Add new scripts

* [wip]: Use matric strategy

* [wip]: Fix members parsing

* [wip]: Add CI env variables

* [wip]: Remove nothrow

* [wip]: Filter changes

* [wip]: Add audit step

* [wip]: Add semver checks

* [wip]: Refactor publish workflow

* [wip]: Refactor

* [wip]: Fix commands

* Fix formatting

* Remove detect changes step

* Review comments

* Fix lint comments

* Expand crate comment

* Ignore crate comment tests

* Add missing docs

* More missing docs

* Add missing release component

* Pin cargo-release version

* Fix merge

* Review comments

* add `seeds` macro (#73)

* use `seeds` macro over `signer` macro

* fix doc to pass doc test

* deprecate  macro

* Address review comments (#78)

* [wip]: Address review comments

* [wip]: Fix pointer reference

* [wip]: Add logger buffer size tests

* Remove unused

* More logger tests

* Rename program to cpi

* Remove dynamic allocation

* Fixed signed tests

* Fix review comments

* Fix unsigned test case

* Add is_owner_by helper

* add memo program (#105)

* add memo program

* use MAX_CPI_ACCOUNTS over MAX_TX_ACCOUNTS

* nit

* add account info borrowing check

* update docstring and comments

* use &str over &[u8]

* check num_accounts

* avoid unnecessary codegen

* update doc to use &str over &[u8]

* fix doc

* seperate lifetime

* Account borrow state check (#147)

* Improve fallback and docs

* Add borrow state check

* Add inline

* Review comments

* Revert doc link merge change

* Add const qualifier (#159)

* Simplify invoke instruction (#154)

* Fix review comments

* Revert offset increment change

* Improve invoke performance

* Add invoke instruction helper

* Typos

* Remove new helpers

* Remove unused

* Address review comments

* Tweak iteration

* More tweaks

* Limit the length of the slice

* Uncomment code

* Validate account length

* Tweak inline attributes

* Use invoke signed unchecked

* Refactor inline

* Renamed to with_bounds

* Update docs

* Fix accounts length test

* Revert change

* Add constant length check

* Review comments

* Fix error variant

* ci: Add spellcheck step (#164)

* Add invoke instruction helper

* Typos

* Remove new helpers

* Remove unused

* Address review comments

* Tweak inline attributes

* Use invoke signed unchecked

* Refactor inline

* Renamed to with_bounds

* Update docs

* Revert change

* Add constant length check

* Add spellcheck step

* Tweak action

* Fix typos

* More fixes

* Yet more fixes

* Fixes

* Add j1 option

* More and more fixes

* Add missing acronym

* Fix merge

* Fix spelling

* Fix spelling

* Clarify the use of constant values (#200)

* Add comments on constants

* Improve offset comments

* Add bitmask to dictionary

* Renamed to field_at_offset

* Feat: Add debug/copy derives and enable missing debug/copy lint (#228)

* Add debug/copy derives and enable missing debug/copy lint

* Update sdk/pinocchio/src/sysvars/rent.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/entrypoint/mod.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/instruction.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/sysvars/clock.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/sysvars/fees.rs

* Update sdk/pinocchio/src/sysvars/fees.rs

* Update sdk/pinocchio/src/sysvars/instructions.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/sysvars/instructions.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/sysvars/instructions.rs

Co-authored-by: Fernando Otero <febo@anza.xyz>

* Update sdk/pinocchio/src/sysvars/clock.rs

* Fix syntax error in Instructions struct derive macro

---------

Co-authored-by: Fernando Otero <febo@anza.xyz>

* pinocchio: Add `pubkey_eq` helper (#248)

* Add pubkey_eq helper

* Fix typo

* Update pubkey comparison

* Add proptest

* Add unlikely

* Replace proptest

* Use solana-address

* Fix syscall parameter

* Fix docs

* Update references to pubkey

* Use solana-account-view

* Update dependencies

* Add instruction view

* Update lamports reference

* Tweks

* Add target_arch bpf

* Fix rebase

* Fix lint

* Simplify definition

* Fix doc feature

* Address review comments

* Refactored slice support

* Improve code reuse

* Update msrv check

* More review comments

* Use crate rust-version

* Double quotes

* Fix docs

---------

Co-authored-by: publicqi <56060664+publicqi@users.noreply.github.com>
Co-authored-by: Sammy Harris <41593264+stegaBOB@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants